Skip to content

Commit

Permalink
Add doc pages
Browse files Browse the repository at this point in the history
  • Loading branch information
RowDaBoat committed Jun 22, 2024
1 parent e31ceb0 commit c548615
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
3 changes: 3 additions & 0 deletions doc/actions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Keep Engine

## Actions
3 changes: 3 additions & 0 deletions doc/characters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Keep Engine

## Characters
3 changes: 3 additions & 0 deletions doc/dialogues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Keep Engine

## Dialogues
3 changes: 3 additions & 0 deletions doc/events.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Keep Engine

## Events
3 changes: 3 additions & 0 deletions doc/items.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Keep Engine

## Items

0 comments on commit c548615

Please sign in to comment.