fluXis is a free, open-source vertical scrolling rhythm game (VSRG) built with a focus on creativity and expression. Developed by a community of rhythm game enthusiasts, fluXis sits atop osu!framework and the .NET 8 runtime, giving it a solid cross-platform foundation while keeping the codebase accessible to contributors of all experience levels. Whether you want to play, create maps, design skins, or extend the game through scripting, fluXis is built to support you.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/InventiveRhythm/fluXis/llms.txt
Use this file to discover all available pages before exploring further.
What Is fluXis?
fluXis is a lane-based rhythm game in which notes scroll vertically toward a hit zone at the bottom of the screen. Players tap, hold, or release notes in time with the music, earning score and accuracy based on timing precision. The game ships with an online infrastructure for ranked play, leaderboards, and multiplayer rooms, making it both a personal creative tool and a competitive platform. The project is licensed under the MIT License, meaning you can study, fork, and redistribute the code freely as long as the original license notice is preserved.fluXis is community-driven. All feature development, map content, and skin
assets are created and maintained by contributors around the world. The best
way to shape the game’s future is to get involved.
Key Features
Gameplay
Vertical scrolling lane gameplay with configurable key counts, scroll speed,
and modifier mods. Precise hit detection is powered by osu!framework’s
audio engine for consistent timing across platforms.
Map Editor
A full in-game map editor lets you author, time, and fine-tune maps without
leaving fluXis. Place notes, set timing points, and preview your map in real
time.
Lua Storyboards
Storyboards are scripted in Lua, giving creators programmatic control over
visuals, animations, and effects that react to the music and gameplay state.
Custom Skinning
Every visual element — notes, hit explosions, lane backgrounds, HUD panels —
can be replaced through the built-in skinning system, with a dedicated
in-game skin editor for live previewing.
Online & Multiplayer
Register an account to submit scores to global leaderboards, spectate other
players in real time, and join multiplayer rooms where everyone plays the
same map together.
Map Imports
Already have a library from another game? fluXis can import maps from
osu!, Quaver, and Stepmania / ITG so you can play your existing
collection right away.
Built on osu!framework and .NET 8
Under the hood fluXis is a .NET 8 application that uses osu!framework as its rendering and input layer. osu!framework provides hardware-accelerated 2D graphics via OpenGL/Vulkan, a high-precision audio pipeline, cross-platform windowing, and a dependency-injection model that makes the codebase highly testable. Because fluXis targets .NET 8, it runs natively on Windows, macOS, and Linux without emulation or compatibility layers.Community and Open Source
fluXis is developed entirely in the open on GitHub. Contributions of all kinds are welcome: new features, bug fixes, translations via Weblate, documentation improvements, and map or skin assets. The project follows the Contributor Covenant Code of Conduct, which holds all participants to a standard of mutual respect, constructive feedback, and inclusive collaboration.GitHub Repository
Browse source code, open issues, and submit pull requests.
Play on Steam
Install the latest stable release with automatic updates via Steam.