Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 3.13 KB

README.md

File metadata and controls

80 lines (53 loc) · 3.13 KB

storiz

A simple engine for creating HTML5 choice-based games. Think super-simple Visual Novel. This v2 version has been rebuilt from the ground up, in javascript.

Test it on Cyclic (slow, but working)

https://valvolt-storiz.cyclic.app

User interface

You are first greeted with a 'New Game' / 'Continue' screen. By clicking 'New Game' a new user is created for you.

Just select next the story you want to play.

Each story let you choose your next action. Usually you just have to click on the button of your choice; occasionally certain areas of the picture are clickable as well.

At the end of the story you will have the possibility to restart or to choose another story.

At any point in time, click the PROFILE link at the bottom of the screen. Keep a copy of your unique code, you will need it if you want to 'Continue' at a later time. On that screen you can also see the achievements you have unlocked.

With the CREDITS link, you can at any time check information about the story

Your progress is saved automatically. Which makes cheating harder :-)

Run your own server

From source

git clone https://github.com/valvolt/storiz
cd storiz
npm install
node server/server.js

Then on your browser, visit http://localhost:8000

With docker-compose

git clone https://github.com/valvolt/storiz
cd storiz
docker-compose up --build

Then on your browser, visit http://localhost:8000

From dockerhub

docker run -d -p 8000:8000 valvolt2/storiz:2.1

Then on your browser, visit http://localhost:8000

On Cyclic (free hosting)

Create your own stories

You can add your own stories. For that, you will need to create and store your own .json file into the server/private/ folder, and store your media files in a subdirectory of server/public/.

The built-in story 'Tutorial' will give you a full walkthrough of how to create your story.

Limitations / on the TODO list

I still plan someday to create a story editor. In the meantime, you'll have to flex your json editing skills !

Another idea is to add a new 'hint' mode for image maps, putting an actual image instead of just a red highlight in 'reveal' mode.

It it still possible to brute-force public resources. If that's a problem for you, rename your media with non-guessable names.

Special Thanks

Special thanks to Anne 'Shinari' Radunski for her enthusiasm and support with the UX. Some of her work has been integrated to this v2 version.

Thanks as well to Henrik Plate for his support and suggestions.

And thanks to You for playing :-)