Skip to content

bismuthsoft/super_rogue

Repository files navigation

Super Rogue

pre-commit

(Not that super rogue!)

Inspired by SUPERHOT.

Playing

Online

Each release is automatically published to bismuthsoft.github.io/super_rogue.

Pre-built for Linux, Windows

See our releases page for downloads targeting Windows, Linux, and more!

(Mac users, please consider downloading the .love file or playing the web version.)

Run natively from source

Install LÖVE (love2d). Then run:

# From the super-rogue/ directory...
love src

Or if you have nix (non-NixOS users need nixGL):

nix run .#super_rogue.desktop

Run in-browser from source

nix run .#super_rogue.web.serve

Visit http://localhost:8080/

Contributing

All commits must pass pre-commit checks. Install pre-commit from your OS package manager then run pre-commit install. The next time that git commit runs, the pre-commit hook will also run its checks.

We use a standard GitHub Pull Request workflow.

Running tests

nix run .#super_rogue.test

Restart game on code change

To run tests and run the desktop version of the game upon code change, try this commad.

find src | entr -r sh -c 'nix run .#super_rogue.test && nix run .#super_rogue.desktop'

Release checklist

  1. Run ./scripts/release. Fill out the blanks.
  2. Verify the Release GitHub Action completed.
  3. Update the newly crafted release entry with a description of changes.