Update docs and readme with story player

This commit is contained in:
Anthony Rabine 2023-05-31 09:00:29 +02:00
parent 1adb58742a
commit 86ab2f9ae5
3 changed files with 33 additions and 12 deletions

View file

@ -31,15 +31,11 @@ We plan to propose a mechanical enclosure ready to be printed for an official bu
See the documentation! See the documentation!
# Generic player software # Generic player architecture
The base software is highly portable and includes a micro virtual machine. This allow potential complex stories with loops, branches, user choices, randomization... The base software is highly portable and includes a micro virtual machine that executes the story scenario. This allow potential complex stories with loops, branches, user choices, randomization...
This project propose an minimal cross-platform GUI player application that can be used as a base project. This project propose an minimal cross-platform GUI player application that can be used as a base project and VM implementation reference.
Current status:
- Project broken, needs rework to embed the micro-VM
- Qt/QML based, easily portable
# StoryTeller Editor # StoryTeller Editor
@ -63,10 +59,6 @@ The Story plater is a purely software implementation of a simple story player. I
![editor](art/story_player.png) ![editor](art/story_player.png)
Technolologies used:
- C language
- Raylib for graphics and sounds
- CMake build system
# License # License

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

View file

@ -1,7 +1,36 @@
--- ---
outline: deep outline: deep
--- ---
# Software player # Software player
The Story Player is a minimal implementation of OpenStoryTeller in puerely software (without hardware device)
![player](images/story_player.png)
Technolologies used:
- C language
- Raylib for graphics and sounds
- CMake build system
It should be possible to run it everywhere where Raylib can run.
# How to use
Just open the C32 Virtual Machine binary file ("story.c32", typically), images and sounds must follow standard project organisation.
## How to build
The source code is available in the `story-player` sub-directory. From the command line:
```
mkdir build
cmake ..
make
```
## TODO
1. Drag and drop zipped story archive
2. Stories library manager