woodythewooden/SoftLK-lib
woodythewooden/SoftLK-lib
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Clean up README.md

Browse source
This commit is contained in:
Captain4LK 2020-07-19 20:34:43 +02:00
parent 542c1e4f9d
commit 810d7f2c5d
2 changed files with 31 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
README.md
View file

@ -1,39 +1,54 @@
# SoftLK Engine
A software accelerated engine that uses OpenGL to bring the graphics to the screen. It's made for low resolutions (eg. 256x240), but can be used for higher resolutions, too.
A software accelerated engine using OpenGL to bring the graphics to the screen. It's made for low resolutions (eg. 256x240), but should handle higher resolutions, too.
## Features
* Layers: Draw to multiple independent layers
* RGB drawing: Draw in 32bit rgba colorspace
* Pal drawing: Draw in palletized 8bit colorspace and change the palette on the fly, without needing to redraw
* Image loading: Load and save from and to multiple file formats
* Image loading: Load and save sprites from and to multiple file formats
* OpenGL 2.1: It's old. It's antiquated. I mean, who needs shaders anyway?
## License
SoftLK is free Software (as in freedom) and is released under the 3-clause BSD license, see LICENSE.md for details. Most of the examples are released under the same license, unless noted otherwise of course.
## Using SoftLK
To use SoftLK you need to have the following libraries installed:
* [SDL 2](https://www.libsdl.org/)
You need to link your programm to the following libraries:
Linux:
* -lSDL2
* -lGL
* -ldl
## Getting started
1. Get a compiler: I use gcc but clang works too.
2. Install the SDL2 development files:
On Debian/Ubuntu: `` sudo apt install libsdl2-dev`` (Note: I haven't used a Debian/Ubuntu based distro in a while)
On Void-Linux: `` sudo xbps-install SDL2-devel``
3. Clone this repository: `` git clone https://codeberg.org/Captain4LK/SoftLK-lib.git``
4. Compile SoftLK:
You can either use the provided makefile:
```
cd SoftLK-lib/lib
make
```
Or compile it yourself:
```
cd SoftLK-lib/lib
gcc -O3 -c ../src/*.c -lm -lSDL2 -lGL #Compile to object files first
gcc -O3 -c ../external/glad.c -lm -lGL #Compile glad too
ar cr libSLK.a *.o #Then link them together
```
5. If everything went right you are now ready to start using SoftLK. Now you can either look at some of the examples, look at the [Getting started](https://codeberg.org/Captain4LK/SoftLK-lib/wiki/Getting-started) wikipage or figure things out yourself by looking at the source.
## Plattforms
SoftLK has been tested and is working on the following plattforms/os:
* Void GNU/Linux, amd64 (glibc/musl-libc)
* Raspbian 10, raspberry pi 4b
SoftLK should work on any plattform that has a C compiler, SDL2 and OpenGL 2.1, the plattforms listed here are just the ones I frequently test SoftLK on.

1
include/SLK/SLK.h
View file

@ -25,7 +25,6 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
#include <time.h>
#include <string.h>
#include <SDL2/SDL.h>
#include "../../external/glad.h"
//Internal includes
#include "SLK_types.h"