Addons - Revision history

Recaiden at 20:32, 21 January 2026

2026-01-21T20:32:01Z

Ratbuddy: note on the addon dir structure

2026-01-19T21:11:57Z

note on the addon dir structure

Recaiden at 17:54, 14 October 2022

2022-10-14T17:54:30Z

Kfoelsche: Added addon list link

2022-08-24T11:49:42Z

Added addon list link

Zarremgregarrok: removed ugly empty code blocks

2018-09-15T11:11:43Z

removed ugly empty code blocks

Zarremgregarrok: stone wardens are not an addon anymore, possessors are

2018-09-14T22:18:57Z

stone wardens are not an addon anymore, possessors are

Ibanix: /* Modifying mod Stuff */

2016-03-29T01:30:37Z

‎Modifying mod Stuff

Ibanix: /* Uploading your Addon */

2016-03-15T23:47:47Z

‎Uploading your Addon

Effigy at 21:52, 7 November 2015

2015-11-07T21:52:24Z

Dekar at 06:59, 11 August 2015

2015-08-11T06:59:13Z

@@ Line 29: / Line 29: @@
   long_name = "My Awesome Addon"
-  short_name = "coolstuff" -- Determines the name of your addon's file.
+  short_name = "coolstuff" -- Needs to match the name of your addon's file.
   for_module = "tome"
   version = {1,3,1}
@@ Line 54: / Line 54: @@
 ===Directory Structure===
-* '''overload''': Files in this directory will automatically replace files in the base game. This is very powerful but also incredibly dangerous. (Of course, replacing things like icons is less dangerous than replacing code.)
+* '''overload''': Files in this directory will automatically replace files in the base game. This is very powerful but also incredibly dangerous. This is also used for adding new icons, sprites, sounds, etc.
 * '''superload''': Files in this directory will be read and executed after the base game's file of the same name. This is very powerful but much less dangerous. This is a great way to add content (like new Artifact items) or tweak content (modify a talent's cost or requirements) without accidentally stepping on other tweaks or future content updates.
-* '''data''': Files in this directory will just sit there and be ignored unless you explicitly tell the game to read them. Files in this area live in their own "namespace" and filenames here will never interfere with other addons or the base game. This is a great place to put new classes, talent trees, or races.
+* '''data''': Files in this directory will just sit there and be ignored unless you explicitly tell the game to read them. Files in this area live in their own "namespace" ("tome-coolstuff/data/talents" becomes "/data-coolstuff/talents") and filenames here will not interfere with other addons or the base game. This is the preferred place to put new classes, talent trees, races, zones.
 * '''hooks''': Only one file in this directory is automatically executed: <nowiki>load.lua</nowiki>. This file is a great way to get your "data" files executed at the proper time. It's also a way to augment some parts of the game which specifically support hooks: the Example module shows how the "Actor:takeHit" function is hooked to make the tourist take no damage.  You can also use hooks to load add-on data in to the module, eg. new talents. Find a list of available hooks [[hooks|here]].

@@ Line 4: / Line 4: @@
 ==Intro==
-You're making an addon. The addon is named "coolstuff". The first thing you do is make a directory "tome-coolstuff" inside your Steam install of ToME. On my mac, that path is:
+You're making an addon. The addon is named "coolstuff". The first thing you do is make a directory "tome-coolstuff" ('''the tome- prefix is mandatory or your addon will not load!''') inside your Steam install of ToME. On my mac, that path is:
   ~/Library/Application Support/Steam/SteamApps/common/TalesMajEyal/game/addons/

@@ Line 130: / Line 130: @@
   return _M
 ==Uploading your Addon==
 {{:Addon Uploading}}

@@ Line 1: / Line 1: @@
 [[Category:Development]][[Category:Addons]]
-Addons are way for third parties to modify existing modules inside t-engine. Since the game Tales of Maj'Eyal is a t-engine module, this is how you write addons for ToME, just like the ones in the Steam Workshop.
+Addons are way for third parties to modify existing modules inside t-engine, as well as publish them in the Steam Workshop. (Here's a non-comprensive [[Addon List]].)  This page covers how you write addons for ToME.
 ==Intro==

@@ Line 94: / Line 94: @@
 We're ready to add the boot ego!
-<code>
   local _M = loadPrevious(...)
   newEntity{
   	power_source = {arcane=true},
@@ Line 112: / Line 111: @@
   return _M
 ====Modifying mod Stuff====
 Hold on, that example still didn't use _M at all! So what is _M for? Since most things in the <nowiki>data</nowiki> directory are stored in easily accessible structures, you don't need _M to get them. _M is generally used for stuff in the <nowiki>mod</nowiki> directory: the most dangerous stuff to modify. Here's an example which modifies the "levelup" function in <nowiki>mod/Actor.lua</nowiki>. Your file for this code should be in <nowiki>/superload/mod/Actor.lua</nowiki>.
   local _M = loadPrevious(...)
   local base_levelup = _M.levelup
@@ Line 135: / Line 130: @@
   return _M
 ==Uploading your Addon==
 {{:Addon Uploading}}

@@ Line 16: / Line 16: @@
   tome-addon-dev.teaa
   tome-items-vault.teaa
-  tome-stone-wardens.teaa
+  tome-possessors.teaa
 If you can't find the directory, search for one of those file names.

@@ Line 139: / Line 139: @@
 ==Uploading your Addon==
-You've been playing around with your addon, making changes and copying stuff from other popular addons. You've tested your stuff, and you're pretty satisfied that it won't crash the game. Good job! Now you want to share your work.
+{{:Addon Uploading}}
-−
-* In days of yore, you needed to post in this thread to be granted addon upload powers by DarkGod: http://forums.te4.org/viewtopic.php?f=50&t=31374
-** If you have any trouble uploading, make a post in that thread.
-* Main Menu -> Options -> Developer Mode (bottom option)
-* Start a new game.
-** Note that being in Developer Mode puts an extra screen between "New Game" and building a character. Pick the top option ("ToME").
-* Hit ctrl+a and pick the bottom option (just hit the up arrow)
-* MD5s are now calculated automatically. You will probably never need to get an MD5. Ignore that unless you know why you need one.
-* You will only need to register your addon ONCE, so after you do that the first time, you can ignore that option too.
-* If you've already registered your addon, pick "Publish Addon to te4.org". This is the option you'll pick over and over as you create new versions.
-* If you're using Steam, then after you upload to te4.org, hit ctrl+d again and this time pick "Publish Addon to Steam Workshop"

@@ Line 31: / Line 31: @@
   short_name = "coolstuff" -- Determines the name of your addon's file.
   for_module = "tome"
-  version = { 1, 3, 1 }
+  version = {1,3,1}
-  addon_version = { 1, 0, 0 }
+  addon_version = {1,0,0}
   weight = 100 -- The lower this value, the sooner your addon will load compared to other addons.
-  author = { 'coolguy@invalid.com' }
+  author = {'coolguy@invalid.com'}
   homepage = 'iamsocool.geocities.com'
   description = [[Oh my god this stuff is so totally cool.
@@ Line 41: / Line 41: @@
   tags = {'cool', "stuff", 'cool stuff'} -- tags MUST immediately follow description
   overload = true
   superload = false
   data = true
-Those last four are super important, because they determine what directories in your addon ToME will look at.
+Properly setting ''overload'', ''superload'', ''hooks'', and ''data'' is super important, because they determine which directories in your addon will be loaded by the game.
 ===Directory Structure===