Skip to content

Create ModSync File "Github"

Jump to bottom
Kiame Vivacity edited this page Jun 21, 2018 · 9 revisions

Github means the mod's files are stored in a Github repo. It is a requirement that there is a directory called About which contains About.xml and ModSync.xml.

Creating a ModSync.xml file

  1. Make sure Developer Mode is enabled in the Options
  2. Navigate to Mods
  3. Select the mod to add ModSync to
  4. On the right side there will be a new button Create ModSync File

Note: Once the ModSync file is create the button will say Update ModSync File which can be used to update the ModSync version number.

ModSync Required Fields

Example Github repo

https://github.com/KiameV/rimworld-modsync-rw/

Owner

The Owner is KiameV

Project

The Project is rimworld-modsync-rw

About Dir

The default is About which specified the About directory is at the root of the repo: https://github.com/KiameV/rimworld-modsync-rw/About

If the About directory is elsewhere, say https://github.com/KiameV/rimworld-modsync-rw/Mods/About The About Dir value will be Mods/About

Note: The About directory is where About.xml and ModSync.xml are located.

Download Page

  • Main Page - Use this if you want your users to download your repo from the main page
  • Releases - Use this if you want your users to download the mod from the Releases page

Branch

Defaulted to master. This is an advanced option and should be left as is unless you know what this means for git and branch management.

Clone this wiki locally