RobTF / spikeball

2D Platform game engine written in straight C# which features Sonic the Hedgehog style gameplay.
MIT License
14 stars 5 forks source link

SpikeBall

2D Platform game engine written in straight C# which features Sonic the Hedgehog style gameplay.

Spikeball is a small game engine written with the initial aim of emulating the Sonic the Hedgehog series.

Features

Run & Play!

The project currently consists of a single Visual Studio 2015 solution and two projects, Platformer.DirectX and Platformer.Engine. The "DirectX" project is a renderer that uses Direct2D to perform its drawing and is the project you need to run as it provides the actual entry point, the engine is loaded into the application as an assembly reference.

There are two test maps provided, to "play" them simply choose them from the file menu and use the arrow keys to move Sonic and the Z key to jump.

Pressing P will toggle pause mode, pressing Q whilst paused will run the game frame-by-frame which was a useful debugging tool.

The engine is a single C# assembly however I have contained the game speciific entities in the "Gameplay" namespace as the plan may be to eventually split the game away from the engine proper.

The renderer uses the BASS audio library which has seperate builds for x86/x64, therefore the solution can be built in either x86 or x64, however the engine library does not care which architecture it runs under and is therefore an AnyCPU build.

Licensing and use of the engine

If you are inspired to build a full game with this engine as a base then PLEASE DO!! It's free for all and if you have an idea let me know and I will likely endeavour to support you. There are no royalties required and everytihng falls under the MIT licence. Libraries I have referenced (such as BASS) which are licenced by other means are easily replaced.

Images

In game

Map editing