https://github.com/FosterFramework/Foster

A small C# game framework
https://github.com/FosterFramework/Foster

2d cross-platform csharp dotnet game-development game-engine game-framework gamedev graphics

Last synced: about 1 month ago
JSON representation

A small C# game framework

• Host: GitHub
• URL: https://github.com/FosterFramework/Foster
• Owner: FosterFramework
• License: mit
• Created: 2023-08-19T20:13:34.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-21T18:05:31.000Z (4 months ago)
• Last Synced: 2024-05-21T19:36:22.886Z (4 months ago)
• Topics: 2d, cross-platform, csharp, dotnet, game-development, game-engine, game-framework, gamedev, graphics
• Language: C#
• Homepage:
• Size: 57.5 MB
• Stars: 354
• Watchers: 10
• Forks: 30
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-dotnet - Foster - Foster is a small cross-platform 2D game framework in C#. (Game)

README

        






# Foster

Foster is a small cross-platform 2D 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 refence 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 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) and [C# 12](https://learn.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-12)

 - [SDL2](https://github.com/libsdl-org/sdl) is the only external dependency, which is required by the [Platform library](https://github.com/FosterFramework/Foster/tree/main/Platform). By default this is statically compiled.

### Platform Library

 - The [Platform library](https://github.com/FosterFramework/Foster/tree/main/Platform) is a C library that implements native methods required to run the application.

 - By default, it is currently being built for 64-bit Linux, MacOS, and Windows through [Github Actions](https://github.com/FosterFramework/Foster/actions/workflows/build-libs.yml).

 - To add support for more platforms, you need to build the [Platform library](https://github.com/FosterFramework/Foster/tree/main/Platform) and then include it in [Foster.Framework.csproj](https://github.com/FosterFramework/Foster/blob/main/Framework/Foster.Framework.csproj#L27)

### Rendering

 - Implemented in OpenGL for Linux/Mac/Windows and D3D11 for Windows.

 - Separate Shaders are required depending on which rendering API you're targetting.

 - Planning to replace the rendering implementation with [SDL3 GPU when it is complete](https://github.com/FosterFramework/Foster/issues/1).

### 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.