Metadata

Every Semi mod must have a file that specifies details about it, including a unique ID, name, etc. This information resides in a YAML file called mod.yml in the root of the distributable mod directory.

Format

id: example_mod
# Unique alphanumeric mod ID, used as the namespace for content added by the mod.
name: Example Mod
# Full name of the mod. Can be any string.
version: 1.0
# Version of the mod, preferably in semantic versioning format.
author: Zatherz
# Name of the author of the mod. Can be any string.
description: An example mod
# A short description of the mod. Can be any string.
dll: "Example.dll"
# Relative path to the DLL file containing the mod's code.
api_version: 1
# Incremental version of the API that Semi provides.
# This is not directly linked to the version of Semi,
# but instead is incremented by 1 when a change is made
# that breaks previous workflows.