Modding

Signs of Life now has basic support for modding, with further support planned.

Currently, you can create the following things with the Mod API:

• Some Inventory Items
  • Basic Items (Modding)
  • Consumables (Modding)
    • Food
    • Drinking Vessels (Anything that can hold a Fluid (Modding) such as a potion vessel)
  • Melee Weapons (Modding)
  • Containers (Modding)
• Structures (Modding)
• Recipes (Modding)
• Drinkable Fluid (Modding)

Mod Basics

ModInfo.JSON

Every mod must have a ModInfo.JSON file in the mod's root directory. You can look at the Example Mod for an example of a ModInfo.JSON file.

ModInfo.JSON must contain the following properties:

JSON Property	Description	Example
UniqueModName	A unique text string up to 32 characters that uniquely identifies the mod. This should be unique from any other mods.	ExampleMod
DisplayName	A user friendly display name.	Example Mod
Description	A description of the mod.	An official example mod for Signs of Life.

Mod Directory Structure

Most mod files can be located anywhere in the mod's directory aside from the following:

• ModInfo.JSON must be in the root directory of the mod
• recipes.xml must be in the root directory of the mod if you want to add new recipes with your mod

Using Mods

Mods will be loaded from "My Documents/My Games/Signs of Life/Mods". Mods can either be in the form of a zip file or an unzipped directory.

Example Mod

We've created an example mod that we hope will help you figure out how to get things working by looking at some examples. This example mod is very bare bones right now, but it will be expanded shortly to add comprehensive examples of all the kinds of things you can add into the game through modding.

You can find the Example Mod here: http://www.playsignsoflife.com/Files/ExampleMod.zip

Drop the example mod in your My Documents/My Games/Signs of Life/Mods directory, start up the game and the mod should be working. You'll know if it's working if you can spawn a Shotel by pressing T to open chat, and using the command "/item ExampleMod.shotel"

The example mod adds the following content so far:

Contents

• Melee Weapons
  • Shotel (ExampleMod.shotel) - A basic melee weapon with one bone that uses the default melee weapon behavior
  • Energysabre (ExampleMod.Energysabre) - A complex melee weapon with multiple bones and custom behavior scripted with LUA
• Ranged Weapons
  • Tahz (ExampleMod.tahz) - A shotgun with behavior scripted with LUA