T4 Modules Howto Guide/Directory Structure

2018-07-29T23:55:41Z

MercuryJack: /* Player Profiles */

=An Overview=
==Player Profiles==

When you run T-Engine or a module for the first time a player profile will be created. This contains your settings and keybindings, as well as module specific settings and achievements.

On linux this profile can be found in your home directory.

For Windows the profile folder will be called T-Engine. It will be located in the following locations.

Windows 7 - C:\Users\<username>\T-Engine
Windows XP - C:\Documents and Settings\<username>\T-Engine

Profiles are now kept online, allowing the community to easily show off and compare character sheets, statistics, wins, and losses.

==T-Engine Root Directory==

In your T-Engine directory, the one where your executable is located, you will find a game directory. This directory contains all the Lua scripts used by the game and all its modules. The script is interpreted at runtime, so no recompilation is needed after modifying a file.

If you are writing a custom module you should avoid editing any file outside your module directory, since you will not be able to distribute those changes along with your module if you do.

This directory is located in your game folder and contains every module currently available to T-Engine. Every module has its own folder and copying a module directory here is sufficient for it to be detected and appear on the list of available modules when starting a new game.

For all of these guides, the convention to refer to a filepath will use the game's module directory as its root. This is the folder that contains your init.lua file.

Note that the structure described here is only a convention used by ToME, but it is advised that third party module writers follow it for consistency. Few of these paths are hardcoded.

Directories and files not in the example module are underlined. Directories are boldface.

ToME uses many more than listed here, this is only intended to be a rough guide for structuring your own modules.

