Debugging - Revision history

ScienceBall: /* Debug menu */ Table of the options. TODO: Check things in-game. What order are the addon/DLC options in-game?

2022-05-10T17:22:05Z

‎Debug menu: Table of the options. TODO: Check things in-game. What order are the addon/DLC options in-game?

ScienceBall: /* Game commands */ Typo

2022-05-08T16:24:32Z

‎Game commands: Typo

ScienceBall: /* Game options */ The other reboot command. Rebinding these commands. "Options" sounds wrong. More commands and info. TODO: Many cheat commands/behavior that don't fit in this section. Ctrl+S to save isn't dev only.

2022-05-08T15:45:39Z

‎Game options: The other reboot command. Rebinding these commands. "Options" sounds wrong. More commands and info. TODO: Many cheat commands/behavior that don't fit in this section. Ctrl+S to save isn't dev only.

ScienceBall: /* Game options */ Debug menu is now Ctrl+A by default.

2022-04-25T13:12:31Z

‎Game options: Debug menu is now Ctrl+A by default.

QuixoticScamp: Formatting. Ctrl+P Shortcut

2021-01-16T18:24:10Z

Formatting. Ctrl+P Shortcut

QuixoticScamp: Formatting. Minor updates

2021-01-16T03:41:35Z

Formatting. Minor updates

Potkeny: Added Example of changing actor's phys resistance

2020-08-07T13:09:09Z

Added Example of changing actor's phys resistance

Wonderingmonster: Typo fix in pathname

2020-03-04T09:36:22Z

Typo fix in pathname

HenryEx at 19:26, 30 November 2019

2019-11-30T19:26:50Z

Djinnjaha: Added code to give yourself 10 unused prodigies points

2018-02-28T07:05:57Z

Added code to give yourself 10 unused prodigies points

@@ Line 83: / Line 83: @@
 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.
+The keybinding for debug mode is assigned to <kbd><kbd>Ctrl</kbd>+<kbd>A</kbd></kbd> by default. You can press Esc and go under Key Bindings if you want to reassign it.
 =Lua console =

@@ Line 77: / Line 77: @@
 Of these commands, only the "Show Lua console" and "Debug Mode" (debug menu) key bindings can be rebound, and they can only be rebound while Developer Mode is enabled.
-You can also, when using at item in the inventory, open the Lua console to inspect it.
+You can also, when using an item in the inventory, open the Lua console to inspect it.
 =Debug menu=

@@ Line 27: / Line 27: @@
 |}
-=Game options=
+=Game commands=
-Enabling cheat mode gives you the following options:
+Enabling cheat mode gives you the following commands:
 {| class="wikitable"
@@ Line 38: / Line 38: @@
 | <kbd><kbd>Ctrl</kbd>+<kbd>A</kbd></kbd> || Debug menu
 |-
-| <kbd><kbd>Ctrl</kbd>+<kbd>S</kbd></kbd> || Save the game
+| <kbd><kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>R</kbd></kbd> || Reboot the game and reload the last save
 |-
-| <kbd><kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>R</kbd></kbd> || Reload the last save
+| <kbd><kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>N</kbd></kbd> || Reboot the game, delete the previous character, and start a new character with the same name{{verify}}
 |-
-| <kbd><kbd>Ctrl</kbd>+<kbd>G</kbd></kbd> || Hit yourself for ~100 damage
+| <kbd><kbd>Ctrl</kbd>+<kbd>P</kbd></kbd> || Display talent scaling chart, if pressed when mouse hovered over talent.
 |-
-| <kbd><kbd>Ctrl</kbd>+<kbd>P</kbd></kbd> || Display talent scaling chart when mouse hovered over talent.
+| <kbd><kbd>Ctrl</kbd>+<kbd>D</kbd></kbd> || Prints information about the tile the player is standing on to the log?{{Verify}}
 |-
 ! Mouse !! Result
@@ Line 50: / Line 58: @@
 | <kbd><kbd>Ctrl</kbd>+Left click</kbd> || Teleport to the targeted square
 |-
-| <kbd>Right click</kbd> || Right-clicking a monster offers several debug functions, such as the ability to inspect inventory.
+| <kbd>Right click</kbd> || Right-clicking a tile offers several debug functions: if there's an actor on that tile, you can make it target the player, or you can look at its inventory. You can also open the Lua console to inspect the actor, terrain, trap, or projectile layers at that tile.
 |-
-| <kbd><kbd>Shift</kbd>+<kbd>Ctrl</kbd>+Right click</kbd> || Instantly kill the targeted creature.  This does work on yourself.
+| <kbd><kbd>Shift</kbd>+Left click</kbd> || Click on any effect icon to increase the effect's duration by 1 turn. (Minimalist UI only.)
 |-
 !Menu!! Result
 |-
-|Reboot||Reloads the game.
+| Reboot || Reboots the game, starting at the main menu.{{Verify}}
 |}
 =Debug menu=

@@ Line 36: / Line 36: @@
 | <kbd><kbd>Ctrl</kbd>+<kbd>L</kbd></kbd> || Lua console. Click on the console title bar or outside the window to exit.
 |-
