Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/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:
https://github.com/zeyu-li/choose_your_own_adventure_react_maker

adventure adventure-maker game-generater react text-adventure text-game

Last synced: about 1 month ago
JSON representation

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

Awesome Lists containing this project

README 

        
# 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](https://zeyu-li.github.io/choose_your_own_adventure_react_maker/event_generator/index.html). This website will help you generate your adventure. Then go to the [releases](https://github.com/Zeyu-Li/choose_your_own_adventure_react_maker/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](https://github.com/Zeyu-Li/choose_your_own_adventure_react_maker/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](https://zeyu-li.github.io/choose_your_own_adventure_react_maker/event_generator/index.html) (for help, press the **?** (Help) button)

2. Then go to the [releases](https://github.com/Zeyu-Li/choose_your_own_adventure_react_maker/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](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer), [Brackets.io](http://brackets.io/), or Atom. (Another options is a web server [chrome extension](https://chrome.google.com/webstore/detail/web-server-for-chrome/ofhbbkphhbklhfoeikjpcbhemlocgigb/related?hl=en), but it may be buggy)

6. **Share** with your friends! (You can upload to GitHub Pages!!)



## Demo (Alpha 0.01)



![demo](images/demo.gif)



This demo is also available if you build the project as it is right now or the link [here](https://zeyu-li.github.io/choose_your_own_adventure_react_maker/adventure_template/build/index.html)



### Designing



![design](images/design.png)



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



```powershell

npm start

```



## Build



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



```powershell

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:



![img](https://licensebuttons.net/l/by/3.0/88x31.png)



**Attribution

CC BY**



The rest, including the code is under MIT licence.