keii.dev
+10
-5
README.md
+10
-5
README.md
···
11
11
12
12
A game framework written with [osu!](https://github.com/ppy/osu) in mind.
13
13
14
-
## Requirements
14
+
## Using the framework
15
15
16
-
- A desktop platform with the [.NET 5.0 SDK](https://dotnet.microsoft.com/download) or higher installed.
17
-
- When running on linux, please have a system-wide ffmpeg installation available to support video decoding.
18
-
- When running on Windows 7 or 8.1, *[additional prerequisites](https://docs.microsoft.com/en-us/dotnet/core/install/windows?tabs=net50&pivots=os-windows#dependencies)** may be required to correctly run .NET 5 applications if your operating system is not up-to-date with the latest service packs.
19
-
- When working with the codebase, we recommend using an IDE with intellisense and syntax highlighting, such as [Visual Studio 2019+](https://visualstudio.microsoft.com/vs/), [Jetbrains Rider](https://www.jetbrains.com/rider/) or [Visual Studio Code](https://code.visualstudio.com/).
16
+
If you are interested in **creating a project** using the framework, please start from the [getting started](https://github.com/ppy/osu-framework/wiki/Setting-up-your-first-project) wiki resources. The rest of the information on this page is related to working *on* the framework, not *using* it!
20
17
21
18
## Objectives
22
19
···
25
22
- Anywhere we implement graphical components, they will be displayed with a generic design and will be derivable for further customisation.
26
23
- Common elements used by games (texture caching, font loading) will be automatically initialised at runtime.
27
24
- Allow for isolated development of components via a solid testing environment (`VisualTests` and `TestCases`). Check the [wiki](https://github.com/ppy/osu-framework/wiki/Development-and-Testing) for more information on how these can be used to streamline development.
25
+
26
+
## Requirements
27
+
28
+
- A desktop platform with the [.NET 5.0 SDK](https://dotnet.microsoft.com/download) or higher installed.
29
+
- When running on linux, please have a system-wide ffmpeg installation available to support video decoding.
30
+
- When running on Windows 7 or 8.1, *[additional prerequisites](https://docs.microsoft.com/en-us/dotnet/core/install/windows?tabs=net50&pivots=os-windows#dependencies)** may be required to correctly run .NET 5 applications if your operating system is not up-to-date with the latest service packs.
31
+
- When working with the codebase, we recommend using an IDE with intellisense and syntax highlighting, such as [Visual Studio 2019+](https://visualstudio.microsoft.com/vs/), [Jetbrains Rider](https://www.jetbrains.com/rider/) or [Visual Studio Code](https://code.visualstudio.com/).
28
32
29
33
### Building
30
34
···
75
79
- Must be a GitHub link (i.e. your project is open source)
76
80
- Must be actively developed (and have executable releases)
77
81
-->
82
+