A modern port of the osu!framework
jOF is still being ported, and is not ready for production use.
jOF behaves (for the most part) like the C# based osu!framework.
Documentation can be found at https://docs.meowcat.site
This port is intended as a direct, almost 1:1 port of the C# based osu!framework. It is interoperable with Kotlin and Groovy, Scala and other JVM languages.
- A JDK
- Gradle (or a build system of your choice, like Maven or Ant).
- A Java IDE (I recommend IntelliJ IDEA)
To manually build the jOF, clone the repo into your editor. Then run:
./gradlew build on *NIX, or .\gradlew.bat build on Windows.
Contributions can be made via pull requests to this repository. Before starting, please make sure you are familiar with the codebase, and the development and testing procedure.
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.
No LLMs were used in the porting/development of the framework.