Tales of Maj'Eyal - User contributions [en]

Debugging

2020-03-04T09:36:22Z

Wonderingmonster: Typo fix in pathname

== Debugging: Figuring out what went wrong ==

=== Updating your configuration ===
Enabling cheat/development mode will grant you access to the internal Lua console and some additional dialogs/options useful for debugging. It will stop you from uploading characters online, though, but you can always turn this mode off.

<ul>
<li>Navigate to the corresponding configuration directory (replace HOME with your home directory).

{| class="wikitable"
| Windows || HOME\T-Engine\4.0\settings || For example C:\Users\USERNAME\T-Engine\4.0\settings
|-
| Linux || HOME/.t-engine/4.0/settings ||
|-
| Mac OSX || HOME\Library\Application Support\T-Engine\4.0\settings ||
|}
</li>
<li>Create a file called ''cheat.cfg'' in that directory, and put the following text in that file.
<pre>
cheat = true
</pre>
<li>
To turn cheat/development mode off, just change ''true'' to ''false'' or delete the ''cheat.cfg'' file.
</li>
</ul>

=== Inside of ToME ===

Enabling cheat mode gives you the following functions:

{| class="wikitable"
! Key Shortcut !! Result
|-
| Ctrl+L || Lua console
|-
| (not assigned by default) || Debug menu
|-
| Ctrl+S || Save the game
|-
| Ctrl+Alt+Shift+R || Reload the last save
|-
| Ctrl+G || Hit yourself for ~100 damage
|-
! Mouse !! Result
|-
| Ctrl-Left click || Teleport to the targeted square
|-
| Right click || Right-clicking a monster offers several debug functions, such as the ability to inspect inventory.
|-
| Shift-Ctrl-Right click || Instantly kill the targeted creature. This does work on yourself.
|}

=== Debug menu ===

Debug menu (aka debug mode) offers a menu with various options like changing zones, creating items, altering quests, etc. All of this can also be done via the Lua console, but the debug menu is much easier to use.

The keybinding for debug mode may not be assigned by default. Press Esc and go under Key Bindings to assign it.

=== Lua console ===

Summary of features:
* Inspect values and execute code
* Cursor positioning
* Tab auto-completion
* Copy and paste with system clipboard

The Lua console drops you into the global namespace and gives you access to [[t4modules engine structure|the engine]]. If you want to inspect values, start the line with an equal sign. For example, say you want to inspect the player:

<code>
=game.player
</code>

The console has cursor positioning so you can use the Left and Right arrows, as well as Home and End to move to the beginning and end of the current line, respectively. You can paste the clipboard's contents to the cursor position with Ctrl+V (note, not Apple+V on Mac). The current line can be copied to the clipboard with Ctrl+C (again, not Apple+C).

Here are some useful commands to know.

;Level up to level 50
<code>
game.player:forceLevelup(50)
</code>

;Remove godmode invulnerability
<code>
game.player.invulnerable=0
</code>

;Change your damage bonus
<code>
game.player.inc_damage.all=
</code>

;Change your resistance
<code>
game.player.resists.all=
</code>

;Learn a new talent (1 level in Slash in the example)
<code>
game.player:learnTalent(game.player.T_SLASH, true, 1)
</code>
<br />

;Learn a new talent type (wild-gift/harmony in the example)
<code>
game.player:learnTalentType("wild-gift/harmony", true)
</code>

;Change category mastery
<code>
game.player:setTalentTypeMastery("cunning/survival", 1.5)
</code>

;Change base stat - up to 100 max (reduce strength by 20 in the example)
<code>
game.player:incStat("str", -20)
</code>

;Change stat bonus (set Cunning bonus to 50 in the example)
<code>
game.player.inc_stats[game.player.STAT_CUN] = 50
</code>

;Apply an effect on the player (frozen for 10 turns)
<code>
game.player:setEffect(game.player.EFF_FROZEN, 10, {})
</code>

;Change your max HP
<code>
game.player.max_life=1
game.player:resetToFull()
</code>

;Teleport (to the Assassin Lord)
<code>
game:changeLevel(2,"thieves-tunnels")
</code>

;Add 5000 gold
<code>
game.player:incMoney(5000)
</code>

;Give yourself 10 unassigned class skills
<code>
game.player.unused_talents=10
</code>

;Give yourself 10 unused stat points
<code>
game.player.unused_stats=10
</code>

;Give yourself an extra stat point each level (default=3)
<code>
game.player.stats_per_level=4
</code>

;Give yourself 10 unused generic points
<code>
game.player.unused_generics=10
</code>

;Give yourself 10 unused prodigies points
<code>
game.player.unused_prodigies=10
</code>

