Some of libtcod's functions are depreciated #99
Replies: 105 comments 112 replies
-
|
Nothing dangerous will happen from ignoring them, but these functions will not be forward compatible with later versions of libtcod. You can use the porting guide to help with most of these. This guide shows a sample program without deprecated functions. Be sure to ask about anything not mentioned in the documentation, which is likely still full of gaps. |
Beta Was this translation helpful? Give feedback.
-
|
For the latest docs, I recommend adding snippets of code for every function, because as someone new to this lib, I'm having difficulties understanding it. |
Beta Was this translation helpful? Give feedback.
-
|
Code examples are something I'm trying to do more of, but it takes time to get around to it. Anything not mentioned in the porting guide should work without warnings for examples from the older documentation. |
Beta Was this translation helpful? Give feedback.
-
|
Just tried compiling it statically, can say it ended badly |
Beta Was this translation helpful? Give feedback.
-
|
Well, how would you recommend me to do if I were to write a game with this lib, package it into one folder? Like basically when you clone the repo you can start playing without having to install SDL or libtcod? |
Beta Was this translation helpful? Give feedback.
-
As you might be able to tell from the link errors. SDL2 and zlib are required to be available at link time. This might be an issue with libtcod's I don't know, but the error is that the SDL2/zlib libs were wanted but weren't provided.
I currently recommend Vcpkg and CMake for packaging an executable or building dependencies automatically. I base any new C/C++ projects off of this template. You can use Vcpkg/CMake without the template and that will get you an older stable version of libtcod instead of the development versions. |
Beta Was this translation helpful? Give feedback.
-
|
Also, I have another question, since the default font is a bit unclear and it hurts my eyes to look at it, I've decided to use my own .ttf file, but after some digging at your samples, seems like I have to convert it to a .png or something? |
Beta Was this translation helpful? Give feedback.
-
|
Libtcod has experimental functions of TTF loading but I was never sure if the quality was consistent. They're shown in this header file and are not in a stable part of the API. |
Beta Was this translation helpful? Give feedback.
-
|
Well then what's the stable way of loading it? |
Beta Was this translation helpful? Give feedback.
-
Converting the font into a tileset is technically the most stable way. Using the experimental functions should be good enough, since they won't be going away until after a real solution exists. |
Beta Was this translation helpful? Give feedback.
-
|
Is there any documentation about how to convert the font into a tileset? |
Beta Was this translation helpful? Give feedback.
-
You might use a tool like this. It's easier to find existing Code Page 437 tilesets than to make them from a TTF file. You're on your own if you plan on creating your own tilesets. |
Beta Was this translation helpful? Give feedback.
-
|
Alright then, I have another question, lets say I declared a new window What is the best way to pass it into a function? |
Beta Was this translation helpful? Give feedback.
-
Always by reference unless you are passing ownership. Pass by pointer if you have to use a C function for some reason. The type is a usual |
Beta Was this translation helpful? Give feedback.
-
|
I found this terminal-blues bitmap font Here is how I applied it, but somehow I don't see the font. Did I do anything wrong? |
Beta Was this translation helpful? Give feedback.
-
|
Alright, after a couple cups of coffee I managed to get from 1200 errors down to 500 errors. I don't understand the difference between manually doing something like this std::string get_string(tcod::ConsolePtr &main_win, tcod::ContextPtr &context, std::string original){
std::string input;
clear_and_draw_dialog(main_win, context, "([ESC] to cancel) Rename item to: ");
int ch;
while(true){
ch=SDL_getch(main_win, context);
if(ch==SDLK_RETURN&&input.length()>0){ // KEY_ENTER
return input;
}
if(ch==SDLK_BACKSPACE){ // KEY_BACKSPACE
if(input.length()>0){
input.pop_back();
}
}
if(ch==SDLK_ESCAPE){ // KEY_ESC
return original;
}
else if(input.length()<30&&(isdigit(ch)||isalpha(ch)||isblank(ch))){
input.push_back(ch);
}
std::stringstream ss;
ss<<"Rename item to: "<<input;
clear_and_draw_dialog(main_win, context, ss.str());
}
}and using this https://wiki.libsdl.org/Tutorials-TextInput |
Beta Was this translation helpful? Give feedback.
-
|
With TextInput it is less effort to get Unicode printable characters from the player. Your handling of |
Beta Was this translation helpful? Give feedback.
-
|
I don't even have much idea on how I'm supposed to store UTF-8 characters. Can I store UTF characters with int and std::string? |
Beta Was this translation helpful? Give feedback.
-
Or you can filter out any character outside of the ASCII range Wikipedia is be the best place to learn more: You might be used to |
Beta Was this translation helpful? Give feedback.
-
|
So to clear an area to the default colors, I should do something like this right? void SDL_wclear_dialog_bar(tcod::ConsolePtr &main_win, tcod::ContextPtr &context){
tcod::draw_rect(*main_win, {0, 0, 80, 1}, ' ', nullptr, nullptr);
context->present(*main_win);
} |
Beta Was this translation helpful? Give feedback.
-
|
So, what is the correct way it resetting it to default? Changing the nullptr to actual colors? |
Beta Was this translation helpful? Give feedback.
-
void SDL_wclear_main_win(tcod::ConsolePtr &main_win, tcod::ContextPtr &context){
tcod::draw_rect(*main_win, {0, 1, 80, 50}, ' ', &WHITE, &BLACK);
context->present(*main_win);
} |
Beta Was this translation helpful? Give feedback.
-
|
Wait, I thought nullptr meant it used the default colors. Oh no... I guess I gotta rewrite 300 lines of code. |
Beta Was this translation helpful? Give feedback.
-
Yes.
Default colors and other attributes are no longer a concept with the new API. This means you will know exactly what a draw/print call is doing from looking at it alone. This is really helpful when debugging and refactoring code. |
Beta Was this translation helpful? Give feedback.
-
|
Ohhh alright. |
Beta Was this translation helpful? Give feedback.
-
|
The source code to this project is in this branch -> https://github.com/epixinvites/wayventure/tree/develop-libtcod |
Beta Was this translation helpful? Give feedback.
-
|
The tcod::draw_rect functions are making everything jitter, after removing it the program worked fine. |
Beta Was this translation helpful? Give feedback.
-
|
Or maybe, printing too many characters? I removed it and replaced it with this but it still jitters slightly void SDL_wclear_dialog_bar(tcod::ConsolePtr &main_win, tcod::ContextPtr &context){
for(int i = 0; i<80; i++){
TCOD_console_put_char_ex(main_win.get(), i, 0, ' ', WHITE, BLACK);
}
}
void SDL_wclear_stats_bar(tcod::ConsolePtr &main_win, tcod::ContextPtr &context){
for(int i = 51; i<56; i++){
for(int j = 0; j<80; j++){
TCOD_console_put_char_ex(main_win.get(), j, i, ' ', WHITE, BLACK);
}
}
}
void SDL_wclear_main_win(tcod::ConsolePtr &main_win, tcod::ContextPtr &context){
for(int i = 1; i<51; i++){
for(int j = 0; j<80; j++){
TCOD_console_put_char_ex(main_win.get(), j, i, ' ', WHITE, BLACK);
}
}
} |
Beta Was this translation helpful? Give feedback.
-
|
Or maybe I'm calling context->present(main_win) too many times? |
Beta Was this translation helpful? Give feedback.
-
|
Yeah I think thats the problem. |
Beta Was this translation helpful? Give feedback.
-
|
Alright I solved it. |
Beta Was this translation helpful? Give feedback.
-
|
Which function in SDL2 should I use to check if the current window has keyboard focus? Debugging and testing around has made me realise that SDL2 is taking every single mouse and keyboard input, even when I'm not focused on the window. |
Beta Was this translation helpful? Give feedback.
-
I'd use the window flags to check for focus.
This sounds unusual, I'd only expect this to happen for game controllers. Are you sure your window manager isn't changing focus for you automatically? I don't think I'm on a platform that can reproduce this issue. So you might need to debug this on your own. Be sure to search for anyone else having the same problems as you. |
Beta Was this translation helpful? Give feedback.
-
|
Yeah apparently its the problem with my IDE rather than the window, but I still want to add an if() the window is focused accept input. |
Beta Was this translation helpful? Give feedback.
-
|
How do I do an if() on the flags? I'm not familiar with bits. |
Beta Was this translation helpful? Give feedback.
-
|
Use 'bitwise and' to single out the flag you want to check. Like you've already done with the modifier key flags. |
Beta Was this translation helpful? Give feedback.
-
|
Alright, I'll do some testing. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for spending time to guide me :) I've added a special thanks to you in my project's README |
Beta Was this translation helpful? Give feedback.
-
|
Glad you got it working! It will be difficult if you haven't done it before, but consider using GitHub Actions to make automated builds of your game. |
Beta Was this translation helpful? Give feedback.
-
|
How tho, I've never used Github Actions. Can you give me some tutorials for me to start with? |
Beta Was this translation helpful? Give feedback.
-
|
You have to go trough a lot of documentation to learn it, and a lot of searching to troubleshoot specific problems. Start here: https://docs.github.com/en/actions I suggest starting with the You might start with something like this: https://github.com/actions/starter-workflows/blob/main/ci/c-cpp.yml |
Beta Was this translation helpful? Give feedback.
-
|
So, how am I supposed to compile this lib to Windows? |
Beta Was this translation helpful? Give feedback.
-
|
MinGW should work but I'm not experienced with it. A Github workflow should give you access to some MSYS2 tools like pacman and many of the MinGW/GCC tools you might expect. You might want to set I'm used to CMake where I can just tell it to use either a Windows or Linux compiler and it will automatically resolve the rest. |
Beta Was this translation helpful? Give feedback.
-
|
Is it possible to get keyboard input without depending on SDL2? |
Beta Was this translation helpful? Give feedback.
-
|
Like, cross-platform code, or just basically anything thats compatible with SSH. |
Beta Was this translation helpful? Give feedback.
-
|
SDL2 is already cross-platform, but it's cross-platform for OS events and rendering rather than terminal stuff. I've considered adding support for SSH terminals in #78 but it's been a low priority. See that issue for more info. |
Beta Was this translation helpful? Give feedback.
-
|
I've noticed if I call functions like |
Beta Was this translation helpful? Give feedback.
-
|
I meant the code for the Since it's a benchmark it might only be good for comparing the performance of different ways of doing things rather than analyzing the performance problems inside of a specific function call, which you'd use a profiler for instead of a benchmark tool. This only says how long the test takes, it doesn't say what part of the tested code is taking the most time. |
Beta Was this translation helpful? Give feedback.
-
|
Hm, I've never done profiling or benchmarking before sorry |
Beta Was this translation helpful? Give feedback.
-
|
It's something you'll get better at over time. For checking the general performance of a running program you should use a profiler. For comparing the performance of two or more different things you use benchmarking. Maybe look into using |
Beta Was this translation helpful? Give feedback.
-
|
Hm, afaik my colors are declared like After some reading, apparently there's two types of colors, TCOD_ColorRGB and TCOD_ColorRGBA, so how am I supposed to convert the ColorRGB to ColorRGBA? |
Beta Was this translation helpful? Give feedback.
-
The basic method is like this: auto rgb = TCOD_ColorRGB{1,2,3};
auto rgba = TCOD_ColorRGBA{rgb.r, rgb.g, rgb.b, 255};I've been trying to figure out a better way to handle conversions for a while now. Until then I've been stuck with this verbose method. The more obvious methods I've tried break C linkage, so I might need to make a special C++ class just so that conversions are handled better. Until I implement something just add 255 as the alpha whenever an RGBA value is required. Or make your own color class that implicitly converts to either TCOD_ColorRGB or TCOD_ColorRGBA which is what I might end up doing. |
Beta Was this translation helpful? Give feedback.
-
|
Can you create a definite guide to statically compiling libtcod along with SDL2? I've been stuck at the SegFault for weeks. |
Beta Was this translation helpful? Give feedback.
-
|
Beta Was this translation helpful? Give feedback.
-
|
You've shown me this traceback before: #99 (comment) This is the most discussion I can find on the topic. By this point I'm not sure that statically linking SDL will make a portable binary. To make a portable build you might need to use a docker or distro specifically designed to build portable apps. I can't really say anything with certainty, my own plans were always to dynamically link with the distributions SDL library rather than bundle SDL or statically link it. Is that something you've tried? |
Beta Was this translation helpful? Give feedback.
-
|
Well, my goal is simply to have an executable that allows people to run it on most of the mainstream distros, thats all. My current knowledge limits me to statically compiling it, as I don't know any other way. Basically its like an AppImage where people just download one file, run |
Beta Was this translation helpful? Give feedback.
-
|
Maybe use AppImage then? |
Beta Was this translation helpful? Give feedback.
-
|
Hm, I'll look into it |
Beta Was this translation helpful? Give feedback.
-
|
While I was building libtcod from the latest git commit, I ran |
Beta Was this translation helpful? Give feedback.
-
|
The workflow I linked to also uses Ubuntu 20.04. I'm not sure what to add. |
Beta Was this translation helpful? Give feedback.
-
|
I'll retest it |
Beta Was this translation helpful? Give feedback.
-
|
Hm, it miraculously worked, what's the difference between and this? |
Beta Was this translation helpful? Give feedback.
-
|
I think |
Beta Was this translation helpful? Give feedback.
-
|
That's rather odd, since when I ran the first chunk of command multiple times it returned the same error, but after trying the second chunk it works. |
Beta Was this translation helpful? Give feedback.
-
|
What's the best way you'd recommend for me to turn my game into a package? What I mean is basically like a .tar.gz and you can just do I've just realised that trying to statically compile it isn't always the best solution. |
Beta Was this translation helpful? Give feedback.
-
|
It seems the goal of turning your distributables into a single executable file is what's causing your headaches. It isn't too hard for others to unzip a package and run an executable inside of it. Especially Linux users. You should really get something simple working and then stop. Don't worry about how many files you have when your readme says which file loads the game. If your project was open source then you could upload your package to your distributions repository. That should be easy to do in Arch and should give you an idea of how to setup packages on other distributions. You could also use Emscripten to compile your program for a web target. It wouldn't even be a download if you did that, and it will work on any platform with a modern browser. You can also use a platform like Itch.io to distribute your game files and it will run cleanly from their launcher along with a direct download for those who'd rather run it manually. This is the only method I've actually used myself to distribute a game and that was with a Python-tcod project. |
Beta Was this translation helpful? Give feedback.
-
|
Well, I don't have the resources of the money to run a server, that's the first part, I wouldn't want to upload my game onto a platform either. I will go with the one where people just unzip and run the executable. |
Beta Was this translation helpful? Give feedback.
-
|
I don't think I suggested anything that'd require you to buy or host your own server. A web target could be hosted on itch.io or many other places for free.
I don't know any good resources for packaging a non-free binary for Linux other than what I've already talked about. I've mostly been learning about more ways to package Linux binaries from this conversation. |
Beta Was this translation helpful? Give feedback.
-
|
wayventure-client.tar.gz |
Beta Was this translation helpful? Give feedback.
-
|
It runs on the Ubuntu 21.04 VM I have. |
Beta Was this translation helpful? Give feedback.
-
|
Wow, really? I'm so glad it works! |
Beta Was this translation helpful? Give feedback.
-
|
Thank you for your patience in guiding me, I truly appreciate it. |
Beta Was this translation helpful? Give feedback.
-
|
Well I just downloaded the new 1.19.0 release and tried compiling with it |
Beta Was this translation helpful? Give feedback.
-
|
Aight, noted. |
Beta Was this translation helpful? Give feedback.
-
|
Apparently your functions aren't marked const |
Beta Was this translation helpful? Give feedback.
-
|
The |
Beta Was this translation helpful? Give feedback.
-
|
Looks like I missed adding
You should generally follow the porting to 1.19 guide where it's relevant. |
Beta Was this translation helpful? Give feedback.
-
|
Alright, thanks, will fix 'em one by one later |
Beta Was this translation helpful? Give feedback.
-
So apparently these functions are depreciated, what are the replacements for these functions? |
Beta Was this translation helpful? Give feedback.
-
|
But if I remove the TCOD_console_set_default_foreground function, when I run |
Beta Was this translation helpful? Give feedback.
-
|
If |
Beta Was this translation helpful? Give feedback.
-
|
My main_win is declared like that |
Beta Was this translation helpful? Give feedback.
-
|
Then you clear with |
Beta Was this translation helpful? Give feedback.
-
|
yeap, it worked |
Beta Was this translation helpful? Give feedback.
-
|
Is TTF fonts loading supported yet? I would love to substitute my current tileset for some monospaced font. And by the way, if it's possible to load TTF fonts now, how am I supposed to set the font size? |
Beta Was this translation helpful? Give feedback.
-
|
TTF is supported but not officially. Something I'm considering is adding an inline header that links to FreeType2 so that library can be used without having to require it as a dependency for all projects. For monospaced fonts you could consider looking at some BDF fonts, which tend to work very well in monospace if you don't mind the raster look. Whatever you choose you should read the readme at https://github.com/libtcod/libtcod/tree/develop/data/fonts which explains how to load these fonts. |
Beta Was this translation helpful? Give feedback.
-
|
BDF fonts would be actually nice not gonna lie. It gives out this old school vibe |
Beta Was this translation helpful? Give feedback.
-
|
Just tested the BDF fonts linked in the link above, it seems like all of them are either too small, or are sizes like 10x20. Do you have any like square-sized fonts to recommend? |
Beta Was this translation helpful? Give feedback.
-
|
I can't think of good square fonts outside of the Dwarf Fortress CP437 tilesets. In theory you could force BDF fonts to be square in the same way you can force all fonts to be. Small fonts can be scaled up by using a larger window for a smaller console since libtcod will automatically scale the console to fit. This can also be used to make half-width fonts square. |
Beta Was this translation helpful? Give feedback.
-
I'm using
g++ (GCC) 11.1.0andsdl2 2.0.16-2.My host system is Arch Linux.
This is the code,
This is the compile command,
These are the warnings:
Can I safely ignore these warnings? Or are they even supposed to happen?
Beta Was this translation helpful? Give feedback.
All reactions