Difference between revisions of "Script:Backpack"
From Roll20 Wiki
(→Getting Started) |
(→Getting Started) |
||
Line 18: | Line 18: | ||
== Getting Started == | == Getting Started == | ||
− | Once you load the backpack.js and backpack_tmp.js scripts into your campaign, you'll need to at least create an | + | Once you load the backpack.js and backpack_tmp.js scripts into your campaign, you'll need to at least create an [[Script:Backpack#Asset_Database|asset database]]. The [[Script:Backpack#Asset_Database|asset database]] is a journal entry that contains within its '''gmnotes''' section the library of images to be used for '''item definitions''' |
− | + | After creating an asset database, you're ready to populate backpack compatible journal entries as inventories, stores, or loot cache drops. | |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
== General Use == | == General Use == |
Revision as of 23:00, 25 June 2015
API Script
Author: Ken L.
Version: 1.25
Last Modified: 2015-6-24
Code: NA
Dependencies: None
Conflicts: Unknown
Backpack is a journal based inventory system that updates the 'bio' section of a journal to represent a graphic inventory interface. This allows GMs whom implement this script to allow players to manage a graphic representation of their inventory. Once setup, you can move, give, drop, and pickup items through the use of the API button interface as well as buy and sell from shops and stores should they be prepared.
To use this script requires quite a bit of setup on the part of the GM preparing the asset and item databases. The asset database is simply a list of available item types/subtypes and their associated images. The item database is a list of parsable item signatures which can be short hand written to loot drop handouts or any backpack compatible journal entry.
Getting Started
Once you load the backpack.js and backpack_tmp.js scripts into your campaign, you'll need to at least create an asset database. The asset database is a journal entry that contains within its gmnotes section the library of images to be used for item definitions
After creating an asset database, you're ready to populate backpack compatible journal entries as inventories, stores, or loot cache drops.
General Use
TODO
Asset Database
The asset database is a journal entry that contains within its gmnotes section the library of images to be used for item definitions
The asset database has a simple format where each line is a single asset entry (blank lines between groups of entries are fine).
Each asset entry is in either of the following formats:
Type:Link
Type:Subtype:Link
Formally:
type
subtype
link
type
link
type
→ Existing type in backpack_tmp.js
sybtype
→ Anything except ε
link
→ HTML link to the image source, must start with 'http' case insensitive
Item Database
TODO
Customizing
TODO
Changelog
TODO