https://github.com/carltheperson/Otis

A text adventure creater that exports to native shell scripts
https://github.com/carltheperson/Otis

flask react text-adventure

Last synced: about 2 months ago
JSON representation

A text adventure creater that exports to native shell scripts

• Host: GitHub
• URL: https://github.com/carltheperson/Otis
• Owner: carltheperson
• Created: 2020-04-28T19:58:04.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-05-06T20:11:29.000Z (over 3 years ago)
• Last Synced: 2023-03-08T22:12:15.568Z (over 1 year ago)
• Topics: flask, react, text-adventure
• Language: JavaScript
• Homepage:
• Size: 800 KB
• Stars: 4
• Watchers: 0
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Otis

![](screenshot.png)

Otis is a text adventure maker that converts to native shell scripts for different operating systems.

It will have it's own markdown language, and is meant to be ran in Docker.

You will be able to export to batch and bash.

Front-end will be React.

Back-end will be Flask.

Database will be MongdoDB.

Testing and building will be with Jenkins.

## Backend structure

### Database Adventures

Each adventure will be stored in the database in the collection "adventures".

This will include:

* title: The title of the adventure.

* source: The source code in Otis markdown.

### API endpoints

* **POST /adventure** Creates a new blank adventure with the title included in the body. Returns the id.

* **GET /adventure** Get an array of all adventures with the title and id.

* **GET /adventure/(id)** Returns the adventure object.

* **PUT /adventure/(id)** Applies any changes included in the request body.

* **DELETE /adventure/(id)** Deletes an adventure.

* **GET /export/(file)/(id)** Returns new file exported from adventure source.

### Otis markdown

Here is an example of an adventure written in Otis markdown:

```

This is the main screen.

* Here is an option {

    Here is a screen inside an option.

    * Another option {

    }

}

* Here is another option {

}

```