Zeyu-Li / choose_your_own_adventure_react_maker

A Text Adventure Game Creator - Starting creating your adventure :crossed_swords: now by reading the readme then go here:

Choose your Adventure Maker

Do you want to create a Choose your Own Adventure game on the web? Well now you can. To start making your adventure, start with the link here. This website will help you generate your adventure. Then go to the releases, download a recent release, unzip it and place your generated JSON adventure into the JSON folder (+ images you specified in the images folder). Now you can go to the website on a live server and your adventure will begin. This is a website you can host (or with GitHub pages) and share with your friends

NOTE, YOU DO NOT NEED REACT

React is only for development and you can just take the website template in releases and follow the instruction above to get a working static website

Setup (same as above but in step form)

1. To start making your adventure, start with the link here (for help, press the ? (Help) button)
2. Then go to the releases: https://github.com/Zeyu-Li/choose_your_own_adventure_react_maker/releases
3. Download a recent release and unzip it
4. Place the generated JSON from the website and images into the images folder (these have to have the same name as the one specified in the adventure website generator)
5. Run the website on a live server (because of the JSON file) such as VS code Live Server, Brackets.io, or Atom. (Another options is a web server chrome extension, but it may be buggy)
6. Share with your friends! (You can upload to GitHub Pages!!)

Demo (Alpha 0.01)

This demo is also available if you build the project as it is right now or the link here

Designing

Here is how designing the adventure will look like.

For Devs only

This selection is for those that want to change the "engine".

The "engine" is built with React with the adventure generator website build in HTML/CSS/JS(jQuery)

Running

To start the project, navigate to the template directory and type

npm start

Build

To build to project to a static website, use the following command:

npm run build

Made With

• create-react-app

Licence

Boilerplate images are made by me and I give you permission to use them with Attribution:

Attribution CC BY

The rest, including the code is under MIT licence.