curioustorvald/Terrarum
1
0
Fork 0
mirror of https://github.com/curioustorvald/Terrarum.git synced 2026-03-07 20:31:51 +09:00
Code Issues Packages Projects Releases Wiki Activity

Updated Modules (mediawiki => markdown)

CuriousTorvald
2022-09-07 10:38:14 +09:00
parent 463168d5ac
commit d0b226d15d
2 changed files with 39 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
Modules.md Normal file

@@ -0,0 +1,39 @@
Assets for the game — images, sounds, even the game codes are packed into **Modules**.
Modules in Terrarum is divided into two categories: the Internal Module and the User Module.
## The Internal Modules
Internal Modules comprises the "base game" of your own game that are not expected to be modified by the end user. When your game is packaged (e.g. via AppImage), the Internal Modules become read-only.
Internal Modules are stored under `<game exec dir>/assets/mods/`.
## The User Modules
User Modules are "mods" for your game, and can be modified by the end user.
User Modules are stored under `<appdata>/Modules/`.
## Configurations Generated by Modules
Modules' default config must be found under `<module root>/default.json`. Any config changed by the user will be stored onto the `<appdata>/config.json`, along with the engine's base config.
The user config will have a key with `<module name>:` prepended: for example, if the module `basegame` contains config key `gameplay_max_crafting`, the user-modified config will be named as `basegame:gameplay_max_crafting` on the `<appdata>/config.json`.
## Loading Modules
* [[Module Organisation|Modules:Load Order]], aka Load Order
* [[The Entry Point|Modules:How to Get Started]]
## Making Modules
* [[Before We Begin...|Modules:Setup]]
* [[My Little Dagger|Modules:New Items]]
* [[My Precious Block|Modules:New Blocks]]
* [[Let It Snow|Modules:New Weather]]
* [[Art Forgery|Modules:New Tapestries]]
* [[Hottest Editor of '20: CRISPR|Modules:New Actors]]
* [[Texture Packs|Modules:Retextures]]
## Dirty Jobs
* [[Items in-depth|Development:Items]]
* [[Actors in-depth|Development:Actors|]]
## Other Documentations
* [[Creature RAW|Development:RAW]]
* [[Faction|Development:Faction]]

38
Modules.mediawiki

@@ -1,38 +0,0 @@
Assets for the game — images, sounds, even the game codes are packed into '''Modules'''.
Modules in Terrarum is divided into two categories: the Internal Module and the User Module.
== The Internal Modules ==
Internal Modules comprises the "base game" of your own game that are not expected to be modified by the end user. When your game is packaged (e.g. via AppImage), the Internal Modules become read-only.
Internal Modules are stored under <code><game exec dir>/assets/mods/</code>.
== The User Modules ==
User Modules are "mods" for your game, and can be modified by the end user.
User Modules are stored under <code><appdata>/Modules/</code>.
== Configurations Generated by Modules ==
Modules' default config must be found under <code><module root>/default.json</code>. Any config changed by the user will be stored onto the <code><appdata>/config.json</code>, along with the engine's base config.
The user config will have a key with <code><module name>:</code> prepended: for example, if the module <code>basegame</code> contains config key <code>gameplay_max_crafting</code>, the user-modified config will be named as <code>basegame:gameplay_max_crafting</code> on the <code><appdata>/config.json</code>.
== Loading Modules ==
* [[Modules:Load Order|Module Organisation]], aka Load Order
* [[Modules:How to Get Started|The Entry Point]]
== Making Modules ==
* [[Modules:Setup|Before We Begin...]]
* [[Modules:New Items|My Little Dagger]]
* [[Modules:New Blocks|My Precious Block]]
* [[Modules:New Weather|Let It Snow]]
* [[Modules:New Tapestries|Art Forgery]]
* [[Modules:New Actors|Hottest Editor of '20: CRISPR]]
== Dirty Jobs ==
* [[Developer:Items|Items in-depth]]
* [[Developer:Actors|Actors in-depth]]
== Other Documentations ==
* [[Developer:RAW|Creature RAW]]
* [[Developer:Faction|Faction]]