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/05/06 15:43]
maxime [More info on:]
start [2020/07/14 13:02] (current)
maxime
Line 9: Line 9:
   * ** [[changelog|Changelog]] **   * ** [[changelog|Changelog]] **
   * ** [[migration|Migration Notes]] **   * ** [[migration|Migration Notes]] **
-  * ** [[guides|Guides]] **+  * ** [[guides|Community ​Guides]] **
  
 ===== 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]]
 +  * [[version-library|Version library]]
 +  * [[mod-io-functions|Mod IO functions]]
  
   * [[dependencies|Mod Dependencies]]   * [[dependencies|Mod Dependencies]]
-  * [[components|Components ​and custom 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)]]
- 
-  * [[logs|Mod individual log file]] 
-  * [[mod-functions:​io|IO functions]] 
  
   * [[workplaces|Create workplaces]]   * [[workplaces|Create workplaces]]
Line 57: Line 63:
  
 In order to include another LUA file, you can call the ''​dofile''​ function on your mod: In order to include another LUA file, you can call the ''​dofile''​ function on your mod:
-<code lua>+<​code ​lua somescript.lua>
 myMod:​dofile("​anotherscript.lua"​) myMod:​dofile("​anotherscript.lua"​)
 </​code>​ </​code>​
  
 This will execute the script ''​anotherscript.lua''​ from your mod folder. This will also pass the mod variable ''​myMod''​ to the script. So you will be able to access ''​myMod''​ from ''​anotherscript.lua''​ this way: This will execute the script ''​anotherscript.lua''​ from your mod folder. This will also pass the mod variable ''​myMod''​ to the script. So you will be able to access ''​myMod''​ from ''​anotherscript.lua''​ this way:
-<file lua anotherscript.lua>​+<code lua anotherscript.lua>​
 local myMod = ... -- retrieve arguments passed to the script local myMod = ... -- retrieve arguments passed to the script
  
 -- do stuff with myMod -- do stuff with myMod
 -- ... -- ...
-</file>+</code>
  
 In addition, you can pass any number of variable to the called script: In addition, you can pass any number of variable to the called script:
-<code lua>+<​code ​lua somescript.lua>
 myMod:​dofile("​anotherscript.lua",​ 42, "A Super String",​ { 1, 4, 12 }) myMod:​dofile("​anotherscript.lua",​ 42, "A Super String",​ { 1, 4, 12 })
 </​code>​ </​code>​
  
-<file lua anotherscript.lua>​+<code lua anotherscript.lua>​
 local myMod, anInteger, aString, anArray = ... -- retrieve arguments passed to the script local myMod, anInteger, aString, anArray = ... -- retrieve arguments passed to the script
-</file>+</code>
  
 ===== Enabling / Disabling a mod ===== ===== Enabling / Disabling a mod =====
Line 85: Line 91:
 If you want to fully ignore a mod, you can either remove it from your mods folder, or rename the ''​mod.lua''​ file into something else (''​mod_.lua''​ for instance). If you want to fully ignore a mod, you can either remove it from your mods folder, or rename the ''​mod.lua''​ file into something else (''​mod_.lua''​ for instance).
 ===== Logging / Debugging ===== ===== Logging / Debugging =====
 +
 +==== Log ====
  
 You can log your own logs into foundation log file: You can log your own logs into foundation log file:
 +
 <code lua> <code lua>
-myMod:​log("​Hello World!"​) +myMod:​log("​Hello World!"​) ​-- creates an INFO log entry 
-myMod:​logWarning("​This is a warning!"​) +myMod:​logWarning("​This is a warning!"​) ​-- creates a WARNING log entry 
-myMod:​logError("​This is an error!"​)+myMod:​logError("​This is an error!"​) ​-- creates an ERROR log entry
 </​code>​ </​code>​
  
-You can also open a blocking message box for debugging purpose:+In order to isolate mods related logs, Foundation will log most of mod related information in a specific log file located in ''​Documents/​Polymorph Games/​Foundation/​mod-%NAME%.log''​ 
 + 
 +However, keep in mind that a mod can interact with the game in various indirect way, and some valuable information could still  be hidden in the global game log in ''​Documents/​Polymorph Games/​Foundation/​foundation.log''​. 
 + 
 +==== Message box ==== 
 + 
 +You can also open a blocking message box for debugging purpose. This function is recommended for mod development only. 
 <code lua> <code lua>
 myMod:​msgBox("​Hello there!"​) myMod:​msgBox("​Hello there!"​)
 </​code>​ </​code>​
  
-===== What is this generated_ids.lua file? ===== +For this function to work, the user must manually set the field ''​ModMsgBoxEnabled''​ to ''​true''​ in the user settings file (''​usersetting.config''​). Otherwise, it will only create a new log entry, like the ''​log''​ function. 
 + 
 +===== 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 "​modding name" and the ID of the asset. When a new asset is added to the mod, Foundation will create a new ID for it, and will store the association between the "​modding name" and the ID of the asset.
Line 105: Line 124:
  
 ===== 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 110: Line 130:
  
 You'll have to upload a zip of your mod. Make sure the zip contains directly the mod files (''​mod.lua''​ needs to be at the root of the zip). You'll have to upload a zip of your mod. Make sure the zip contains directly the mod files (''​mod.lua''​ needs to be at the root of the zip).
 +
 +===== Quickly reload mods =====
 +
 +When developing and testing a mod, you can quickly reload your game by pressing ''​Ctrl + Shift + R''​.
start.1588794214.txt.gz · Last modified: 2020/05/06 15:43 by maxime