This repo demonstrates various kinds of mods, and makes a good starting point for new mods:
To start a mod, pick the closest matching example, and clone the appropriate branch
Eg. git clone -b ExampleGameMod https://github.com/drok/CSL-ExampleMods MyGameMod
This will clone the ExampleGameMod branch into a new directory named MyGameMod. All you need to do is start adding your logic.
Note all the examples in this repo are public domain, which allows you to add any COPYING licence you wish, and you need not give any credit to the author, nor reproduce any copyright notices. Do with it as you please.
- ExampleGameMod - this is a typical gameplay changing mod. It changes the last names of 25% of cims to "Modmaker"
- ExampleModInstaller - this is an installer which can be used to deploy mods published on github, or sets of mods via a dependency list.
Mods that are started by cloning one of the templates here are automatically found by the Harmony Mod Manager, and listed under the content manager as "mods available from GitHub". The user can simply enable them in the Mod Manager to install them from your latest binary release.
The Harmony Mod Manager uses the fork list of this repo as a kind of "Workshop"
This method allows users who do not have access to the Steam Workshop to publish mods available to other players.
You may still wish to publish your mod on the Steam Workshop to make it accessible to players who do not have the Harmony Mod Manager installed
Note Your fork needs to have "Issues" enabled to be considered an actual mod. This allows the Mod Manager to filter out plain forks (ie, identical copies of the example), and mods which are "Work In Progress", ie, have been forked but are not ready for consumption.