Add documentation for Treasurer’s group system

This commit is contained in:
Wuzzy
2014-10-04 04:31:02 +02:00
parent 3b62cb8a2c
commit 88ca8bafbf
2 changed files with 66 additions and 35 deletions

View File

@ -1,76 +1,75 @@
If you wish to register treasures to Treasurer, it is recommended to assign the treasurer to a Treasurer group.
Treasurer also requires you to assign each
It is not possible to assign a treasure to multiple groups. If you think a treasurer fits to two groups, create
It is not possible to assign a treasure to multiple groups. If you think a treasure fits into two groups, create
two seperate treasure definitions instead. But try to keep it as an exception.
Think of treasurer groups as drawers for treasurers to put into.
Think of treasurer groups as categories for treasurers to put into.
This file contains some guidelines for Treasurer groups and there are even guidelines for preciousness levels.
Keep in mind these are only guidelines
Keep in mind these are only guidelines.
Treasurer suggests to use the following standard Treasurer groups:
crafting_component:
generic group for components in crafting recipes. If it is primarily a component for food, use raw_food instead.
preciousness is based roughly on the preciousness of items it can create
Generic group for components in crafting recipes. If it is primarily a component for food, use raw_food instead.
Preciousness is based roughly on the preciousness of items it can create.
fuel:
fuel for furnaces
preciousness is based on burning time
Fuel for furnaces.
Preciousness is based on burning time.
food:
can be eaten and restores health
preciousness should equal the number of hearts restored, but not higher than 7.
Can be eaten and restores health.
Preciousness should equal the number of hearts restored (restored HP divided by 2), but not higher than 7.
raw_food:
food which is not fully processed and is not (quite) ready to be eaten.
Food which is not fully processed and is not (quite) ready to be eaten.
melee_weapon:
primarily used to damage close foes, i.e. a sword
preciousness is based on attack speed and damage
Primarily used to damage close foes, i.e. a sword.
Preciousness is based on attack speed and damage.
ranged_weapon:
primarily used to damage far away foes,
preciousness is based on attack speed, damage and range
Primarily used to damage far away foes,
Preciousness is based on attack speed, damage and range.
tool:
a tool for other uses.
preciousness is hard to determine; at least is should base on the number of uses.
A tool for other uses.
Preciousness is hard to determine; at least is should base on the number of uses.
minetool:
a tool to destroy blocks. Includes pickaxes, axes, shovels, …
preciousness is based on power, number of uses and speed
A tool to destroy blocks. Includes pickaxes, axes, shovels, …
Preciousness is based on power, number of uses and speed.
deco:
primarily just a decorational thing to place
preciousness is based on beauty, highly subjective
Primarily just a decorational thing to place.
Preciousness is based on beauty, highly subjective.
light:
is a light source
preciousness is based on the brightness. For the maximum brightness, preciousness should be 3.
Is a light source.
Preciousness is based on the brightness. For the maximum brightness (before sun brightness), preciousness should be 3.
building_block:
A block for buildings. Includes stairs, slabs, fences and similar things.
Excludes all natural blocks.
preciousness should be rougly based on the “cost” to craft the block.
Preciousness should be roughly based on the “cost” to craft the block.
seed:
seeds and saplings
preciousness is based on the “usefulness” of what can grow from the seed.
Seeds and saplings.
Preciousness is based on the percieved “usefulness” of what can grow from the seed.
transport_vehicle
a vehicle to transport players and stuff, i.e. a cart or a boat
preciousness is hard to determine, maybe speed?
A vehicle to transport players and stuff, i.e. a cart or a boat.
Preciousness is hard to determine, maybe speed?
transport_structure
a fixed structure which is neccessary for a transport vehicle to operate, i.e. rails
preciousness is hard to dertermine …
A fixed structure which is neccessary for a transport vehicle to operate, i.e. rails.
Preciousness is hard to dertermine …
ladder
a ladder
A ladder.
default:
This is the group your treasure get assigned to if you dont specify a group.