<table>
<tr>
<th>Directory or file</th>
<th>Purpose</th>
</tr>
<tr>
<td>/</td>
<td>Root Module directory</td>
</tr>
<tr>
<td>/init.lua</td>
<td>Description and basic information about the module.</td>
</tr>
<tr>
<td>/load.lua</td>
<td>This file loads all the basic code and definitions needed to run the module.</td>
</tr>
<tr>
<td>/resolvers.lua</td>
<td>Contains additional custom resolvers.</td>
</tr>
<tr>
<td>/ai/</td>
<td>Directory for custom AI definitions.</td>
</tr>
<tr>
<td>/class/</td>
<td>Directory for module custom class files. These usually extend the generic T-Engine classes of the same name and are used instead of them if they exist.</td>
</tr>
<tr>
<td>/class/Actor.lua</td>
<td>Both the player and all NPCs use this class.</td>
</tr>
<tr>
<td>/class/Game.lua</td>
<td>Handles game initialization, lower level code like keybindings and changing levels and displaying to screen.</td>
</tr>
<tr>
<td>/class/Grid.lua</td>
<td>Defines tooltips for grids and methods that handle what terrain blocks movement.</td>
</tr>
<tr>
<td>/class/NPC.lua</td>
<td>Handles non-player actors.</td>
</tr>
<tr>
<td>/class/Object.lua</td>
<td>Handles all objects in the game.</td>
</tr>
<tr>
<td>/class/Player.lua</td>
<td>Handles all player specific code that isn't generic to all Actors.</td>
</tr>
<tr>
<td>/class/PlayerDisplay.lua</td>
<td>Handles displaying the player's stats.</td>
</tr>
<tr>
<td>/class/Store.lua</td>
<td>Handles stores.</td>
</tr>
<tr>
<td>/class/Trap.lua</td>
<td>Handles traps.</td>
</tr>
<tr>
<td>/class/World.lua</td>
<td>Handles saving and Achievements.</td>
</tr>
<tr>
<td>/class/generator/</td>
<td>Directory for custom generators in zones.</td>
</tr>
<tr>
<td>/class/interface/</td>
<td>Directory for custom interfaces. These are inherited by other classes to help segment and seperate code and improve readability for complex classes.</td>
</tr>
<tr>
<td>/class/interface/Combat.lua</td>
<td>Module custom combat code is defined here.</td>
</tr>
<tr>
<td>/data/</td>
<td>Most of T-Engine is data-driven, not code-driven. This directory contains all the module custom definitions loaded to make your game unique.</td>
</tr>
<tr>
<td>/data/damage_types.lua</td>
<td>Defines the default damage projector and all the different damage types used in the module. (fire, water, acid, etc)</td>
</tr>
<tr>
<td>/data/talents.lua</td>
<td>Default talents file loaded by /init.lua. This file often Load()'s other talent files to improve readability.</td>
</tr>
<tr>
<td>/data/timed_effects.lua</td>
<td>Defines various timed effects available to the module.</td>
</tr>
<tr>
<td>/data/achievements/</td>
<td>Stores module achievements.</td>
</tr>
<tr>
<td>/data/birth/</td>
<td>Birth descriptors folder.</td>
</tr>
<tr>
<td>/data/birth/descriptors.lua</td>
<td>Default birth descriptors file. Often Load()'s other descriptor files to improve readability..</td>
</tr>
<tr>
<td>/data/chats/</td>
<td>Stores NPC chats for mobs that can speak.</td>
</tr>
<tr>
<td>/data/general/</td>
<td>Defines entities available to your module. Note that zones may define their own entities, such as bosses or special items, in the zone directories.</td>
</tr>
<tr>
<td>/data/general/grids/</td>
<td>Defines general grids (terrain).</td>
</tr>
<tr>
<td>/data/general/npcs/</td>
<td>Defines general NPCs.</td>
</tr>
<tr>
<td>/data/general/objects/</td>
<td>Defines general objects.</td>
</tr>
<tr>
<td>/data/general/stores/</td>
<td>Defines general stores.</td>
</tr>
<tr>
<td>/data/general/traps/</td>
<td>Defines general traps.</td>
</tr>
<tr>
<td>/data/gfx/</td>
<td>Special module image or particle assets.</td>
</tr>
<tr>
<td>/data/gfx/particles/</td>
<td>Particle script files.</td>
</tr>
<tr>
<td>/data/maps/</td>
<td>Static map definitions.</td>
</tr>
<tr>
<td>/data/music/</td>
<td>Module music.</td>
</tr>
<tr>
<td>/data/quest/</td>
<td>Module quests.</td>
</tr>
<tr>
<td>/data/rooms/</td>
<td>Special generators for rooms.</td>
</tr>
<tr>
<td>/data/sound/</td>
<td>Sound effects directory.</td>
</tr>
<tr>
<td>/data/talents/</td>
<td>Stores talent description files. These are Load()'ed by the /data/talents.lua file.</td>
</tr>
<tr>
<td>/data/texts/</td>
<td>Special non-quest or monster related texts. Used in ToME for introduction messages and new class unlock texts.</td>
</tr>
<tr>
<td>/data/tilesets/</td>
<td>Data folder for the map generator.</td>
</tr>
<tr>
<td>/data/zones/</td>
<td>Zones folder. Each zone has its own directory.</td>
</tr>
<tr>
<td>/data/ZONE/grids.lua</td>
<td>Zone load file for grids.</td>
</tr>
<tr>
<td>/data/ZONE/npcs.lua</td>
<td>Zone load file for npcs.</td>
</tr>
<tr>
<td>/data/ZONE/objects.lua</td>
<td>Zone load file for objects.</td>
</tr>
<tr>
<td>/data/ZONE/traps.lua</td>
<td>Zone load file for traps.</td>
</tr>
<tr>
<td>/data/ZONE/zone.lua</td>
<td>Zone description file.</td>
</tr>
<tr>
<td>/dialogs/</td>
<td>Contains module specific dialogs.</td>
</tr>
<tr>
<td>/dialogs/DeathDialog.lua</td>
<td>Dialog displayed on death.</td>
</tr>
<tr>
<td>/dialogs/Quit.lua</td>
<td>Dialog displayed when a quit is requested.</td>
</tr>
</table>

==Module team files==
The team files are renamed zip files. However, they have a different directory structure. The data folder remains the same and everything else is put in a mod folder.

Go back to [[T4 Modules Howto Guide]]

{{Module Guides}}

Tales of Maj'Eyal - User contributions [en]

T4 Modules Howto Guide/Directory Structure