diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..7923233 --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,50 @@ +name: Publish package + +on: + push: + tags: + - "*" + +env: + name: ${{github.event.repository.name}} # Edit this if the package name differs from the repo name + +jobs: + verify: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Get clean version + run: | + echo cleanVersion=$(echo ${{github.ref_name}} | sed s/v//g) >> $GITHUB_ENV + - name: Check that version matches + run: | + if [[ "$(grep -Po "\d+\.\d+\.\d+" $(find ./ -name mod.json))" != "${{ env.cleanVersion }}" ]]; then + echo "::debug::${{env.cleanVersion}}" + echo "::debug::$(cat $(find ./ -name mod.json ))" + echo "::error::Version in mod.json does not match tag version" + exit 1 + fi + publish: + runs-on: ubuntu-latest + needs: verify + steps: + - uses: actions/checkout@v3 + - name: Upload Thunderstore Package + uses: GreenTF/upload-thunderstore-package@v3.1 + with: + community: northstar + # Name of the team to publish the mod under + # This should be modified if your github username is different than your team name on Thunderstore + namespace: ${{ github.repository_owner }} # <------ DOUBLE CHECK THIS + # Name of the package + name: ${{ env.name }} # This can be modified if the package name differs from the repo name + # Package version to publish + version: ${{ github.ref_name }} # This is the tag that was created in the release + # Description of the mod + description: Example mod description # <----------- UPDATE THIS + # Thunderstore API token + token: ${{ secrets.TS_KEY }} + # Directory to wrap the contents of the repo in + wrap: mods/${{ github.repository_owner }}.${{ env.name }} # This will wrap your Author.ModName folder in a mods/ folder before publishing + #deps: "northstar-Northstar@1.9.3" # <------------- Uncomment this line to add dependencies to your mod, each sparated by a space + categories: "mods" # <----------------------------- Add more categories as needed, separated by spaces diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..903a4c9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Emerald + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..a825f09 --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +# 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. +
  2. Give the new repo a name and make sure it's set to public
    3. +
  3. In the settings tab, under actions -> general, set Actions permissions to Allow all actions and reusable workflows + +
    4. +
  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. +
  5. Edit .github/workflows/publish.yml ~line 43 to add a description for your mod + +
    +
    6. + +
  6. Update this README and icon.png as they will be used by Thunderstore as well
    7. +
  7. Write your mod! (HINT: Find the docs here)
    8. +
  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 +
    +
    9. +
+ + diff --git a/icon.png b/icon.png new file mode 100644 index 0000000..fd87885 Binary files /dev/null and b/icon.png differ diff --git a/mod.json b/mod.json new file mode 100644 index 0000000..713638a --- /dev/null +++ b/mod.json @@ -0,0 +1,17 @@ +{ + "Name": "Example.Mod", + "Description": "A cool mod that does cool stuff", + "Version": "1.0.0", + "DownloadLink": "https://northstar.thunderstore.io/package/download/Example/Mod/", + + "LoadPriority": 0, + "ConVars": [], + "Scripts": [{ + "Path": "example.nut", + "RunOn": "(CLIENT || SERVER) && MP", + "ClientCallback": { + "Before":"example_callback" + } + }], + "Localisation": [] +} diff --git a/mod/scripts/vscripts/example.nut b/mod/scripts/vscripts/example.nut new file mode 100644 index 0000000..570a40a --- /dev/null +++ b/mod/scripts/vscripts/example.nut @@ -0,0 +1,3 @@ +void function example_callback() { + print( "HEY YOU SHOULD CHANGE THIS" ) +}