Anthony/open-story-teller
1
0
Fork 0
mirror of https://github.com/arabine/open-story-teller.git synced 2025-12-06 17:09:06 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
Open source story teller hardware/firmware/software player and editor
37 commits 2 branches 3 tags 89 MiB
C 68.1%
C++ 24.9%
HTML 3.4%
Java 1.8%
CMake 0.9%
Other 0.5%
Find a file
Anthony Rabine 4d73009f6b Update doc + story player (wip) + packaging (wip)
2023-05-30 16:01:18 +02:00
.github/workflows Update vitepress.yml 2023-04-22 14:21:44 +02:00
art media loop ok, add jumpr assembly, remove old arts 2023-05-24 18:06:38 +02:00
docs Update doc + story player (wip) + packaging (wip) 2023-05-30 16:01:18 +02:00
hardware/kicad First version of OST RPI Pico mother board on kicad 2023-05-11 12:19:51 +02:00
images Update docs 2023-05-02 18:17:03 +02:00
software Working pack! fix VM, new icons... 2023-05-25 16:55:11 +02:00
story-editor Update doc + story player (wip) + packaging (wip) 2023-05-30 16:01:18 +02:00
story-player Update doc + story player (wip) + packaging (wip) 2023-05-30 16:01:18 +02:00
.gitignore Update doc + story player (wip) + packaging (wip) 2023-05-30 16:01:18 +02:00
.gitmodules delete submodule 2023-05-28 14:50:48 +02:00
LICENSE Initial commit 2023-03-21 21:38:06 +01:00
README.md Update docs 2023-05-02 18:17:03 +02:00

README.md

Open Story Teller (OST)

Open Story Teller is an Open Source project to provide guidelines and software to build your own story teller box (electronics, mechanical).

The main goal is to not make electronics boards but instead buy or reuse existing ones. This will allow you to easily repair your device with spare parts.

We propose a set of parts and firmware that is working well together but your are free to custom everything to fit your needs.

This project can be used as a base platform for any device that is composed by:

  • A display (TFT...)
  • An Audio output
  • A SD card or memory
  • Some Buttons / rotary encoder / potentiometer

Links

Hardware parts

We propose the concept of bundles: a set of electronic boards that you can purchase quite easily (eg: Arduino, SeedStudio, Pimoroni, Adafruit, SparkFun...). The bundles are built around a central main board, the CPU, which comes with more or less peripherals (SD-Card reader, Wifi...).

Several bundles will be officially supported ; this is needed for us to ensure the portability of the firmware hardware interface layer.

Current bundles:

  • Raspberry Pico (official DevKit) (ARM Cortex M0+)
  • RISC-V based board (GD32VF103)

We plan to propose a mechanical enclosure ready to be printed for an official bundle.

See the documentation!

Generic player software

The base software is highly portable and includes a micro virtual machine. 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

StoryTeller Editor

We propose a basic editor tool to create your own stories. The generated story script runs on our micro virtual machine and allow generate complex stories.

editor

Work in progress:

  • Project management
  • Story pack generation
  • Basic nodes (media nodes, start and stop)

Planned nodes:

  • Random
  • Loop
  • Conditional

License

MIT License

Copyright (c) 2023 Anthony Rabine