diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 14 insertions, 1 deletions
@@ -22,6 +22,7 @@ The reusable stuff is single-header and lives in [kon](kon). Those are the ones - konfont: text, built-in bitmap font or a ttf - kontime: timing and sleeping - kontoml: a very minimal toml parser +- konfs: folders and paths, listing a folder and walking up it, on POSIX and Windows - koninput: input state on top of konwinlib The engine modules are a `.h` and a `.c` pair, they depend on each other a bit, and you pick which ones to build: @@ -30,6 +31,7 @@ The engine modules are a `.h` and a `.c` pair, they depend on each other a bit, | --- | --- | | font | konfont | | toml | kontoml | +| fs | konfs | | tile | tilemaps and sprite sheets | | 2d | what any 2D game needs: a scrolling camera, frame animation, drawing frames of a sprite sheet | | fx | whole screen effects done on the pixels: fade to a colour, flash, shake and tone (adds 2d) | @@ -97,7 +99,7 @@ yes, it's just that. If a module needs another one it adds it for you, so `debug - `-j` is how many files to compile at once, one for each processor if you leave it out. - `-v` shows the compiler commands as they run. -targets are `all`, `run`, `clean`, `tools`, `pack` and `examples`. +targets are `all`, `run`, `clean`, `tools`, `pack`, `examples` and `konedit`. </details> @@ -149,6 +151,17 @@ Loose files in the `assets` folder override the ones in the pack only in the dev obj/konmodel art/models/Fox.glb assets/models/fox.kmdl -t models/ ``` +## Editor + +konedit is the editor, a program built on the engine's own ui. It works on plain files in a project folder, the same ones the engine loads, plus a `project.toml` for the name and the assets folder. + +```sh +./build.sh -d konedit +obj/konedit [project folder] +``` + +It adds the modules it needs itself. File > New Project makes a project.toml and an assets folder, File > Open Project opens one, Ctrl+S saves. The tabs for the tilemap, script and level editors are not written yet. + ## Examples The examples are their own little programs, in the [examples](examples) folder. Each one says how to build it at the top of the file. |