shellrhythm

Gameplay

shellrhythm plays with your entire keyboard. (more precisely just the letter keys and aditional punctuation keys, so call that a 30k rhythm game!)
Simply press the displayed key when the corresponding hit object finishes drawing!

TODO: Add a gif of the gameplay

How to install

Install from script (LINUX)

Ever since 1.0, there's an install script for Linux to install the game easily! Simply download and run the following script, this will install it as the shellrhythm command.

Install from source

If you're unable to use the Linux install script (because you're on Windows, for example), feel free to directly download manually with the following tutorial:

First, make sure you have Python 3 and git installed (If you're using Linux, you probably have these installed)
Then, git clone the project (after having cd'd into the folder you want).

git clone https://github.com/HastagGuigui/shellrhythm.git

After that, with pip installed, simply do the following command (as admin/sudo on Windows):

pip install -r requirements.txt

And then finally, launch the program using the run.bat file (or ./shellrhythm on Linux) or in a command prompt in the game's directory:

python ./index.py

(Side note: some files like ./src/calibration.py can be launched independently, but the working directory needs to be the directory of the index.py.)

Where are the charts?

By default, there's a tutorial chart built-in. You can try it out, if you want!

Are there any charts I can download?

You can check out the #charts channel on the shellrhythm Discord server.

Side note: You can also use `shellrhythm --import [url]` to download and import a chart! (Or python `./src/import.py [url]`. That works too.)

How do I make a chart?

Use the editor! It's the 2nd option on the titlescreen.

Can I use this project for something?

Sure! The entire codebase is under the ISC license, so honestly do whatever with it. (Just don't claim to be behind the original project, obviously.)
However, one of the libraries this project uses, pybass3, uses a library called BASS, which is a commercial product. While it is free for non-commercial use, please ensure to obtain a valid licence if you plan on distributing any application using it commercially.

Known issues

Mac is untested.
The accuracy is bound to the framerate. It's why there's an fps counter at the bottom left of the screen in gameplay.

Help! I'm having issues!

If it's a crash or an unexpected behaviour (or even just a suggestion!), open an issue. If it's just struggle on how to make a chart (like, undocumented stuff), hit me up on Twitter or on Discord (this is a link to the shellrhythm discord server).

Extra credits:

NachoBIT: Made the song for the Tutorial chart.

shellrhythm/shellrhythm-cli