Skip to content

Latest commit

 

History

History
26 lines (22 loc) · 2.05 KB

README.md

File metadata and controls

26 lines (22 loc) · 2.05 KB
Raw

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. Before pushing large files (100mb or larger), run concat_assets.sh and commit the archives instead. Your archives will be automatically concatted and extracted when creating a github release so the mod is downloadable from thunderstore without any extra steps