https://www.polymorph.games/foundation/modding/ 2026-04-21T12:59:39+00:00 https://www.polymorph.games/foundation/modding/ https://www.polymorph.games/foundation/modding/_media/wiki/dokuwiki.svg text/html 2026-04-15T14:41:35+00:00 mathieu (mathieu@undisclosed.example.com) https://www.polymorph.games/foundation/modding/changelog?rev=1776264095&do=diff Changelog Foundation Full Release (1.11) * Full Changelog * 1.11.0.17 Changelog * 1.11.0.14 Changelog * 1.11.0.12 Changelog * 1.11.0.8 Changelog Foundation 1.10 * Full Changelog * 1.10.3.12 Changelog * 1.10.3.11 Changelog * 1.10.3.10 Changelog * 1.10.3.8 Changelog * 1.10.3.6 Changelog * 1.10.3.4 Changelog * 1.10.3.3 Changelog * 1.10.3.1 Changelog * 1.10.2.15 modding 4 Changelog * 1.10.2.15 modding 3 Changelog * 1.10.2.15 modding 2 Changelog Foundation 1.9 … text/html 2026-02-23T22:59:32+00:00 polymorphgames (polymorphgames@undisclosed.example.com) https://www.polymorph.games/foundation/modding/class-info?rev=1771887572&do=diff Class Info This is a table defining a custom class to be registered with the mod:registerClass() function. { TypeName = "MY_TYPE_NAME", ParentType = "ASSET", Properties = { { Name = "Property1", Type = "string", Default = "SomeString" }, { Name = "Property2", Type = "list<RESOURCE_QUANTITY_PAIR>" }, { Name = "Property3", Type = "integer", Default = 1, Flags = { "SAVE_GAME" } } } } text/html 2026-02-23T22:49:27+00:00 polymorphgames (polymorphgames@undisclosed.example.com) https://www.polymorph.games/foundation/modding/custom-data?rev=1771886967&do=diff DATA classes are the most basic type in Foundation that all other types are based on. For reference all available pure DATA classes can be found in this section of the API. Creating & Using a Custom DATA Object Step 1: Defining a DATA Object using a Lua Table text/html 2026-02-23T22:20:08+00:00 polymorphgames (polymorphgames@undisclosed.example.com) https://www.polymorph.games/foundation/modding/custom-building-function?rev=1771885208&do=diff BUILDING_FUNCTION classes are registerable types in Foundation that define what purpose a certain BUILDING_PART will serve in the game. For reference all available BUILDING_FUNCTION classes can be found in this section of the API. Creating & Using a Custom BUILDING_FUNCTION Step 1: Defining a BUILDING_FUNCTION Class using a Lua Table text/html 2026-02-23T22:19:18+00:00 polymorphgames (polymorphgames@undisclosed.example.com) https://www.polymorph.games/foundation/modding/custom-asset?rev=1771885158&do=diff ASSET classes are the basic registerable types in Foundation. For reference all available ASSET classes can be found in this section of the API. Creating & Using a Custom ASSET Object Step 1: Defining an ASSET Object using a Lua Table To create a custom ASSET object we will need to make use of the text/html 2026-02-23T22:02:38+00:00 polymorphgames (polymorphgames@undisclosed.example.com) https://www.polymorph.games/foundation/modding/mod-management-functions?rev=1771884158&do=diff Mod Management Functions All these functions are available on your mod object dofile Loads and runs a Lua script Returns the file's return values [...] myMod:dofile(scriptPath [, args...]) Name Type Description scriptPath string the relative path to the file, inside the mod directory text/html 2026-02-23T21:54:01+00:00 polymorphgames (polymorphgames@undisclosed.example.com) https://www.polymorph.games/foundation/modding/mod-io-functions?rev=1771883641&do=diff Mod IO Functions All these functions are available on your mod object fileExists Checks if a file exists in the mod directory. Returns true if the file is inside the mod directory and exists, false otherwise boolean myMod:fileExists(filePath) Name text/html 2026-02-23T21:53:34+00:00 polymorphgames (polymorphgames@undisclosed.example.com) https://www.polymorph.games/foundation/modding/version-library?rev=1771883614&do=diff Version Library cmp Compare two version numbers Returns: * 0 if version1 == version2 * -1 if version1 < version2 * 1 if version1 > version2 integer version.cmp(version1, version2) Name Type Description version1 string version2 string text/html 2026-02-23T21:53:10+00:00 polymorphgames (polymorphgames@undisclosed.example.com) https://www.polymorph.games/foundation/modding/foundation-library-functions?rev=1771883590&do=diff Foundation Library Functions createMod Creates and returns a new mod void foundation.createMod() ---------- isModEnabled Checks if a mod is enabled Returns true if the mod is found and it is enabled, false otherwise boolean foundation.isModEnabled text/html 2026-02-23T21:52:50+00:00 polymorphgames (polymorphgames@undisclosed.example.com) https://www.polymorph.games/foundation/modding/debugging-mods?rev=1771883570&do=diff Debugging Mods Lua development environments can be configured to debug Foudation mods. Debuggee script The first step in debugging a mod is to setup the chosen debugger in the VM. This cannot be done by the mod scripts themselves as it requires escaping the sandbox they operate in; the required setup must be placed in a special text/html 2026-02-23T21:52:39+00:00 polymorphgames (polymorphgames@undisclosed.example.com) https://www.polymorph.games/foundation/modding/texture-usage-policy?rev=1771883559&do=diff Game Texture Usage Policy Game textures may be called into a mod, this has the advantage of easily adopting the Foundation art style whilst also preventing copyright infringement. This method also has the added benefit of optimizing texture usage in the game engine by not duplicating textures. text/html 2026-02-23T21:52:25+00:00 polymorphgames (polymorphgames@undisclosed.example.com) https://www.polymorph.games/foundation/modding/example-mods?rev=1771883545&do=diff Example Mods You can find the example mods in your Foundation installation directory, under the mods folder. Example - Simple This example mod shows the basic structure of a Foundation mod and can be used as boilerplate code for getting started Example - Mithril Factory