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 7e461d590b
Bump NUnit3TestAdapter from 3.14.0 to 3.15.0 (#2791)
1 day ago
.idea/.idea.osu-framework/.idea/runConfigurations Update VisualTests.xml 8 months ago
.vscode Intend the vscode config correctly 6 months ago
SampleGame Move SpriteIcon to framework side 5 months ago
SampleGame.Android Move Android native libs 2 weeks ago
SampleGame.Desktop Move SpriteIcon to framework side 5 months ago
SampleGame.iOS Use NativeReference instead of -force_load for iOS 3 weeks ago
assets Add logo assets 2 months ago
build Update cake 3 weeks ago
osu.Framework Clear window with opaque blackness 1 day ago
osu.Framework.Android Add missing using 1 week ago
osu.Framework.NativeLibs Add macOS ffmpeg libraries 2 weeks ago
osu.Framework.Tests Bump NUnit3TestAdapter from 3.14.0 to 3.15.0 1 day ago
osu.Framework.Tests.Android Move Android native libs 2 weeks ago
osu.Framework.Tests.iOS Use NativeReference instead of -force_load for iOS 3 weeks ago
osu.Framework.iOS Expose decoder state as a bindable 1 week 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 5 months ago
.travis.yml Normalize all the line endings 1 year ago
Directory.Build.props Fix screen testcase not working after dynamic compile 6 months ago
LICENCE Standardise remaining cases 7 months ago
README.md Fix double grammar 1 week ago
appveyor.yml Merge remote-tracking branch 'upstream/master' into next-android 5 months ago
appveyor_deploy.yml Implement the deploy scripts 6 months ago
appveyor_native_deploy.yml Actually run deploy script for native libs via appveyor 5 months ago
build.ps1 Set executable flag on build scripts 5 months ago
build.sh Set executable flag on build scripts 5 months ago
cake.config Add a cake.config. This corrects the tool resolve path that cake uses. 6 months ago
osu-framework.Android.sln Merge from upstream/master 7 months ago
osu-framework.Android.sln.DotSettings Add DotSettings for Android solution 6 months ago
osu-framework.iOS.sln Fix iOS project inclusion 7 months ago
osu-framework.iOS.sln.DotSettings Disable auto detected rules 5 months ago
osu-framework.licenseheader Update licence header (and remove year) 7 months ago
osu-framework.sln Review changes 5 months ago
osu-framework.sln.DotSettings Apply line formatting changes in line with osu inspections 2 months ago
osu.Framework.Android.props Add Android native references 2 weeks ago
osu.Framework.iOS.props Merge branch 'master' into mobile-ffmpeg 1 week ago

README.md

osu!framework

Build status CodeFactor dev chat

A game framework written with osu! in mind.

Requirements

  • A desktop platform with the .NET Core SDK 2.2 or higher installed.
  • When running on linux, please have a system-wide ffmpeg installation available to support video decoding.
  • When running on Windows 7 or 8.1, *additional prerequisites** may be required to correctly run .NET Core applications if your operating system is not up-to-date with the latest service packs.
  • When working with the codebase, we recommend using an IDE with intellisense and syntax highlighting, such as Visual Studio Community Edition (Windows), Visual Studio Code (with the C# plugin installed) or Jetbrains Rider (commercial).

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.

If you’re unsure of what you can help with, check out the list of open issues (especially those with the “good first issue” label).

Before starting, please make sure you are familiar with the development and testing procedure we have set up. New component development, and where possible, bug fixing and debugging existing components should always be done under VisualTests.

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

For those interested, we love to reward quality contributions via bounties, paid out via paypal or osu! supporter tags. Don’t hesitate to request a bounty for your work on this project.

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!