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 f82f17bdcf
Merge pull request #2178 from peppy/fix-more-e
21 hours ago
.idea/.idea.osu-framework/.idea/runConfigurations Update VisualTests.xml 2 months ago
.vscode Intend the vscode config correctly 4 days ago
SampleGame Update licence header (and remove year) 4 weeks ago
SampleGame.Desktop Change order of game/host creation to be more sensible 1 week ago
SampleGame.iOS Fix iOS project 4 weeks ago
build Implement the deploy scripts 3 days ago
osu.Framework Revert some more instances of 'e' variable names 21 hours ago
osu.Framework.NativeLibs User LanguageVersion from Directory.Build.props 1 week ago
osu.Framework.Tests Remove unnecessary using 1 day ago
osu.Framework.Tests.iOS Fix iOS project 4 weeks ago
osu.Framework.iOS Fix excess newline 1 week ago
.editorconfig Add .editorconfig to osu-framework repo. 2 years ago
.gitattributes Update .gitattributes 10 months ago
.gitignore Move the temp files into a temp directory. 4 days ago
.travis.yml Normalize all the line endings 10 months ago
Directory.Build.props Fix screen testcase not working after dynamic compile 1 week ago
LICENCE Standardise remaining cases 4 weeks ago
README.md Update README.md 2 months ago
appveyor.yml Remove the submodule checkout in the appveyor.yml 3 days ago
appveyor_deploy.yml Implement the deploy scripts 3 days ago
appveyor_native_deploy.yml Implement the deploy scripts 3 days ago
build.ps1 run a local httpbin instance and build the ios projects 4 days ago
build.sh Implement cakebuild for osu-framework. 6 days ago
cake.config Add a cake.config. This corrects the tool resolve path that cake uses. 3 days ago
osu-framework.iOS.sln Fix iOS project inclusion 1 month ago
osu-framework.iOS.sln.DotSettings Fix remaining instances 4 weeks ago
osu-framework.licenseheader Update licence header (and remove year) 4 weeks ago
osu-framework.sln rename folders to conform with folder structure 1 month ago
osu-framework.sln.DotSettings Add rider live templates 4 days ago
osu.Framework.iOS.props Update framework dependencies 2 weeks 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!