mNo edit summary Tags: Visual edit apiedit |
No edit summary Tags: Visual edit apiedit |
||
| Line 1: | Line 1: | ||
| + | This article is updated for [[Alpha 10]]. |
||
| + | |||
This guide will teach you how to create mods for Judgment: Apocalypse Survival Simulation. |
This guide will teach you how to create mods for Judgment: Apocalypse Survival Simulation. |
||
| Line 4: | Line 6: | ||
The following can be modded in Alpha 9: |
The following can be modded in Alpha 9: |
||
* Items & Equipment |
* Items & Equipment |
||
| + | * Crafting |
||
| ⚫ | |||
* Research |
* Research |
||
| + | * Skills |
||
| + | * Professions |
||
| ⚫ | |||
| + | * World Map Generator |
||
* Texts & Localization |
* Texts & Localization |
||
| + | * Food Types |
||
| − | Currently creating and installing mods is only done manually. Steam Workshop integration is planned for future updates. |
||
| + | * Combat Abilities |
||
| + | * Enemies & loot drop |
||
| + | [[Modding: Steam Workshop|Steam Workshop]] integration is available in beta mode.. |
||
== Basic concept == |
== Basic concept == |
||
| − | Much of Judgment's game mechanics are controlled by external data files. Mods are created by creating additional copies of these data files, which add, remove or modify elements from the built-in |
+ | Much of Judgment's game mechanics are controlled by external data files. Mods are created by creating additional copies of these data files, which add, remove or modify elements from the built-in versions. These files are then placed inside a mod folder, together with any media files such as image files. |
Read more about the [[Modding: Mod File Structure|Mod File Structure]] |
Read more about the [[Modding: Mod File Structure|Mod File Structure]] |
||
| ⚫ | |||
| − | == Mod Files == |
||
| + | |||
| − | The following mod configuration files are available: |
||
| + | == Getting Started == |
||
| − | * [[Modding: ModConfig.txt|ModConfig.txt]] - defines which mods to load. |
||
| + | # Start by creating a new folder for your mod, within the "Mods" folder. The "Mods" folder is located in the game's install directory. |
||
| − | * [[Modding: Items.txt|Items.txt]] - defines items and equipment. |
||
| + | # Within your mod folder, create the configuration file ModConfig.json, and define your mod's characteristics. |
||
| − | * [[Modding: Abilities.txt|Abilities.txt]] - defines combat abilities of usable items like grenades. |
||
| + | # Check the data files in the "OriginalConfig" folder in the "Mods" directory, and determine which of the built-in files you wish to modify or add to. |
||
| − | * [[Modding: StatusEffects.txt|StatusEffects.txt]] - defines positive or negative status effects caused by combat abilities such as hexing. |
||
| + | # Create new data files with the new data or modify the built-in data. Place these data files in your mod's folder. (Be sure to read about the [[Modding: Mod File Structure|Mod File Structure]] on how to add or modify to the built-in data files) |
||
| − | * [[Modding: Objects.txt|Objects.txt]] - defines world scavenge locations and their loot. |
||
| + | # Run Judgment, click the "Mods" button in the main menu, and enable your mod. Test it thoroughly. |
||
| − | * [[Modding: Research.txt|Research.txt]] - defines the research tree. |
||
| + | # Upload your mod to [[Modding: Steam Workshop|Steam Workshop]] so other players can access it. |
||
| − | * [[Modding: Effects.txt|Effects.txt]] - defines passive effects granted by research. |
||
| − | * [[Modding: Texts.txt|Texts.txt]] - language file that defines all the texts displayed in the game. |
||
| ⚫ | |||
| + | == Guides == |
||
| − | There is also no need to copy them into your mod. Simply add your own mod files that alter/add/remove from the original configs, as explained in [[Modding: Mod File Structure|Mod File Structure]]. |
||
| + | These are the main guides that will help you modify different parts of the game. Additional guides are linked from within them, as necessary. |
||
| + | * [[Modding: Items]] |
||
| + | * [[Modding: Crafting Recipes]] |
||
| + | * [[Modding: Research]] |
||
| + | * [[Modding: Skills]] |
||
| + | * [[Modding: Professions]] |
||
| + | * [[Modding: Map Locations]] - Scavenge locations in the world map |
||
| + | * [[Modding: Food]] |
||
| + | * [[Modding: World Map Generation]] |
||
| + | * [[Modding: Combat Abilities]] |
||
| + | * [[Modding: Enemies]] |
||
| + | * [[Modding: Other Configurations]] |
||
| + | * [[Modding: Localization]] - All texts displayed in the game. Use for supporting new languages. |
||
== Debugging Mods == |
== Debugging Mods == |
||
Revision as of 19:19, 17 December 2016
This article is updated for Alpha 10.
This guide will teach you how to create mods for Judgment: Apocalypse Survival Simulation.
Current state of modding
The following can be modded in Alpha 9:
- Items & Equipment
- Crafting
- Research
- Skills
- Professions
- Scavenge locations & loot
- World Map Generator
- Texts & Localization
- Food Types
- Combat Abilities
- Enemies & loot drop
Steam Workshop integration is available in beta mode..
Basic concept
Much of Judgment's game mechanics are controlled by external data files. Mods are created by creating additional copies of these data files, which add, remove or modify elements from the built-in versions. These files are then placed inside a mod folder, together with any media files such as image files.
Read more about the Mod File Structure
For your convenience, a copy of the original configuration files is provided in the "OriginalConfigs" folder in the "Mods" directory. These files are for reference only, and modifying them will have no effect on the game.
Getting Started
- Start by creating a new folder for your mod, within the "Mods" folder. The "Mods" folder is located in the game's install directory.
- Within your mod folder, create the configuration file ModConfig.json, and define your mod's characteristics.
- Check the data files in the "OriginalConfig" folder in the "Mods" directory, and determine which of the built-in files you wish to modify or add to.
- Create new data files with the new data or modify the built-in data. Place these data files in your mod's folder. (Be sure to read about the Mod File Structure on how to add or modify to the built-in data files)
- Run Judgment, click the "Mods" button in the main menu, and enable your mod. Test it thoroughly.
- Upload your mod to Steam Workshop so other players can access it.
Guides
These are the main guides that will help you modify different parts of the game. Additional guides are linked from within them, as necessary.
- Modding: Items
- Modding: Crafting Recipes
- Modding: Research
- Modding: Skills
- Modding: Professions
- Modding: Map Locations - Scavenge locations in the world map
- Modding: Food
- Modding: World Map Generation
- Modding: Combat Abilities
- Modding: Enemies
- Modding: Other Configurations
- Modding: Localization - All texts displayed in the game. Use for supporting new languages.
Debugging Mods
Many invalid configurations will cause the game to end as soon as it starts. The best way to debug is look for errors in the game log, located in the judgment_Data folder in the install directory.
Additional validation tools may be added in future updates.
Example
Bundled in the game, inside the Mods folder, there is a small demo mod that adds Aliens to Judgment. This mod adds alien resource, grenades, an alien blaster, an alien research tree and a crashed alien ship scavenge location.