LEngine

Let's discover the power of LEngine.

Getting Started

Get started by compiling the binaries.

Or downloading prebuilt binaries from Releases.

What you'll need

• CMake version 3.10 or above:
  • When installing CMake, its recommended to check all checkboxes related to path, dependencies.
• Make version 3.82 or above:
  • When installing Make, make sure to add it to path.
• gcc/g++:
  • When installing gcc make sure to also add it to path.

Building from Source

To build LEngine from source its quite easy to do so.

caution

The Plattform Windows is still in development, it is recommended to use WSL

Linux | WSL

In the current directory of the project run these commands.

make
cmake -B build
cmake --build build

Windows

In the current directory where the repository is run these commands.

cmake -B build
cmake --build build

Explanation:

• Engine_Lua: Represents the root of the directory.
• ├──build: Represents the build folder where executables and object files are stored.
• ├──init.lua: Represents the entry point of the game where the games logic gets written.
• ├──config.lua: Represents the configs file that is optional to change the Games appereance.
• └──docs: Represents the documentation source files.

Start your game

Run your own game based on entry point init.lua and (optional) config.lua:

In Repository

if you want to just get started compiling and running your own game from the repository you will need to have a init.lua and optionally a config.lua.

Just run if you already build it. How to Build?

Linux

./build/el

The ./build/el command runs the executable file el in build directory.

Windows

./build/el.exe

Custom Folder

if you want to start your game from a diffrent directory you would need to first Build from Source if you didnt already do that.

Then you need to copy the executable into the directory where you want your game to be.

Linux

mv ./build/el <path_to_game>
cd <path_to_game>
./el

The mv command moves the file to an other directory.

Windows

move ./build/el.exe <path_to_game>
cd <path_to_game>
./el.exe

The move command moves the file to an other directory.

The cd command changes the directory you're working with. In order to run your game, you'll need to navigate the terminal there.