Outer Wilds Mod Pack Template

Use this template to create Outer Wilds mod packs. Mod packs are mods with the pack tag that list other mods as dependencies.

Note

Looking to create mods? See the OWML Documentation

Setup

First, create a new repository from this template using the "Use This Template" button on the top right.

After creating the template repository, open manifest.json and click the pencil icon to edit it.

In this file you'll need to replace three strings with values specific to your mod.

• author: Your Name
• name: Human-readable name for the mod
• uniqueName: A unique name for the mod that can't be the same as any other mod. Convention is to format it Author.Name. For example a mod "Time Saver" by Bwc9876 would become Bwc9876.TimeSaver

After changing these value, commit your changes by clicking the green "Commit" button and confirming.

Tip

You should change the README file of the mod to describe your mod and also change the repo description. The first image in your README will be used as the thumbnail for the mod, this image should be a 3:1 aspect ratio.

Adding Mods

To add mods to your pack, first find the mod on the mods website.

On a given mod page, press the details link below the install button.

From the details modal, copy the name listed under "Unique Name" for the mod.

With this unique name copied, edit your manifest.json file to include the mod's unique name in the dependencies array.

{
  "dependencies": [
    "xen.NewHorizons",
    "JohnCorby.VanillaFix"
  ]
}

After adding all of your mods, commit the changes using the green button on the top right.

Publishing

When you want to get your mod in the DB, start by going to the "Actions" tab of your repository and running the "Create Release" Workflow.

After the workflow finishes, check the "Releases" page of the repository, there should be a draft release there.

Click on the release, fill it out with your release description and click publish it.

After the release is published, use the Add Mod Issue Template on the mod database to add the mod.

Important

Make sure to give your mod the pack tag when prompted for tags applying to the mod.

Create the issue and a database administrator will work to get the mod added.

Updating

After making changes to your pack, bump the version number in manifest.json and re-run the "Create Release" workflow. A new release will be created that you can publish. After publishing the database will pick up on the change automatically.

Warning

If you don't bump the version in the manifest.json file the action will not create a release.