Check the docs in the /doc/ide subfolder.
GDB can be used to debug C++ code in a terminal.
To being able to debug with GDB use ./configure script such as:
./configure --mode=debug --compiler=gcc
build the game
make
Then
gdb -ex 'set breakpoint pending on' -ex 'b openage::run_game' -ex run --args run game
The game will be paused at the start of the function run_game() located in libopenage/main.cpp
Note: The run executable is a compiled version of run.py that also embeds the interpreter.
The game is intended to be run by run.py but it is much easier to debug the ./run file
Enabling pretty printing will make GDB's output much more readable, so we always recommend
to configure it in your setup. Your favourite IDE probably an option to enable pretty printers
for the standard library types. If not, you can get them from the gcc repository and register them in your local .gdbinit file.
Additionally, we have created several custom GDB pretty printers for types used in libopenage,
the C++ library that contains the openage engine core. To enable them, you have to load the project's
own init file openage.gdbinit when running GDB:
(gdb) source <path-of-openage-dir>/etc/openage.gdbinitYour IDE may be able to do this automatically for a debug run. Alternatively, you can configure an auto-loader that loads the scripts for you.
gdbgui is a browser-based frontend for GDB.
To install gdbgui in Ubuntu:
sudo pip3 install gdbgui --upgrade
Then
gdbgui ./run
The gdbgui web page will be at http://127.0.0.1:5000
Use the command run in the GDB prompt to start debugging