ppy/osu-framework

osu!framework

A game framework written with osu! in mind.

Developing a game using osu!framework

If you are interested in creating a project using the framework, please start from the getting started wiki resources (or jump straight over to the project templates). You can either start off from an empty project, or take a peek at a working sample game. Either way, full project structure, cross-platform support, and a testing setup are included!

The rest of the information on this page is related to working on the framework, not using it!

Objectives

This framework is intended to take steps beyond what you would normally expect from a game framework. This means things like basic UI elements, text rendering, advanced input handling (textboxes) and performance overlays are provided out-of-the-box. Any of the osu! code that is deemed useful to other game projects will live in this framework project.

• Anywhere we implement graphical components, they will be displayed with a generic design and will be derivable for further customisation.
• Common elements used by games (texture caching, font loading) will be automatically initialised at runtime.
• Allow for isolated development of components via a solid testing environment (VisualTests and TestCases). Check the wiki for more information on how these can be used to streamline development.

Requirements

• A desktop platform with the .NET 10 SDK.
• When running on linux, please have a system-wide ffmpeg installation available to support video decoding.
• When working with the codebase, we recommend using an IDE with intellisense and syntax highlighting, such as Visual Studio 2019+, Jetbrains Rider, or Visual Studio Code with the EditorConfig and C# plugin installed.

Building

Build configurations for the recommended IDEs (listed above) are included. You should use the provided Build/Run functionality of your IDE to get things going. When testing or building new components, it's highly encouraged you use the VisualTests project/configuration. More information on this provided below.

• Visual Studio / Rider users should load the project via one of the platform-specific .slnf files, rather than the main .sln. This will allow access to template run configurations.

Code analysis

Code analysis can be run with powershell ./InspectCode.ps1 or InspectCode.sh.

Contributing

Contributions can be made via pull requests to this repository.

If you're unsure of what you can help with, check out the list of open issues (especially those with the "good first issue" label).

Before starting, please make sure you are familiar with the development and testing procedure we have set up. New component development, and where possible, bug fixing and debugging existing components should always be done under VisualTests.

Note that while we already have certain standards in place, nothing is set in stone. If you have an issue with the way code is structured; with any libraries we are using; with any processes involved with contributing, please bring it up. We welcome all feedback so we can make contributing to this project as pain-free as possible.

Our team believes in human contributions. Any contribution – be it an issue report or a pull request – which is created by, documented by, or aided by AI/LLM usage will typically be closed and locked without further discussion.

Licence

This framework is licensed under the MIT licence. Please see the licence file for more information. tl;dr you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.

The BASS audio library (a dependency of this framework) 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.

Projects that use osu!framework

Here are some early examples of projects powered by osu!framework:

• osu! – rhythm is just a click away!
• GDEdit - A third-party Geometry Dash editor.
• Vignette - An OpenCV-based facial recognition software for Live2D
• IWBTM - A platform game with level editor based off of "I Wanna..." games
• DeltaDash - A multi-direction, lane-based scroller rhythm game
• fluXis - A community-driven rhythm game with a focus on creativity and expression

See more (or post your own work) in this discussion thread!