diff --git a/README.md b/README.md index 39cd0c5..5ae104f 100644 --- a/README.md +++ b/README.md @@ -31,15 +31,11 @@ We plan to propose a mechanical enclosure ready to be printed for an official bu 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. - -Current status: -- Project broken, needs rework to embed the micro-VM -- Qt/QML based, easily portable +This project propose an minimal cross-platform GUI player application that can be used as a base project and VM implementation reference. # 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) -Technolologies used: -- C language -- Raylib for graphics and sounds -- CMake build system # License diff --git a/docs/images/story_player.png b/docs/images/story_player.png new file mode 100644 index 0000000..3226810 Binary files /dev/null and b/docs/images/story_player.png differ diff --git a/docs/player-intro.md b/docs/player-intro.md index 94b30ad..616a6a6 100644 --- a/docs/player-intro.md +++ b/docs/player-intro.md @@ -1,7 +1,36 @@ --- outline: deep --- - # 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 +