goprogressquest

command module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 25, 2016 License: BSD-3-Clause Imports: 10 Imported by: 0

README

Go Progress Quest

Build Status

This will be a Go Implementation of the famous type of RPG, called: https://en.wikipedia.org/wiki/Progress_Quest

This will be an API which can be consumed by any client in a number of ways.

API Version is 1

/api/1/*

The following end-points are available:

Creational

/

Currently returns:

{
    "message":"Welcome!"
}
# Character names don't have to be unique
/create
POST:
{
    "name":"MyAwesomeCharacterName"
}

Return:

{
    "id":"103b922810b1fac97da1bad872618477"
}
# Load a character by ID since names are not unique at the moment
/load/{ID}
/load/3da541559918a808c2402bba5012f6c60b27661c

Return:

{
    "Inventory":{"Items":[]},"Name":"MyAwesomeCharacterName","Stats":{"Str":0,"Agi":0,"In":0,"Per":0,"Chr":0,"Lck":0},"ID":"3da541559918a808c2402bba5012f6c60b27661c","Gold":0
}
# Start adventuring
/start
POST:
{
    "name":"MyAwesomeCharacterName"
}

Return:

{
    "message":"Started adventuring for character: MyAwesomeCharacterName"
}
# Stop adventuring
/stop
POST:
{
    "name":"MyAwesomeCharacterName"
}

Return:

{
    "message":"Stopped adventuring for character: MyAwesomeCharacterName"
}

Running it

go build

Currently the project is simple enough so that no Makefile is needed for this process.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL