User Tools

Site Tools


start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
start [2020/07/14 13:02]
maxime
start [2022/03/30 10:53] (current)
maxime
Line 14: Line 14:
   * [[data-types|Data types]]   * [[data-types|Data types]]
   * [[enumerations|Enumerations]]   * [[enumerations|Enumerations]]
 +  * [[annotations|Annotations]]
   * [[example-mods|Example Mods]]   * [[example-mods|Example Mods]]
   * [[texture-usage-policy|Game texture usage policy]]   * [[texture-usage-policy|Game texture usage policy]]
 +  * [[debugging-mods|Debugging mods]]
  
   * [[foundation-library-functions|Foundation library functions]]   * [[foundation-library-functions|Foundation library functions]]
Line 23: Line 25:
  
   * [[dependencies|Mod Dependencies]]   * [[dependencies|Mod Dependencies]]
 +  * [[custom-classes|Custom classes]]
   * [[components|Components]]   * [[components|Components]]
   * [[asset-override|Game asset override]]   * [[asset-override|Game asset override]]
   * [[behavior-trees|Behavior trees]]   * [[behavior-trees|Behavior trees]]
   * [[events|Events]]   * [[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 35: Line 37:
   * [[walls|Create walls]]   * [[walls|Create walls]]
   * [[particle-effects|Create particle effects]]   * [[particle-effects|Create particle effects]]
 +  * [[construction-steps|Construction steps]]
   * [[material-sets|Material sets]]   * [[material-sets|Material sets]]
- 
-==== Preview only ==== 
- 
  
 ===== Where do I start? ===== ===== Where do I start? =====
Line 45: Line 45:
  
 ===== 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
-<​file ​javascript ​mod.json>​+ 
 +In addition, this file contains the list of your mod's custom maps and their info, if any. 
 + 
 +<​file ​json mod.json>​
 { {
- "​Name":​ "​Simple Example Mod",​ +    ​"​Name":​ "​Simple Example Mod",​ 
- "​Author":​ "​Leo",​ +    "​Author":​ "​Leo",​ 
- "​Description":​ "A very simple mod example",​ +    "​Description":​ "A very simple mod example",​ 
- "​Version":​ "​2.0.0"​+    "​Version":​ "​2.0.0"​
 + 
 +    "​MapList":​ [ 
 +        { 
 +            "​Id":​ "​MY_MAP_ID_01",​ 
 +            "​Name":​ "My Custom Map",​ 
 +            "​Description":​ "This is a simple description of my map.",​ 
 +            "​PreviewImage":​ "​metadata/​my_map_preview.png"​ 
 +        } 
 +    ]
 } }
 </​file>​ </​file>​
 +
 +===== metadata folder =====
 +
 +For files that don't need to be loaded, you can add those files to a ''​metadata''​ folder at the root of your mod. This can be used for example to contain the map thumbnail images listed in the ''​mod.json''​ file.
  
 ===== The mod.lua script ===== ===== The mod.lua script =====
start.1594746121.txt.gz · Last modified: 2020/07/14 13:02 by maxime