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

Merge branch 'master' of https://codeberg.org/Captain4LK/SoftLK-lib

Browse source
This commit is contained in:
Captain4LK 2020-07-26 11:16:28 +02:00
parent a82358325f badc1b001d
commit 8f0991fb27
1 changed files with 28 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
README.md
View file

@ -1,22 +1,22 @@
# SoftLK Engine
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 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.
## Getting started
# SoftLK Engine
1. Get a compiler: I use gcc but clang works 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 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.
## 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)
@ -34,26 +34,25 @@ SoftLK is free Software (as in freedom) and is released under the 3-clause BSD l
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:
## Plattforms
SoftLK has been tested and is working on the following plattforms/os:
* Void GNU/Linux, amd64 (glibc/musl-libc)
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.
## Library Credits
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.
## Library Credits
Here I shall list all external libraries used by SoftLK:
* [SDL2](https://www.libsdl.org/)