sle/README

88 lines
2.0 KiB
Plaintext

SLE
===
A simple project oriented single screen tilebased level editor.
SLE read and write KBLE level files.
=> https://git.sr.ht/~kikoodx/kble
COMPILATION
===========
Dependencies: raylib
$ git clone https://git.sr.ht/~kikoodx/sle
$ mkdir sle/build && cd sle/build
$ cmake ..
$ make
RUN
===
$ <SLE binary path> -tileset <tileset> -level <KBLE level to open>
Example:
$ build/sle -tileset assets/tileset.png -level sample.kble
SYNOPSIS
========
usage: sle -tileset path -level path [options]
Two windows should appear. A main window, with the level you are
currently editing, and a secondary one, containing the tileset you
provided.
This software is controlled using a mice.
Main window - Editing Area
--------------------------
Left click: draw with selected tile
Right click: erase (tile 0)
Secondary window - Tile Picker
------------------------------
Left click on the tile you want to select.
Exit and save
-------------
Close/kill the main window. The secondary window will close automaticly
and your modifications to the level file will be writen to disk.
FLAGS
======
Mendatory flags
---------------
All these options take a path to a file as argument.
-tileset Tileset image
-level KBLE file
Optionnal flags
---------------
These flags are boolean toggles. They take no option.
-verbose
All these flags take integers as argument.
-tile-width
-tile-height
-editor-width
-editor-height
-editor-target-fps
-editor-off-x
-editor-off-y
-picker-target-fps
-picker-padding
DEFAULT CONFIGURATION
=====================
Edit include/conf.h to change default configuration. Read the comments!
Don't forget to recompile after you made your modifications.
DEBUG FEATURES
==============
The following features are enabled with the -verbose flag.
Pressing middle mouse button in the editor will print the value of the
tile pointed to STDIN.
LICENSE
=======
Copyright (C) 2021 KikooDX <kikoodx@paranoici.org>
This software is under the GPL-3.0-or-later license.
See COPYING for more informations.