Skip to content

Latest commit

 

History

History
19 lines (14 loc) · 1.38 KB

README.md

File metadata and controls

19 lines (14 loc) · 1.38 KB
Raw

PixelDot

PixelDot is a simple game framework written in C# utilising SFML.net to provide a fantasy console-esque environment for creating games with imposed limitations and is based around only using individual pixels as the base unit of graphics. This project is not intended to be used a game framework but a playground to experiment with. PixelDot

Creating applications

You create "Applications" which contain a create, update and end method where you can use a variety of methods provided by PixelDot.

To create an application, you must inherit from the Application class and use the RunnableApplication attribute.

Running applications

After you create the application, you must provide four arguments to the application window x size, window x size, pixel scale and application class name.

A simple script to compile and run the application can be found in test-run.sh (Linux/Mac OS X users) and test-run.bat (Windows users)

Provided classes

  • Palette (struct) - This provides the predefined colour palette supported by PixelDot
  • Logger - This provides functionality to log information to the console for debugging.
  • Input - This class provides input support, keyboard and mouse for PixelDot.
  • Core - This is a very important class, it contains the core of the framework, provides abstractions over SFML.net for drawing pixels to the screen, etc.