kdx
/
kble
mirror of https://git.sr.ht/~kikoodx/kble
2
1
Fork 0
Code Issues Releases Activity

Update README.md with informations and build instructions.

This commit is contained in:
KikooDX 2021-01-27 15:41:23 +01:00
parent 23fac64415
commit ab597a39ca
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,14 +1,27 @@
# KBLE, a KeyBoard driven Level Editor
A work in progress level editor with extensive keyboard support.
Designed for tile based 2D platformers.
This is a work in progress program in unusable state.
# Short term design decisions
Subject to change.
* Fully keyboard driven modal editing. Mouse support is secondary.
* GUI application made in [Zig](https://ziglang.org/) with [raylib](https://raylib.com/).
* GUI application made in [Zig](https://ziglang.org/) with
[raylib](https://www.raylib.com/).
* Configurable (format unknown).
* [LDtk](https://ldtk.io/) inspired tiling rulesets.
# Build instructions
Build requirements: [Zig](https://ziglang.org/download/) master branch,
[raylib](https://www.raylib.com). For Arch users, `zig-git` is available
in the AUR.
```sh
$ # Clone this repository
$ git clone https://git.sr.ht/~kikoodx/kble && cd kble
$ zig build run
```
Press escape to close the program.
# License
Copyright (C) 2021 KikooDX