start
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
start [2020/05/06 16:57] – [Including other LUA files] maxime | start [2021/08/31 11:01] – maxime | ||
---|---|---|---|
Line 9: | Line 9: | ||
* ** [[changelog|Changelog]] ** | * ** [[changelog|Changelog]] ** | ||
* ** [[migration|Migration Notes]] ** | * ** [[migration|Migration Notes]] ** | ||
- | * ** [[guides|Guides]] ** | + | * ** [[guides|Community |
===== More info on: ===== | ===== More info on: ===== | ||
Line 15: | Line 15: | ||
* [[enumerations|Enumerations]] | * [[enumerations|Enumerations]] | ||
* [[example-mods|Example Mods]] | * [[example-mods|Example Mods]] | ||
+ | * [[texture-usage-policy|Game texture usage policy]] | ||
+ | * [[foundation-library-functions|Foundation library functions]] | ||
* [[mod-management-functions|Mod management functions]] | * [[mod-management-functions|Mod management functions]] | ||
+ | * [[version-library|Version library]] | ||
* [[mod-io-functions|Mod IO functions]] | * [[mod-io-functions|Mod IO functions]] | ||
* [[dependencies|Mod Dependencies]] | * [[dependencies|Mod Dependencies]] | ||
- | * [[components|Components | + | * [[components|Components]] |
* [[asset-override|Game asset override]] | * [[asset-override|Game asset override]] | ||
+ | * [[behavior-trees|Behavior trees]] | ||
+ | * [[events|Events]] | ||
+ | * [[custom-classes|Custom classes]] | ||
* [[building-asset-processor|Building asset processor]] | * [[building-asset-processor|Building asset processor]] | ||
* [[level-of-detail|Level Of Detail (LOD)]] | * [[level-of-detail|Level Of Detail (LOD)]] | ||
Line 36: | Line 42: | ||
===== The mod.json file ===== | ===== The mod.json file ===== | ||
- | The json file is loaded early and give basic information on your mod, without having to load your LUA scripts: | + | The json file is loaded early and give basic information on your mod, without having to load your LUA scripts. |
- | < | + | |
+ | In addition, this file contains the list of your mod's custom maps and their info, if any. | ||
+ | |||
+ | < | ||
{ | { | ||
- | " | + | |
- | " | + | " |
- | " | + | " |
- | " | + | " |
+ | |||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
} | } | ||
</ | </ | ||
+ | |||
+ | ===== metadata folder ===== | ||
+ | |||
+ | For files that don't need to be loaded, you can add those files to a '' | ||
===== The mod.lua script ===== | ===== The mod.lua script ===== | ||
Line 110: | Line 132: | ||
For this function to work, the user must manually set the field '' | For this function to work, the user must manually set the field '' | ||
- | ===== What is this generated_ids.lua file? ===== | + | ===== What is this generated_ids.lua file? ===== |
Internally, Foundation uses random unique IDs (GUID) to identify most objects and resources. | Internally, Foundation uses random unique IDs (GUID) to identify most objects and resources. | ||
When a new asset is added to the mod, Foundation will create a new ID for it, and will store the association between the " | When a new asset is added to the mod, Foundation will create a new ID for it, and will store the association between the " | ||
Line 117: | Line 140: | ||
===== Sharing a mod ===== | ===== Sharing a mod ===== | ||
+ | |||
Modders are encouraged to use **mod.io** to share their mods. Mods shared this way can be found and downloaded from the in-game mod browser. | Modders are encouraged to use **mod.io** to share their mods. Mods shared this way can be found and downloaded from the in-game mod browser. | ||
Line 122: | Line 146: | ||
You'll have to upload a zip of your mod. Make sure the zip contains directly the mod files ('' | You'll have to upload a zip of your mod. Make sure the zip contains directly the mod files ('' | ||
+ | |||
+ | ===== Quickly reload mods ===== | ||
+ | |||
+ | When developing and testing a mod, you can quickly reload your game by pressing '' |
start.txt · Last modified: 2022/03/30 10:53 by maxime