spacebox/README

45 lines
1.2 KiB
Plaintext

SFW (SDL Framework)
===================
SFW is a C++ library that facilitates the creation of SDL projects and adds
useful game graphics oriented classes and functions. It is modeled after PGFW, a
Pygame framework, which simplifies the set up of Pygame projects and enhances
and adds some features to Pygame.
It is currently in an early untested stage. It comes with a simple program that
demonstrates how the framework can help set up a project in both SDL and OpenGL
contexts.
Requirements
------------
The SFW source includes some external libraries in the lib/ folder, but there
are also other libraries that must be present in order to compile a project
which uses the framework
* libSDL2 (developed against v2.0.12)
* libSDL2-image
* libSDL2-ttf
* libSDL2-mixer
* OpenGL
* compiler that supports C++17
Demo
----
The demo/ folder contains a simple cube demo. The main purpose of the demo is
to demonstrate switching between 3D and 2D contexts. In order to compile the
demo, you will have to edit the paths in the Makefile to point to the locations
of the necessary libraries on your system.
License
-------
This software is dedicated to the public domain. See
http://creativecommons.org/publicdomain/zero/1.0/ for details.
Author
------
420 at shampoo dot ooo