https://github.com/mattmcfarland/rot-web-api

roguelike dungeon generator RESTful web api
https://github.com/mattmcfarland/rot-web-api

apiary dungeon-generator javascript microservice nodejs rest-api roguelike rotjs

Last synced: 4 days ago
JSON representation

roguelike dungeon generator RESTful web api

• Host: GitHub
• URL: https://github.com/mattmcfarland/rot-web-api
• Owner: MattMcFarland
• License: mit
• Created: 2017-04-07T04:40:14.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-04-08T03:46:07.000Z (over 7 years ago)
• Last Synced: 2024-11-16T06:31:28.023Z (about 1 month ago)
• Topics: apiary, dungeon-generator, javascript, microservice, nodejs, rest-api, roguelike, rotjs
• Language: JavaScript
• Homepage: http://docs.roguelike.apiary.io/#
• Size: 32.2 KB
• Stars: 58
• Watchers: 5
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Dungeon generator server [![Build Status](https://travis-ci.org/MattMcFarland/rot-web-api.svg?branch=master)](https://travis-ci.org/MattMcFarland/rot-web-api)

A self-hosted dungeon generation server!

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

## Table of Contents

* [How it works](#how-it-works)

* [API](#api)

  * [API Documentation](http://docs.roguelike.apiary.io/#)

* [Server Setup](#server-setup)

* [Examples](#examples)

* [Acknowledgements](#acknowledgements)

* [License](#license)

## How it works

This server comes with a sample index.html that shows when you send a GET request to the server, it responds with a new map in kind.  This allows you to fully decouple the dungeon generation into a microservice, so that the game can be written in any language that can send HTTP requests and read JSON. Thus, the responsibility for (at least, the initial) dungeon generation itself is offloaded completely.

## API

Should you send a GET request to the server, you will receive JSON data. Read the [API documentation](http://docs.roguelike.apiary.io/#) on apiary for endpoint information with examples.

## Server setup

The API server runs on [Node.js](https://nodejs.org), and has been engineered to be a microservice and run in the cloud.  The easiest way to get your own server up and running is to [deploy with heroku](https://heroku.com/deploy) (which is of no cost to you), that way,  you dont need to setup your own server or install nodejs.

### Test environment

To run on your own system, you need [Node.js](https://nodejs.org) **v7.x** installed.  From there, you can run your own version by cloning this repo, then running npm install/start.

```

git clone https://github.com/MattMcFarland/rot-web-api.git

cd rot-web-api

npm install

npm start

```

Your server should then be running on localhost:8080, from which you can use the REST API end points.

## Examples

When the server is running, you can navigate to the root url to see a very basic example of API usage.

There is an [example server running on heroku](http://rogue-api.herokuapp.com/) right now, if you would like to give it a test drive.  That being said, I highly recommend you check out the [documentation on apiary](http://docs.roguelike.apiary.io/#), as it includes live examples and hits the same server endpoints, anyway.

## Acknowledgements

This would not be possible without the hard work and tireless efforts from the contributors/authors of the following projects:

* [ROT-JS](https://github.com/ondras/rot.js/) provides the algorithms for creating the dungeons, authored by Ondrej Zara

* [Merry](https://github.com/shipharbor/merry) provides the RESTful API service, authored by Yoshua Wuyts

* [NodeJS](http://nodejs.org) provides the run-time environment, authored by many.

* [NPM](http://npmjs.com), the package manager for nodejs, authored by many

## LICENSE

[MIT](./LICENSE)