fluXis is a community-driven vertical scrolling rhythm game (VSRG) built on the osu!framework. Whether you’re here to play, create maps, build custom skins, or write Lua-powered storyboards, this documentation covers everything you need to get started and go deep.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.
Installation
Download fluXis from Steam or build it from source on Windows, macOS, or Linux.
Gameplay Overview
Learn the core mechanics — notes, lanes, scroll speed, and how a match unfolds.
Map Format
Understand the fluXis JSON map schema used by the editor and game engine.
Skinning
Customize every visual element of the game with a JSON skin and image assets.
Storyboarding
Animate your maps with Lua scripts that control visual elements in sync with the music.
Contributing
Build fluXis yourself, submit changes, and explore the plugin system.
What is fluXis?
fluXis is a free-to-play rhythm game available on Steam and as open-source software on GitHub. It supports 1–10+ key modes, a rich built-in map editor, a Lua scripting engine for storyboards, and online multiplayer with leaderboards.Play
Download on Steam and jump into community-created maps across all difficulties.
Create
Use the built-in editor to chart, design events, and author storyboards for your tracks.
Customize
Replace graphics and sounds with custom skins, or write Lua scripts for fully animated visual effects.
Quick Navigation
Download or build the game
Get fluXis from Steam for the easiest setup, or follow the build guide to compile from source.
Learn the gameplay basics
Read the Gameplay Overview to understand notes, scoring, and game modifiers before your first session.
Create your first map
Open the in-game editor and read Map Format to understand how fluXis maps are structured as JSON.
Personalize your experience
Explore Skinning to swap out graphics, or try the Storyboarding & Scripting system for animated visual effects.