/bsmg-wiki

The Beat Saber Modding Group wiki!

Primary LanguageTypeScriptMIT LicenseMIT

📖 BSMG Wiki  CI Status

✏️ Contributing

If you wish to contribute, submit a pull request with your changes. A wiki maintainer will review your contributions and merge them in if deemed appropriate.

Don't know where to start? Checkout this crash course on making contributions!

Alternatively, users who are unsure on how to work with Git can submit an issue that contains a link to a shared google document with the text you would like to contribute. Note this will take longer to process than submitting a pull request.

🌐 Localization  Crowdin

Translation efforts are managed using Crowdin. There you can see the status of each language available that needs translating.

Want to Help Translate?

Apply Here and make sure you are in the BSMG Discord. We will be in touch!

If you don't see your language available on Crowdin you can still apply and we will add it once you are accepted!

🧪 Development

To run a local copy of the wiki:

  1. Install Node.js (using Volta is recommended)
  2. Fork this repo, then clone it. Make sure to do all work on another branch.
  3. Open a command-line window in the directory you just cloned into, then run the command npm install to install required packages.
  4. After packages are installed, start the development server with the command npm run dev. You can kill the server by closing the terminal or by pressing CTRL+C
  5. Open the link to localhost that appears in the console once the development server is running.

When you make changes to your local wiki files, the local website will update those pages as soon as they are saved!

The Wiki has a built-in linter that runs automatically when you push commits to enforce formatting rules. You can run this on your local copy with the command npm run lint to flag issues. You can also run npm run fmt to have the linter try to resolve the issues automatically. If you need assistance with interpreting or fixing the errors, submit an issue with a screenshot of the errors attached.

Once you have finished making changes, you can either commit them directly using git tools, or copy them into the GitHub web interface if you don't know how to use git.

🖧 Deployment

To deploy your fork of the wiki to GitHub pages (for example to allow others to preview your changes):

  1. Enable GitHub pages from GitHub actions on your repository.
  2. Once the workflow is complete, any changes made to the master branch will be deployed to https://{username}.github.io/{repository_name}/, where {username} is your GitHub username and {repository_name} is the name of your forked repository.

🔐 Licensing