Skip to content

A GitHub Action to initialize a Beat Saber modding environment with stripped references for compiling mods in CI/CD.

License

Notifications You must be signed in to change notification settings

beat-forge/init-beatsaber

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

@beat-forge/init-beatsaber

A GitHub Action to initialize a Beat Saber modding environment with stripped references for compiling mods in CI/CD.

Quickstart 🚀

To quickly set up the modding environment, add the following step to your GitHub Actions workflow:

- name: Initialize modding environment
  uses: beat-forge/init-beatsaber@v1

This will clone the stripped Beat Saber references to the default path ./Refs and infer the Beat Saber version from your manifest.json file.

Inputs ⚙️

Name Description Required Default
token GitHub token for cloning the Beat Saber repository. No ${{ github.token }}
version Version of Beat Saber for the modding environment. If not specified, the action will try to infer it from a manifest.json. No None
manifest Path to a specific manifest.json file for version inference. If not provided, the action will search recursively. No None
path Path to clone the stripped Beat Saber references to. No ./Refs
host Host to clone the stripped Beat Saber references from. No github.com
repo Repository to clone the stripped Beat Saber references from. No beat-forge/beatsaber-stripped

Contributing 🤝

Contributions, issues, and feature requests are welcome! Feel free to check out the issues page.

Stargazers over time 📈

Star History Chart