Author Topic: [Other] TM PC Modding API (Read 28591 times)

Craig · « **on:** November 08, 2015, 08:35:53 PM »

Modding API Overview:

You can browse all my test mod projects here: https://github.com/cmartin99/TotalMinerMods
See here for basic C# modding tutorial videos.

In the game save folder there is a subfolder named Mods. Each mod will have it's own subfolder in the Mods folder. All files associated with the mod will be in that folder. The folder name will be the name of the mod.

e.g.

C:\Games\TotalMiner\Mods\Garys Mod\ItemData.xml
C:\Games\TotalMiner\Mods\Garys Mod\SkillData.xml
C:\Games\TotalMiner\Mods\Garys Mod\BlockTextures16.xml
C:\Games\TotalMiner\Mods\Garys Mod\ItemTextures32.xml
C:\Games\TotalMiner\Mods\Garys Mod\tp_16.png
C:\Games\TotalMiner\Mods\Garys Mod\tpi_32.png

Adding New Items or Changing Existing Items:
Adding new items into the game requires the modder to supply certain XML files which define properties for the items, and PNG files to define their textures. Each mod can add multiple items. No programming is required. Changing existing items is the same as adding new items except you specify an existing ItemID rather than a new one.

Changing Existing Blocks:
Adding new blocks is not yet supported, but you can change existing blocks. Changing blocks requires the modder to supply certain XML files which redefine the blocks properties, and PNG files to redefine their textures. Each mod can change multiple blocks. No programming is required.

Adding New NPCs:
Adding new NPCs to the game works in a similar manner to adding new items, but the XML files that need to be supplied will pertain to NPC data instead. Modders will also need to create an avatar if they are adding a new NPC, by making a component in the game, then saving and copying the component to the folder the mod is in. Each mod can add multiple NPCs. Custom NPC behaviours and dialog can also be provided in a mod. No programming is required.

Adding Particle Emitter Templates:
Adding particle emitter templates only requires the modder to supply a ParticleEmitterData.xml file with the necessary fields filled in and the game will add it to the custom particle template list for use. Note that these will act in the same manner as system templates, meaning you will not be able to save these templates in game unless you save it as a copy with a different name. No programming is required.

Adding Texture Packs:
If all you want to do is add a new texture pack to the game then that is simply a matter of supplying the required PNG files. No programming is required.

We may also develop a tool to make custom object creation easier for those that are not comfortable working with XML files directly.

Feel free to ask any questions you may have regarding the API, but please keep all modding discussions within this topic instead of making separate ones.

Craig · « **Reply #1 on:** November 08, 2015, 08:36:52 PM »

Adding Items

The XML files that define an item are:

ItemData.xml
ItemTypeData.xml
ItemTypeClassData.xml
ItemCombatData.xml
ItemSwingTimeData.xml
ItemSwingData.xml
ItemModelData.xml
ItemSoundData.xml
SkillData.xml
BlueprintData.xml

Changing existing items is exactly the same as adding a new item, except that you specify the name of an existing item in the xml file(s), and any data that you omit will be taken from the items current data.
All files are optional. If a file is not supplied, or individual fields in a file are omitted, then default values are used.
If you want the item to be craftable, you must supply BlueprintData.xml.
If you want to define the skill level requirements for the item, you must supply SkillData.xml.

For the purposes of explaining the data files, we've taken the entries used by the Steel Sword. Over time we will provide a description of each field in each file and what values they can specify.

--------------------------------------------------------------------------------------------------------------------------------------------

ItemData.xml

Defines general properties for Blocks and Items.

Sample File: