Introduction

This book contains unofficial documentation for osu!framework. The idea is that this documentation gets expanded over time with extensive, beginner-friendly explanations.

While osu!framework is a great 2D framework, documentation can be severely lacking. The main focus of its maintainers is on developing osu! and most of its developers are already intimately familiar with its inner workings. So while official documentation exists, it is fairly limited and new developers are left to do their own research and read the o!f source code to figure out how everything fits together and what features they have at their disposal.

With this book, I try to document some concepts and features in a simple to understand but comprehensive way, in the hope that it serves as a useful resource to fall back on. As a goal, you shouldn't have to sift through osu!framework code to create a game after reading the completed version of this book. I also include a test project with interactive examples, so you can visually experiment with different concepts.

This work is licensed under CC BY 4.0