GURPS Dungeon Fantasy Treasure Generator Service

GURPS Dungeon Fantasy Treasure Generation Service v1

A service implementation game aid to help GURPS players easily create a variety of treasure per the GURPS Dungeon Fantasy Treasure Tables supplement.

Service API

This service contains several endpoints which include:

/v1/generate/ : generates one random item
/v1/generate/<number>/ : generates <number> random items
/v1/generate/<number>/<type>/ : generates <number> random items of type <type>
/v1/ttypes/ : returns the treasure types supported by this service

Query Parameters

These endpoints all support one query parameter, format, which determines the format of the returned results. The default is JSON, but if the value 'html' is supplied, then html serialized results will be returned.

The query parameters max, min and max_enchant respectively set the maximum item value, the minimum item value and the maximum number of enchantments per item. You may not set the max value less than the minimum value. IF none of these query parameters are set (they are optional), the the service will generate the values randomly.

Examples

Some examples of using the service. By invoking:

https://df-treasure-generator.herokuapp.com/v1/generate/1/

the service will generate 1 random items. Returning the data as JSON (see example return block below). Invoking:

https://df-treasure-generator.herokuapp.com/v1/generate/11/Containers/

will generate 11 random items of type "Containers".

The data are returned as a list of items.

Returned data and Query Parameters

Data are returned in JSON unless otherwise specified. For example, the first query above could return the following information:

{
  "items": [
    {
      "cost_per_item": "$5320.0",
      "curses": [],
      "desc": "1 Balanced Bolas with small bells and expensive patching [$5320.0, 0.67 lbs; Halfling sized (sm:-2 st: x0.5)]\n\t (Origin: Spirit) Enchantments: Ghost Weapon [skill:20] Supernatural Effects: Special Appearance",
      "enchantments": [
        {
          "name": "Ghost Weapon",
          "skill": 20
        }
      ],
      "name": "Balanced Bolas with small bells and expensive patching",
      "number": 1,
      "treasure_type": "basicmissileweapons",
      "origin": "Spirit",
      "size": "Halfling",
      "size_modifier": -2,
      "supernatural_effects": [
        "Special Appearance"
      ],
      "unit": "",
      "weight_per_item": "0.67 lbs"
    }
  ],
  "library_version": "0.9.2",
  "service_version": "v1"
}

IF the format=html parameter is provided, then instead, html is returned and is rendered as:

<html>
<body>
<ul>

  <li>1 Balanced Bolas with small bells and expensive patching [$5320.0, 0.67 lbs; Halfling sized (sm:-2 st: x0.5)]
     (Origin: Spirit) Enchantments: Ghost Weapon [skill:20] Supernatural Effects: Special Appearance</li> 
 
</ul>
</body>
</html>

Treasure Types

Treasure types currently implemented and understood by the generator include the following :

Accoutrements
Armor
Basic Melee Weapons
Basic Missile Weapons
Books and Maps
Concoctions
Containers
Fiber and Fabric
Garments
Gems
Household Items
Jewelry
Martial Arts Melee Weapons
Martial Arts Missile Weapons
Other Materials
Rare Artifacts
Scrolls
Shields
Spices
Unusual Items

Features & Bugs

The source code for this service may be found at https://github.com/brian-thomas/df-treasure-generator-service. If you find bugs, or want to request new features, please enter them there in the issues section for that project. Thanks!

Here are some of the currently known issues with the service (trace back to the underlying library):

Scroll costs are for assumed 1pt energy cost to cast {it was just too much work to type in all of the spells from GURPS 4e Magic}
Doesn't handle hidden text in Books
Household item decorative motif/designs missing
Gems should be aggregated into higher caret values, but are not currently
Does not allow specifying multiple list of item types rather than one at a time
Missing the (optional) previous owner generation
The item decoration descriptions could probably use a little tweaking (grammar is sometimes off)

Notice

Dungeon Fantasy Treasure Tables and GURPS are a trademark of Steve Jackson Games, and its rules and art are copyrighted by Steve Jackson Games. All rights are reserved by Steve Jackson Games. This game aid is the original creation of Brian Thomas and is released for free distribution, and not for resale, under the permissions granted in the Steve Jackson Games Online Policy.