# Foster Foster is a small cross-platform 2D-focused game framework in C#. _★ very work in progress! likely to have frequent, breaking changes! please use at your own risk! ★_ To use the framework either - add a reference to the [NuGet package](https://www.nuget.org/packages/FosterFramework), - or clone this repository and add a reference to `Foster/Framework/Foster.Framework.csproj`. There is a [Samples](https://github.com/FosterFramework/Samples) repo which contains various demos and examples that can help you get started. Check out [Discussons](https://github.com/FosterFramework/Foster/discussions) or [Discord](https://discord.gg/K7tdFuP3Bg) to get involved. ### Dependencies - [dotnet 10.0](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) and [C# 14](https://learn.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-14) - [SDL3](https://github.com/libsdl-org/sdl), which has prebuilt binaries for various platforms through Github Actions. ### Rendering - Rendering is implemented using [SDL_GPU](https://wiki.libsdl.org/SDL3/CategoryGPU). - Shaders must follow the [SDL_GPU shader resource requirements](https://wiki.libsdl.org/SDL3/SDL_CreateGPUShader#remarks). - You can specify which Graphics Device to use when you run your Application. - You must provide shaders for the resulting Renderer (ex. SPIR-V for Vulkan, etc). There are built-in shaders for 2D rendering so this only matters if you write custom shaders. ### Notes - Taken a lot of inspiration from other Frameworks and APIs, namely [FNA](https://fna-xna.github.io/). - This is the second iteration of this library. The first [can be found here](https://github.com/NoelFB/fosterold). - Contributions are welcome! However, anything that adds external dependencies or complicates the build process will not be accepted.