From c548615b2ce364ed8e685c6685f287d8b2923706 Mon Sep 17 00:00:00 2001 From: Row Date: Sat, 22 Jun 2024 16:17:05 -0300 Subject: [PATCH] Add doc pages --- README.md | 11 ++++++----- doc/actions.md | 3 +++ doc/characters.md | 3 +++ doc/dialogues.md | 3 +++ doc/events.md | 3 +++ doc/items.md | 3 +++ 6 files changed, 21 insertions(+), 5 deletions(-) create mode 100644 doc/actions.md create mode 100644 doc/characters.md create mode 100644 doc/dialogues.md create mode 100644 doc/events.md create mode 100644 doc/items.md diff --git a/README.md b/README.md index cdb0e4a..09dfad0 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ **Keep Engine** is a game engine for text based adventure games written in Kotlin. It features an easy to read and write domain specific language to design scenes, items, characters, actions, and state machines. ## Setup + Add the JitPack to your repositories and `keep-keep` to your dependencies on your project's `build.gradle.kts`. ```kotlin @@ -117,8 +118,8 @@ val scene = Scene("hello-keep", "Hello Keep", "Keep is a text game engine.", The **Keep Engine** can do much more things to help you design your text-based game, such as: -- [Characters with state]() -- [Items with state]() -- [Dialogue Trees]() -- [Custom Actions]() -- [Actions and Events]() +- [Characters with state](doc/characters.md) +- [Items with state](doc/items.md) +- [Dialogue Trees](doc/dialogues.md) +- [Custom Actions](doc/actions.md) +- [Actions and Events](doc/events.md) diff --git a/doc/actions.md b/doc/actions.md new file mode 100644 index 0000000..d167cfa --- /dev/null +++ b/doc/actions.md @@ -0,0 +1,3 @@ +# Keep Engine + +## Actions diff --git a/doc/characters.md b/doc/characters.md new file mode 100644 index 0000000..82f5c2d --- /dev/null +++ b/doc/characters.md @@ -0,0 +1,3 @@ +# Keep Engine + +## Characters diff --git a/doc/dialogues.md b/doc/dialogues.md new file mode 100644 index 0000000..a97e4f9 --- /dev/null +++ b/doc/dialogues.md @@ -0,0 +1,3 @@ +# Keep Engine + +## Dialogues diff --git a/doc/events.md b/doc/events.md new file mode 100644 index 0000000..a1ca79d --- /dev/null +++ b/doc/events.md @@ -0,0 +1,3 @@ +# Keep Engine + +## Events diff --git a/doc/items.md b/doc/items.md new file mode 100644 index 0000000..033e223 --- /dev/null +++ b/doc/items.md @@ -0,0 +1,3 @@ +# Keep Engine + +## Items