Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/remarkablegames/rhythmism

🎶 Rhythmism is a web rhythm game
https://github.com/remarkablegames/rhythmism

game javascript kaboom music rhythm rhythm-game typescript web

Last synced: 3 months ago
JSON representation

🎶 Rhythmism is a web rhythm game

Awesome Lists containing this project

README

        


Rhythmism

# Rhythmism

![release](https://img.shields.io/github/v/release/remarkablegames/rhythmism)
[![build](https://github.com/remarkablegames/rhythmism/actions/workflows/build.yml/badge.svg)](https://github.com/remarkablegames/rhythmism/actions/workflows/build.yml)

🎶 Rhythmism is a web rhythm game. Read the [blog post](https://remarkablegames.org/posts/rhythmism/).

The game was made for [Rhythm Jam 2024](https://itch.io/jam/rhythm-jam-2024), which the theme was `Divergence`:

> a difference between two or more things, attitudes, or opinions.

Play the game on:

- [remarkablegames](https://remarkablegames.org/rhythmism/)
- [Itch.io](https://remarkablegames.itch.io/rhythmism)
- [Newgrounds](https://www.newgrounds.com/portal/view/918614)

## Credits

- [remarkablemark](https://github.com/remarkablemark) - Programmer, UI
- [Rob Cohen](https://github.com/rmacohen) - Programmer, UI, Art
- [SG-SWE073](https://github.com/SG-SWE073) - Programmer, UI, Art
- [Gina Castromonte](https://github.com/GinaCastromonte) - Programmer
- [emex](https://soundcloud.com/emex-music) - Music

## Inspiration

- [Friday Night Funkin'](https://friday-nightfunkin.io/)
- [Guitar Hero](https://wikipedia.org/wiki/Guitar_Hero)

## Ideation

- [Excalidraw](https://excalidraw.com/#json=4xsd2WQeFiejrdBQkalCR,GLv9eoVsLsWhkXYKI1gCLA)
- [Proof of Concept](https://replit.com/@remarkablemark/Rhythm-Game)
- [MVP](https://replit.com/@remarkablemark/Rhythm-Jam-2024)

## Stack

- [Kaboom](https://kaboomjs.com/)
- [Vite](https://vitejs.dev/)

## Prerequisites

- [nvm](https://github.com/nvm-sh/nvm#readme)

## Install

Clone the repository:

```sh
git clone https://github.com/remarkablegames/rhythmism.git
cd rhythmism
```

Use the Node.js version:

```sh
nvm use
```

Install the dependencies:

```sh
npm install
```

## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the game in the development mode.

Open [http://localhost:5173](http://localhost:5173) to view it in the browser.

The page will reload if you make edits.

You will also see any errors in the console.

### `npm run build`

Builds the game for production to the `dist` folder.

It correctly bundles in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your game is ready to be deployed!

### `npm run bundle`

Builds the game and packages it into a Zip file in the `dist` folder.

Your game can be uploaded to your server, [Itch.io](https://itch.io/), [Newgrounds](https://www.newgrounds.com/), etc.

## License

[MIT](LICENSE)