README.md

NSModTemplate

A template repository for Northstar mods with a mostly pre-configured github action for publishing to Thunderstore

Usage

1. Click the Use this template button on the top right of the repo's landing page (here)
2. Give the new repo a name and make sure it's set to public
3. In the settings tab, under actions -> general, set Actions permissions to Allow all actions and reusable workflows

   
4. Also in settings, under secrets -> actions, add your Thunderstore token as a secret named TS_KEY (Steps for getting a token can be found here)

   
5. Edit .github/workflows/publish.yml ~line 43 to add a description for your mod

   
6. Update this README and icon.png as they will be used by Thunderstore as well
7. Write your mod! (HINT: Find the docs here)
8. Publish your mod!

   Once you've pushed all your chages to your repo, you'll need to create a tag to trigger the action that will publish your mod to Thunderstore. Find the `Releases` pane in the sidebar to the right ---->
   
   Create a new release, filling in the details however you want. The most important part is that the tag matches the version number of your mod. In this example, the Version field in your mod.json should be 1.0.0:
   
   Once you've added a title and optional description, go ahead and publish that release.
   
   If all goes well, you should see a new publish job running in the Actions tab :D