;Give yourself 10 unused category points
<code>
game.player.unused_talents_types=10
</code>

;Give yourself 10 lives:
<code>
game.player.easy_mode_lifes=10
</code>

=== Lua code ===

To output values into the log file you can use 2 different functions:

;Print any text
<code>
print("yourmessage")
</code>

;Display the content of an object. This lists all variables contained in the object foo.
<code>
table.print(foo)
</code>

== Output log text to file immediately (only needed on Windows) ==

Without this, you have to close the game for the log file to be updated!

Instructions:

<ol>
<li>Create a shortcut to t-engine.exe.</li>
<li>Right-click the shortcut and select Properties.</li>
<li>Add the command to the end of the "Target" line:
<code>
--flush-stdout
</code>
</li>
</ol>

The end of the Target line should look like this then: <pre>\t-engine.exe --flush-stdout</pre>

This can be used in combination with a [http://en.wikipedia.org/wiki/Tail_(Unix) tail] program that shows the content of the log file in realtime.

== Load module and create character on startup ==

You can create a character once then use the premade from the command line:

<pre>
t-engine -Mtome -n -E"auto_quickbirth='player'"
</pre>

if your premade was named "player." (Or create a shortcut in Windows, similarly to the instructions above for outputting log text to a file.)

How to compile

2020-03-03T19:00:09Z

Wonderingmonster: Updated premake link, the old one was out of date.

These are instructions for compiling ToME4 on Debian Linux. If you haven't done so already, see [[Source Setup]] for obtaining the source code.

Building ToME4 beta 43 or higher requires snapshots of the currently unreleased [http://www.libsdl.org/hg.php SDL 2.0] library (also referred to as '''SDL HG'''). Most operating systems only supply the latest stable release, SDL 1.2, which '''will not work''' for ToME4.

In addition, you will need SDL2-compatible versions of the SDL_image and SDL_ttf libraries. Again, these are typically not available from your operating system distributor, because they are in a prerelease state. The instructions on this page will guide you through the process of building these from source.

==Addons==
The ToME 1.0.0RC1 (and later) source code in Git/SVN is incomplete. You must install "addons" which are not part of the Git/SVN tree in order to get all the game features. The procedure recommended by DarkGod is to download one of the official releases, extract the addon files from it, and copy them into the tree.

If you prefer to avoid doing that, the addons are available from a third-party site:

{| class="wikitable"
|-
! Game Version !! Addons
|-
| rowspan="3"|1.1.3
| [http://wooledge.org/~greg/tome/1.1.3/tome-addon-dev.teaa tome-addon-dev.teaa]
|-
| [http://wooledge.org/~greg/tome/1.1.3/tome-items-vault.teaa tome-items-vault.teaa]
|-
| [http://wooledge.org/~greg/tome/1.1.3/tome-stone-wardens.teaa tome-stone-wardens.teaa]
|-
| rowspan="2"|1.0.1
| [http://wooledge.org/~greg/tome/1.0.1/tome-items-vault.teaa tome-items-vault.teaa]
|-
| [http://wooledge.org/~greg/tome/1.0.1/tome-stone-wardens.teaa tome-stone-wardens.teaa]
|-
| rowspan="2"|1.0.0
| [http://wooledge.org/~greg/tome/1.0/tome-items-vault.teaa tome-items-vault.teaa]
|-
| [http://wooledge.org/~greg/tome/1.0/tome-stone-wardens.teaa tome-stone-wardens.teaa]
|-
| rowspan="2"|RC4
| [http://wooledge.org/~greg/tome/RC4/tome-items-vault.teaa tome-items-vault.teaa]
|-
| [http://wooledge.org/~greg/tome/RC4/tome-stone-wardens.teaa tome-stone-wardens.teaa]
|-
| rowspan="2"|RC2
| [http://wooledge.org/~greg/tome/RC2/tome-items-vault.teaa tome-items-vault.teaa]
|-
| [http://wooledge.org/~greg/tome/RC2/tome-stone-wardens.teaa tome-stone-wardens.teaa]
|-
| rowspan="2"|RC1
| [http://wooledge.org/~greg/tome/RC1/tome-items-vault.teaa tome-items-vault.teaa]
|-
| [http://wooledge.org/~greg/tome/RC1/tome-stone-wardens.teaa tome-stone-wardens.teaa]
|}

Copy these into the '''game/addons/''' subdirectory once you've followed the rest of the instructions below.

Addons are version-locked to the specific ToME version for which they are bundled, ''except'' ToME versions above 1.0.1, which can use the 1.0.1 addons.

==SDL==
ToME beta 43 was built with the prerelease versions of SDL2, SDL2_image and SDL2_ttf available on November 25, 2012. Later versions may also work, depending on the stability of the library's interface. For reference, the following hg revision numbers are known to work:
*SDL revision 6687
*SDL_image revision 339
*SDL_ttf revision 222
(You should try the current SDL2 first, and only fall back to these older versions if necessary.)

Install prerequisite development packages for your operating system. You'll need mercurial (hg), C and C++ compilers, make, autoconf and friends, and the development packages for X, libopenal, libogg, libvorbis, libpng, libglu1-mesa, libfreetype, libasound, and libaudiofile.

For Debian, this might work:
sudo apt-get build-dep libsdl1.2debian
sudo apt-get install subversion mercurial autoconf automake libtool

If that doesn't work, then this may get you close:
sudo apt-get install build-essential subversion mercurial
sudo apt-get install autoconf automake libtool
sudo apt-get install libopenal-dev libogg-dev libpng12-dev libvorbis-dev
sudo apt-get install libglu1-mesa-dev libfreetype6-dev xorg-dev
sudo apt-get install libasound2-dev libaudiofile-dev

Install the prerelease version of SDL2:
cd /usr/local/src
hg clone http://hg.libsdl.org/SDL
cd SDL
# OPTIONAL: hg update 6687
./autogen.sh
cd ..
mkdir SDL-build
cd SDL-build
../SDL/configure && make && sudo make install
sudo ldconfig

Install the prerelease version of SDL_image:

cd /usr/local/src
hg clone http://hg.libsdl.org/SDL_image
cd SDL_image
# OPTIONAL: hg update 339
./autogen.sh
cd ..
mkdir SDL_image-build
cd SDL_image-build
../SDL_image/configure && make && sudo make install
sudo ldconfig

Install the prerelease version of SDL_ttf:

cd /usr/local/src
hg clone http://hg.libsdl.org/SDL_ttf
cd SDL_ttf
# OPTIONAL: hg update 222
./autogen.sh
cd ..
mkdir SDL_ttf-build
cd SDL_ttf-build
../SDL_ttf/configure && make && sudo make install
sudo ldconfig

At this point you should have headers in '''/usr/local/include/SDL2/''' and libraries in '''/usr/local/lib/'''. The libraries should be named libSDL2, libSDL2_image and libSDL2_ttf (with appropriate version numbers and extensions). If any of the SDL libraries fail to build, check the [http://www.libsdl.org SDL website] for assistance.

==Premake4==
Install premake4 from https://premake.github.io/ or your distro. Note: if your OS has a "premake" version 3 package, that ''will not'' work.

==ToME4==
Decide where you'll keep the ToME source code. You'll need about 1 gigabyte of space. Let's assume you're going to use /usr/local/src/t-engine4. Make this directory and make sure you have write permission.

Fetch the ToME sources:
cd /usr/local/src
git clone http://git.net-core.org/tome/t-engine4.git

Your local copy of the Git repository will contain ''every version'' of ToME source code up to the time you did the clone, and you will be "checked out" in the bleeding edge master branch by default. So, if you want to build a stable version of ToME, you need to specify which one:
cd t-engine4
git checkout tome-1.1.3 # or whichever remote tag you wish to "check out"

Check, and possibly edit, '''premake4.lua''' and '''build/te4core.lua''' to reflect the location of your SDL installation.
* In premake4.lua, make sure "/usr/local/include/SDL2" appears before any other SDL directory in the includedirs section.
* In build/te4core.lua, under the configuration "linux" section, make sure "/usr/local/lib/" appears on the libdirs line, and make sure "SDL2", "SDL2_ttf", "SDL2_image" appear on the links line.

Now to compile, you just do:
cd /usr/local/src/t-engine4
make clean; premake4 clean # Don't worry if these fail.
premake4 gmake
make

To upgrade to a new version:
cd /usr/local/src/t-engine4
make clean; premake4 clean # Don't worry if these fail.
git fetch origin
git merge origin
git checkout tome-x.y.z # Fill in the appropriate remote tag name

Then you need to check/edit '''premake4.lua''' and '''build/te4core.lua''' again (every time, ''sigh''), and then finally:
premake4 gmake
make

==Troubleshooting==
If you get an error like this:

Lua Error: /engine/utils.lua:666: could not load font: /data/font/Vera.ttf (12)

It means you've linked against the wrong versions of SDL_image and/or SDL_ttf. Make sure ToME is linked against the ''new'' versions, which have "SDL2" in their names.

If you get an error like this:

Error initializing SDL video: No available video device

It probably means you didn't have all the development packages installed when you built SDL.