kble/README.md

54 lines
1.4 KiB
Markdown
Raw Normal View History

2021-01-24 19:22:48 +01:00
# 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.
2021-01-24 19:22:48 +01:00
# 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://www.raylib.com/).
2021-01-24 19:22:48 +01:00
* 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.
# Default keybindings
Movement, hold Shift to expand selection:
* `h`: left
* `j`: down
* `k`: up
* `l`: right
* `y`: up-left
* `u`: up-right
* `b`: down-left
* `n`: down-right
* `<space>`: reset selection
Actions:
* `d`: delete selection
* `r`: replace selection
* `+`: increase scale (zoom)
* `-`: decrease scale (dezoom)
* `=`: reset scale
# Mouse control
* Right click: reset selection.
* Hold left click: add to selection.
* Hold left click + shift: select rectangle.
2021-01-24 19:22:48 +01:00
# License
Copyright (c) 2021 KikooDX
2021-01-24 19:22:48 +01:00
This project is under the MIT license.
See LICENSE for more details.