This is a light-weight game engine that prioratises simplicity and code aesthetic above all else.
It uses code written in:
- modern C for engine sided features
- lua 5.4 for user-sided scripting and engine communicating
- markdown for documentation
Go into the tags, and download what version youd like.
You (hopefully) downloaded a zip file containting all the files needed to make your game!
Unfortunately, the Soul Engine is only tested on linux, hopefully windows & other OS implementations will be out in the near future.
Depending on what platofrm youre building on (for example windows or linux), youll have to
run one of the provided commandline scrpits to bootstrap the build process.
Alongside these scripts youll find the source
directory, that contains a template project.
In the source
directory, you will find meta.lua
, main.lua
, and loader.c
which will
have all the necessary code for you to get your game up and running.
Here's what the 3 files do:
- GameSettings.lua | This is a file containing information about your game
- main.lua | In here is where the magic heppens
- loader.c | In here you can load your native-script modules (Coming soon)
Well if you didnt have lua or luac programs before, now you do.
Feel free to play about with the lua command line interface but lets move along with your project.
all you have to do is call ./lua4 build.lua
to get your project compiled into a neat folder called output
,
here you'll find your game file along with all the tools it needs.
To be honest, I didn't wanna :)
I wanted to experiment alternatives and stumbled on the one in use currently.
It is a build system based on pure lua with some os.execute
s for using the compiler, luac, and copy commands
The build system tools/gcc.lua
should technically work for any project, outside of The Soul Engine.
- EVERYTHING
- [lua] Added luac to the source code & added it to the makefile
- [lua] Edited the makefile to build a shared library instead of a static one