light/README.md

38 lines
1.1 KiB
Markdown
Raw Normal View History

2021-06-21 19:16:53 +04:30
# Light
2022-05-26 10:33:40 +00:00
~~A Cross-Platform, Cross-GraphicsAPI Game Engine~~
2021-06-21 19:16:53 +04:30
2022-05-26 10:33:40 +00:00
A game engine with Vulkan backend and emphasis on pixel art.
2022-05-06 23:34:20 +04:30
2022-05-26 10:33:40 +00:00
## New plan
I'm going to remove the support for DirectX & OpenGL, this engine will only implement Vulkan for performance and simplicity(not Vulkan's simplicity but simplicity of not having 3 GraphicsAPIs exposed using the same functions...)
2021-06-21 19:16:53 +04:30
2022-05-26 10:33:40 +00:00
But for the time being, I need to learn vulkan, so the engine will be in an unusable state
Many things need to be changed as well, and I do have a busy schedule, so it'll take a while.
2022-03-31 21:12:18 +04:30
2021-06-21 19:16:53 +04:30
## Supported Operating Systems
2021-10-01 15:52:22 +03:30
* Linux
2022-05-26 10:33:40 +00:00
* Windows (Fails to build ATM)
2021-06-27 08:33:48 +04:30
Will support:
2022-05-26 10:33:40 +00:00
* Mac
2021-06-21 19:16:53 +04:30
## Getting Started
2021-09-14 18:16:08 +04:30
### Prerequisites
2021-09-15 14:06:01 +04:30
* CMake (duh)
* C++ 20
2022-05-26 10:33:40 +00:00
* Vulkan 1.3 support
2021-09-14 18:16:08 +04:30
### Getting the project
```bash
2022-05-26 10:33:40 +00:00
git clone --recurse-submodules https://github.com/Light7734/light
2021-09-14 18:16:08 +04:30
# if you cloned non-recursively then run "git submodule update --init"
2022-05-26 10:33:40 +00:00
mkdir light/build
cd light/build
cmake -DEXPORT_COMPILE_COMMANDS=1 .. && ln -fs ./compile_commands.json ../compile_commands.json
2022-03-31 21:12:18 +04:30
cmake --build . -j20
```
hmu if you wanna chat Light7734#4652