You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Dan Balasescu 7b42ec941f
Merge pull request #2008 from peppy/logging-rate-limiting
4 days ago
.github Add a simple Pull Request template 5 months ago
.idea/.idea.osu-framework/.idea/runConfigurations Restore missing build Rider configuration 6 months ago
.vscode Prepend application location to LD_LIBRARY_PATH on linux 6 months ago
SampleGame OpenTK -> osuTK 3 weeks ago
osu.Framework Merge branch 'master' into logging-rate-limiting 4 days ago
osu.Framework.Tests Wait for load to start 4 days ago
.editorconfig Add .editorconfig to osu-framework repo. 1 year ago
.gitattributes Update .gitattributes 8 months ago
.gitignore Normalize all the line endings 8 months ago
.travis.yml Normalize all the line endings 8 months ago
Directory.Build.props Disable sourcelink on mono. 6 days ago
LICENCE Update licence year 9 months ago
README.md Fix typo 3 weeks ago
appveyor.yml Remove nuget symbol packages 6 days ago
appveyor_deploy.yml Remove nuget symbol packages 6 days ago
osu-framework.licenseheader Update licence headers 11 months ago
osu-framework.sln Remove net471 targeting 5 months ago
osu-framework.sln.DotSettings Attempt to fix inspection severity 1 week ago

README.md

osu!framework Build status CodeFactor dev chat

A game framework written with osu! in mind.

Requirements

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.

Contributing

Contributions can be made via pull requests to this repository. We hope to credit and reward larger contributions via a bounty system. If you’re unsure of what you can help with, check out the list of open issues.

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. I welcome all feedback so we can make contributing to this project as pain-free as possible.

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

osu! – rhythm is just a click away!