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.
Dean Herbert 59ba30c10f
Fix backspace on iOS (#2552)
5 hours ago
.idea/.idea.osu-framework/.idea/runConfigurations Update VisualTests.xml 5 months ago
.vscode Intend the vscode config correctly 4 months ago
SampleGame Move SpriteIcon to framework side 2 months ago
SampleGame.Android Add AndroidNativeLibrary references 3 months ago
SampleGame.Desktop Move SpriteIcon to framework side 2 months ago
SampleGame.iOS Fix iOS project 4 months ago
build Update r# command line tools 2 weeks ago
osu.Framework Add null checks 1 day ago
osu.Framework.Android Set OnScreenKeyboardOverlapsGameWindow for Android 6 days ago
osu.Framework.NativeLibs Move SpriteIcon to framework side 2 months ago
osu.Framework.Tests Add test 1 day ago
osu.Framework.Tests.Android Add AndroidNativeLibrary references 3 months ago
osu.Framework.Tests.iOS Fix iOS visual test source references 2 weeks ago
osu.Framework.iOS Use a shorter placeholder text 8 hours ago
.editorconfig Add .editorconfig to osu-framework repo. 2 years ago
.gitattributes Update .gitattributes 1 year ago
.gitignore Merge remote-tracking branch 'upstream/master' into next-android 3 months ago
.travis.yml Normalize all the line endings 1 year ago
Directory.Build.props Fix screen testcase not working after dynamic compile 4 months ago
LICENCE Standardise remaining cases 4 months ago
README.md Normalize repo readme format 3 months ago
appveyor.yml Merge remote-tracking branch 'upstream/master' into next-android 3 months ago
appveyor_deploy.yml Implement the deploy scripts 3 months ago
appveyor_native_deploy.yml Actually run deploy script for native libs via appveyor 3 months ago
build.ps1 Set executable flag on build scripts 2 months ago
build.sh Set executable flag on build scripts 2 months ago
cake.config Add a cake.config. This corrects the tool resolve path that cake uses. 3 months ago
osu-framework.Android.sln Merge from upstream/master 5 months ago
osu-framework.Android.sln.DotSettings Add DotSettings for Android solution 4 months ago
osu-framework.iOS.sln Fix iOS project inclusion 5 months ago
osu-framework.iOS.sln.DotSettings Disable auto detected rules 3 months ago
osu-framework.licenseheader Update licence header (and remove year) 4 months ago
osu-framework.sln Review changes 3 months ago
osu-framework.sln.DotSettings Apply line formatting changes in line with osu inspections 2 weeks ago
osu.Framework.Android.props Update Android native library references 3 months ago
osu.Framework.iOS.props Update osuTK NuGet to latest packages 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!