README.md

fluXis

A community-driven rhythm game with a focus on creativity and expression.

Downloading and playing the game

Windows 8.1+

1. Download and install the .NET 8.0 desktop runtime from here.
2. Download install.exe from the latest release or the download button on the website.
3. Run the installer.

Make sure to report any issues with the installer to the discord server.

Linux

1. Download and install the .NET 8.0 desktop runtime.
2. Download fluXis.AppImage from the latest release.
3. Run the AppImage.

macOS

macOS releases soon™

Building and Developing

Requirements

• A desktop computer running Windows, macOS, or Linux with the .NET 8.0 SDK installed.
• An IDE of your choice, for example JetBrains Rider, Visual Studio or Visual Studio Code.

Downloading the source code

You can download the source code by cloning the repository using git:

git clone https://github.com/InventiveRhythm/fluXis
cd fluXis

To update the source code to the latest version, run the following command in the repository directory:

git pull

Building

To build and run the game, run the following command in the repository directory:

dotnet run --project fluXis.Desktop

License

fluXis is licensed under the MIT License. tl;dr: You can do whatever you want with the code, as long as you include the original license.

Star History