MiGame

A basic game library for use with SFML.Net.

Dependencies

• SFML.Net https://github.com/SFML/SFML.Net.git
• MiCore https://github.com/BrokenShards/MiCore.git
• MiGfx https://github.com/BrokenShards/MiGfx.git
• MiInput https://github.com/BrokenShards/MiInput.git
• XInputDotNetPure https://github.com/BrokenShards/XInputDotNet.git

Usage

In MiGame, games are made up of game states that are managed by a state manager, owned by a game window.
A game state, as the name implies, represents a state of your game such as a title screen and contains any needed assets and objects for that state.
A state manager contains a stack of game states, the state on the top is the currently active state. When a new state is pushed to the top, the current state is kept on the stack and stored if it is Storable or removed and disposed if it is not, the new state is then loaded and added. When a state is removed from the stack, the state underneath is restored and becomes active again.
A game window contains the render window and state manager used to run a game. Simply create a new GameWindow and call Run(IGameState), passing it the beginning game state of your game, for example, if the beginning state of your game was a class called StartState, then you would run the game like so:

ExitCode result = ExitCode.UnexpectedFail;

using( GameWindow game = new GameWindow() )
	result = game.Run<StartState>();

if( result != ExitCode.Success )
	Console.WriteLine( "Game ran unsuccessfully." );

The GameWindow class can also be inherited from to easily integrate other systems and libraries, check the documentation for more information.
Please see MiGameTest/Test.cs in the test project for usage examples.

Changelog

Version 1.0.0

• GameState now provides the SubscribeEvents() and UnsubscribeEvents() methods for subscribing to window events and have replaced OnGainFocus(object, EventArgs), OnLoseFocus(object, EventArgs) and OnTextEntered(object, TextEventArgs).
• MiGame now targets .Net 5 and has updated code style for C#9.
• Now depends on MiCore 1.0.0.
• Now depends on MiInput 1.0.0.
• Now depends on MiGfx 1.0.0.

Version 0.5.0

• Changed SFML source to latest official SFML.Net repository.
• Updated MiCore to version 0.5.0.
• Updated MiInput to version 0.9.0.
• Updated MiGfx to version 0.9.0.

Version 0.4.0

• Renamed to MiGame and updated to depend on MiCore, MiGfx and MiInput.

Version 0.3.0

• GameWindow.Run(IGameState) now returns an ExitCode that is stored in GameWindow.ExitCode.
• GameWindow.Exit(int) has been replaced with GameWindow.Exit(ExitCode).
• GameState now contains the virtual methods OnGainFocus(object,EventArgs), OnLoseFocus(object,EventArgs), OnCloseRequest(object,EventArgs) and OnTextEntered(object,TextEventArgs) that are called on their respective window events.

Version 0.2.0

• GameWindow.OnUpdate(float) has been replaced with GameWindow.PreUpdate(float) for updating logic before the current game state and GameWindow.PostUpdate(float) for updating logic after.
• GameWindow.OnDraw() has been replaced with GameWindow.PreDraw() for drawing content before/underneath the current game state and GameWindow.PostUpdate(float) for drawing content after/above.
• When calling StateManager.Push(IGameState), GameState.OnStore() is called for the current state before GameState.OnLoad() is called for the new state, as originally intended.

Version 0.1.0

• Initial release.