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 4fc4c94d74
Set framesync based on the refresh rate of the current display (#3117)
9 hours ago
.config Add dotnet format check in CI. 1 month ago
.idea Allow running via command line 2 weeks ago
.vscode Allow running via command line 2 weeks ago
CodeAnalysis CA1715: use prefix for generic parameters. 4 days ago
SampleGame Update .Net Standard projects to 2.1 3 weeks ago
SampleGame.Android Bump Xamarin.Android version to 10.0 3 weeks ago
SampleGame.Desktop Move common properties to props. 2 months ago
SampleGame.iOS Save Xamarin iOS projects with BOM to prevent VS continuously updating them. 1 month ago
assets Remove padding from nuget icon 1 month ago
build Add missing entry to Desktop.proj 2 weeks ago
osu.Framework Set framesync based on the refresh rate of the current display 10 hours ago
osu.Framework.Android Update osuTK to fix macOS window focus issues 2 days ago
osu.Framework.Benchmarks Don't bother with configuration override 2 weeks ago
osu.Framework.NativeLibs Add comment for nupkg folder holder file. 1 month ago
osu.Framework.Tests Address issue on second test 3 days ago
osu.Framework.Tests.Android Bump Xamarin.Android version to 10.0 3 weeks ago
osu.Framework.Tests.iOS Save Xamarin iOS projects with BOM to prevent VS continuously updating them. 1 month ago
osu.Framework.iOS Update osuTK to fix macOS window focus issues 2 days ago
.editorconfig Revert 'simplify using statements`. 1 month ago
.gitattributes Update .gitattributes 1 year ago
.gitignore Update Rider run configurations in line with slnf migration 1 month ago
.travis.yml Normalize all the line endings 1 year ago
Directory.Build.props Update analyzers version after merge. 2 weeks ago
LICENCE Standardise remaining cases 10 months ago
README.md Update README 1 month ago
appveyor.yml Change appveyor image to VS2019 stable. 1 month ago
appveyor_deploy.yml Don't use preview image for deploys 1 month ago
appveyor_native_deploy.yml Don't use preview image for deploys 1 month ago
build.ps1 Use cake as a local tool 2 months ago
build.sh Use cake as a local tool 2 months ago
cake.config Add a cake.config. This corrects the tool resolve path that cake uses. 9 months ago
global.json Bump Microsoft.Build.Traversal from 2.0.19 to 2.0.24 2 weeks ago
osu-framework.Android.slnf Use slnf to split platforms 2 months ago
osu-framework.Desktop.slnf Add benchmark project 2 weeks ago
osu-framework.iOS.slnf Fix iOS slnf including Android test project 3 weeks ago
osu-framework.licenseheader Update licence header (and remove year) 10 months ago
osu-framework.sln Merge branch 'master' into fxcop 6 days ago
osu-framework.sln.DotSettings CA1806: use discards for ignored returns. 4 weeks ago
osu.Framework.Android.props Bump Xamarin.Android version to 10.0 3 weeks ago
osu.Framework.iOS.props Update osuTK to fix macOS window focus issues 2 days 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 3.0 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 2019+, Jetbrains Rider or Visual Studio Code.

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.

Building

Build configurations for the recommended IDEs (listed above) are included. You should use the provided Build/Run functionality of your IDE to get things going. When testing or building new components, it’s highly encouraged you use the VisualTests project/configuration. More information on this provided below.

  • Visual Studio / Rider users should load the project via one of the platform-specific .slnf files, rather than the main .sln. This will allow access to template run configurations.
  • Visual Studio Code users must run the Restore task before any build attempt.

Code analysis

Code analysis can be run with powershell ./build.ps1 or build.sh. This is currently only supported under windows due to resharper cli shortcomings. Alternatively, you can install resharper or use rider to get inline support in your IDE of choice.

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!