A game framework written with osu! in mind.
Clone or download
peppy Merge pull request #2099 from swoolcock/ios-package-reference
Switch Xamarin.iOS startup projects to PackageReference style
Latest commit 212f723 Jan 19, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add a simple Pull Request template Jun 22, 2018
.idea/.idea.osu-framework/.idea/runConfigurations Update VisualTests.xml Dec 21, 2018
.vscode Update tasks.json Jan 4, 2019
SampleGame.Desktop Update SampleGame.Desktop to netcoreapp 2.2 Dec 14, 2018
SampleGame.iOS Switch Xamarin.iOS startup projects to PackageReference style Jan 18, 2019
SampleGame Split SampleGame to a library and desktop project Nov 20, 2018
osu.Framework.NativeLibs Fix two copies of each library being included in package Jan 10, 2019
osu.Framework.Tests.iOS Switch Xamarin.iOS startup projects to PackageReference style Jan 18, 2019
osu.Framework.Tests Merge branch 'master' into fix-unbind-when-async-disposed Jan 16, 2019
osu.Framework.iOS Update osuTK version Jan 15, 2019
osu.Framework Implement missing IEquatable<> in structs Jan 19, 2019
.editorconfig Add .editorconfig to osu-framework repo. Feb 28, 2017
.gitattributes Update .gitattributes Apr 11, 2018
.gitignore Normalize all the line endings Apr 11, 2018
.travis.yml Normalize all the line endings Apr 11, 2018
Directory.Build.props Disable sourcelink on mono. Dec 5, 2018
LICENCE Update licence year Mar 5, 2018
README.md Update README.md Dec 20, 2018
appveyor.yml Make appveyor artifacts use nuget nativelibs Jan 16, 2019
appveyor_deploy.yml Only use package on deploy Jan 8, 2019
appveyor_native_deploy.yml Remove deploy instead Jan 16, 2019
osu-framework.iOS.sln Fix iOS project inclusion Jan 8, 2019
osu-framework.iOS.sln.DotSettings Rename iOS classes to IOS Dec 22, 2018
osu-framework.licenseheader Update licence headers Jan 5, 2018
osu-framework.sln rename folders to conform with folder structure Jan 8, 2019
osu-framework.sln.DotSettings Rename iOS classes to IOS Dec 22, 2018
osu.Framework.iOS.props Switch Xamarin.iOS startup projects to PackageReference style Jan 18, 2019

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!