-| (not assigned by default) || Debug menu
+| <kbd><kbd>Ctrl</kbd>+<kbd>A</kbd></kbd> || Debug menu
 |-
 | <kbd><kbd>Ctrl</kbd>+<kbd>S</kbd></kbd> || Save the game

@@ Line 34: / Line 34: @@
 ! Key Shortcut !! Result
 |-
-| Ctrl+L || Lua console. Click on the console title bar or outside the window to exit.
+| <kbd><kbd>Ctrl</kbd>+<kbd>L</kbd></kbd> || Lua console. Click on the console title bar or outside the window to exit.
 |-
 | (not assigned by default) || Debug menu
 |-
-| Ctrl+S || Save the game
+| <kbd><kbd>Ctrl</kbd>+<kbd>S</kbd></kbd> || Save the game
 |-
-| Ctrl+Alt+Shift+R || Reload the last save
+| <kbd><kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>R</kbd></kbd> || Reload the last save
 |-
-| Ctrl+G || Hit yourself for ~100 damage
+| <kbd><kbd>Ctrl</kbd>+<kbd>G</kbd></kbd> || Hit yourself for ~100 damage
 |-
 ! Mouse !! Result
 |-
-| Ctrl-Left click || Teleport to the targeted square
+| <kbd><kbd>Ctrl</kbd>+Left click</kbd> || Teleport to the targeted square
 |-
-| Right click || Right-clicking a monster offers several debug functions, such as the ability to inspect inventory.
+!Menu!! Result
 |-
-| Shift-Ctrl-Right click || Instantly kill the targeted creature.  This does work on yourself.
+|Reboot||Reloads the game.
 |}

@@ Line 1: / Line 1: @@
-== Debugging: Figuring out what went wrong ==
+Developer Mode (also known as "cheat") is a special game mode geared towards development of modules and addons for the game.
-=== Updating your configuration ===
+The easiest way to enable this mode is to select ''Developer Mode'' from the Options menu.
-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>
+=Overview=
-<li>Navigate to the corresponding configuration directory (replace HOME with your home directory).
+Developer mode grants the user several privileges and disables others to prevent abuse.
 {| class="wikitable"
@@ Line 14: / Line 26: @@
 | Mac OSX || HOME\Library\Application Support\T-Engine\4.0\settings ||
 |}
-=== Inside of ToME ===
+=Game options=
-Enabling cheat mode gives you the following functions:
+Enabling cheat mode gives you the following options:
 {| class="wikitable"
 ! Key Shortcut !! Result
 |-
-| Ctrl+L || Lua console
+| Ctrl+L || Lua console. Click on the console title bar or outside the window to exit.
 |-
 | (not assigned by default) || Debug menu
@@ Line 50: / Line 53: @@
 |}
-=== Debug menu ===
+=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.
@@ Line 56: / Line 59: @@
 The keybinding for debug mode may not be assigned by default.  Press Esc and go under Key Bindings to assign it.
-=== Lua console ===
+=Lua console =
 Summary of features:
@@ Line 64: / Line 67: @@
 * 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:
+The Lua console drops you into the global namespace and gives you access to [[T4_Modules_Howto_Guide/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>
+<code>=game.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).
+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 <kbd>Ctrl</kbd>+<kbd>V</kbd> (note, not <kbd>CMD</kbd>+<kbd>V</kbd> on Mac).  The current line can be copied to the clipboard with <kbd>Ctrl</kbd>+<kbd>C</kbd> (again, not <kbd>CMD</kbd>+<kbd>C</kbd> on Mac).
 Here are some useful commands to know.
@@ Line 206: / Line 207: @@
-=== Lua code ===
+=Lua code=
 To output values into the log file you can use 2 different functions:
 ;Print any text
-<code>
+<code>print("your message")</code>
-print("yourmessage")
 </code>
 ;Display the content of an object. This lists all variables contained in the object foo.
-<code>
+<code>table.print(foo)</code>
 table.print(foo)
 </code>
-== Output log text to file immediately (only needed on Windows) ==
+=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>
+The end of the Target line should look like this then: <code>\t-engine.exe --flush-stdout</code>
-<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 ==
+=Load module and create character on startup=
 You can create a character once then use the premade from the command line:
-<pre>
+<code>t-engine -Mtome -n -E"auto_quickbirth='player'"</code>
 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.)
+If your premade was named "player."  (Or create a shortcut in Windows, similarly to the instructions above for outputting log text to a file.)

← Older revision		Revision as of 13:09, 7 August 2020
Line 196:		Line 196:
	</code>		</code>

		+
		+	;Change another actor's physical resistance to 50
		+	<ol>
		+	<li>Right-click then Lua inspect [Actor] to get their actor ID</li>
		+	<li><code>
		+	__uids[ActorID here].resists.PHYSICAL=50
		+	</code></li>
		+	</ol>

@@ Line 10: / Line 10: @@
 | Windows || HOME\T-Engine\4.0\settings || For example C:\Users\USERNAME\T-Engine\4.0\settings
 |-
-| Linux || HOME/.t-egine/4.0/settings ||
+| Linux || HOME/.t-engine/4.0/settings ||
 |-
 | Mac OSX || HOME\Library\Application Support\T-Engine\4.0\settings ||

@@ Line 174: / Line 174: @@
 <code>
 game.player.unused_generics=10
 </code>