Athemis/MineClone2
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Import Help 1.1.0: doc, doc_items, doc_identifier

Browse source
This commit is contained in:
Wuzzy 2017-03-18 01:00:20 +01:00
parent 265522435c
commit 2be856f3d1
38 changed files with 4398 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

357
mods/HELP/doc/doc_items/API.md Normal file
View file

@ -0,0 +1,357 @@
# API documentation for `doc_items`
## Introduction
This document explains the API of `doc_items`. It contains a reference of
all functions.
## Quick start
The most common use case for using this API requires only to set some
hand-written help texts for your items.
The preferred way is to add the following optional fields to the
item definition when using `minetest.register_node`, etc.:
* `_doc_items_longdesc`: Long description of this item.
Describe here what this item is, what it is for, its purpose, etc.
* `_doc_items_usagehelp`: Description of *how* this item can be used.
Only set this if needed, e.g. standard mining tools don't need this.
Example:
minetest.register_node("example:dice", {
description = "Dice",
_doc_items_longdesc = "A decorative dice which shows the numbers 1-6 on its sides.",
_doc_items_usagehelp = "Right-click the dice to roll it.",
tiles = { "example_dice.png" },
is_ground_content = false,
--[[ and so on … ]]
})
When using this method, your mod does not need additional dependencies.
See below for some recommendations on writing good help texts.
If you need more customization, read ahead. ;-)
## New item fields
This mod adds support for new fields of the item definition. They allow for
easy and quick manipulation of the item help entries. All fields are optional.
* `_doc_items_longdesc`: Long description
* `_doc_items_usagehelp`: Usage help
* `_doc_items_image`: Entry image (default: inventory image)
* `_doc_items_hidden`: Whether entry is hidden (default: `false` for air and hand, `true` for everything else)
* `_doc_items_create_entry`: Whether to create an entry for this item (default: `true`)
* `_doc_items_entry_name`: The title of the entry. By default, this is the same as the `description` field
of the item. This field is required if the `description` is empty
* `_doc_items_durability`: This field is for describing how long a tool can be used before it breaks. Choose one data type:
* It it is a `number`: Fixed number of uses before it breaks
* If it is a `string`: Free-form text which explains how the durability works. Try to keep it short and only use it if the other types won't work
A full explanation of these fields is provided below.
## Concepts
This section explains the core concepts of an item help entry in-depth.
### Factoids
Basically, a factoid is usually a single sentence telling the player a specific
fact about the item. The task of each factoid is to basically convert parts
of the item definition to useful, readable, understandable text.
Example: It's a fact that `default:sand` has the group `falling_node=1`.
A factoid for this is basically just a simple conditional which puts the
the sentence “This block is affected to gravity and can fall.” into the
text if the node is member of said group.
Factoids can be more complex than that. The factoid for node drops needs to
account for different drop types and probabilities, etc.
`doc_items` has many predefined factoids already. This includes all “special”
groups (like `falling_node`), drops, mining capabilities, punch interval,
and much more.
Custom factoids can be added with `doc.sub.items.register_factoid`.
The idea behind factoids is to generate as much information as possible
automatically to reduce redundancy, inconsistencies and the workload of hand-
written descriptions.
### Long description and usage help
Factoids are not always sufficient to describe an item. This is the case
for facts where the item definition can not be used to automatically
generate texts. Examples: Custom formspecs, ABMs, special tool action
on right-click.
That's where the long description and usage help comes into play.
Those are two texts which are written manually for a specific item.
Roughly, the long description is for describing **what** the item is, how it
acts, what it is for. The usage help is for explaining **how** the
item can be used. It is less important for standard mining tools and weapons.
There is no hard length limit for the long description and the usage help.
#### Recommendations for long description
The long description should roughly contain the following info:
* What the item does
* What it is good for
* How it may be generated in the world
* Maybe some background info if you're in a funny mood
* Notable information which doesn't fit elsewhere
The description should normally **not** contain:
* Information which is already covered by factoids, like digging groups,
damage, group memberships, etc.
* How the item can be used
* Direct information about other items
* Any other redundant information
* Crafting recipes
One exception from the rule may be for highlighting the most important
purpose of a simple item, like that coal lumps are primarily used as fuel.
Sometimes, a long description is not necessary because the item is already
exhaustively explained by factoids.
For very simple items, consider using one of the template texts (see below).
Minimal style guide: Use complete sentences.
#### Recommendations for usage help
The usage help should only be set for items which are in some way special
in their usage. Standard tools and weapons should never have an usage help.
The rule of thumb is this: If a new player who already knows the Minetest
basics, but not this item, will not directly know how to use this item,
then the usage help should be added. If basic Minetest knowledge or
existing factoids are completely sufficient, usage help should not be added.
The recommendations for what not to put into the usage help is the same
as for long descriptions.
#### Template texts
For your convenience, a few template texts are provided for common texts
to avoid redundancy and to increase consistency for simple things. Read
`init.lua` to see the actual texts.
##### Long description
* `doc.sub.items.temp.build`: For building blocks like the brick block in Minetest Game
* `doc.sub.items.temp.deco`: For other decorational blocks.
* `doc.sub.items.temp.craftitem`: For items solely or almost solely used for crafting
##### Usage help
* `doc.sub.items.temp.eat`: For eatable items using the `on_use=minetest.item_eat(1)` idiom
* `doc.sub.items.temp.eat_bad`: Same as above, but eating them is considered a bad idea
* `doc.sub.items.temp.rotate_node`: For nodes with `on_place=minetest.rotate_node`,
explains placement and rotation
### Entry creation
By default, an entry for each item is added automatically, except for items
without a description (`description == nil`). This behaviour can be changed
on a per-item basis.
By setting the item definition's field `_doc_items_create_entry` to `true`
or `false`you can explicitly define whether this item should get its own
entry.
Suppressing an entry is useful for items which aren't supposed to be directly
seen or obtained by the player or if they are only used for technical
and/or internal purposes. Another possible reason to suppress an entry is
to scrub the entry list of lots of very similar related items where the
difference is too small to justify two separate entries (e.g.
burning furnace vs inactive furnace, because the gameplay mechanics are
identical for both).
### Hidden entries
Hidden entries are entries which are not visible in the list of entries. This
concept directly comes from the Documentation System. The entry will still be
created, it is just not selectable by normal means. Players might be able to
“unlock” an entry later. Refer to the API documentation of the Documentation
System to learn more.
By default, all entries are hidden except air and the hand.
To mark an entry as hidden, add the field `_doc_items_hidden=true` to its
item definition. To make sure an entry is never hidden, add
`_doc_items_hidden=false` instead (this rarely needs to be specified
explicitly).
### Hand and air
The mod adds some default help texts for the hand and the air which are
written in a way that they probably are true for most subgames out of the
box, but especially the hand help text is kept intentionally vague.
If you want to change these help texts or the entry names or other
attributes, just add `_doc_items_*` fields to the item definition, either
by re-defining or overwriting these items (e.g. with
`minetest.override_item`).
In the mod `doc_minetest_game`, the default hand help text is overwritten
to explain the hand in more detail, especially the hand behaviour in
Creative Mode.
## Functions
This is the reference of all available functions in this API.
### `doc.sub.items.register_factoid(category_id, factoid_type, factoid_generator)`
Add a custom factoid (see above) for the specified category.
* `category_id`: The help category for which the factoid applies:
* `"nodes"`: Blocks
* `"tools"`: Tools and weapons
* `"craftitems"`: Misc. items
* `nil`: All of the above
* `factoid_type`: Rough categorization of the factoid's content, used to
optimize the final text display. This currently determines where in the
entry text the factoid appears. Possible values:
* For all items:
* `"use"`: It's about using the item in some way (written right after the fixed usage help)
* `"groups"`: Group-related factoid (very vague)
* `"misc"`: Factoid doesn't fit anywhere else, is shown near the end
* For nodes only:
* `damage`: Related to player/mob damage or health
* `movement`: Related to player movement on, in or at node
* `sound`: Related to node sounds
* `gravity`: Related to gravity (e.g. falling node)
* `drop_destroy`: Related to node being destroyed or node dropping as an item
* `light`: Related to node light (luminance)
* `mining`: Related to mining
* `drops`: Related to node drops
* `factoid_generator`: A function which turns item definition into a string
(see blow)
#### `factoid_generator(itemstring, def)`
`itemstring` is the itemstring of the item to be documented, and `def` is the
complete item definition table (from Minetest).
This function must return a helpful string which turns a part of the item's
definition into an useful sentence or text. The text can contain newlines,
but it must not end with a newline.
This function must **always** return a string. If you don't want to add any text,
return the empty string.
Style guide: Try to use complete sentences and avoid too many newlines.
#### Example
This factoid will add the sentence “This block will extinguish nearby fire.”
to all blocks which are member of the group `puts_out_fire`.
doc.sub.items.register_factoid("nodes", "groups", function(itemstring, def)
if def.groups.puts_out_fire ~= nil then
return "This block will extinguish nearby fire."
else
return ""
end
end)
### `doc.sub.items.disable_core_factoid(factoid_name)`
This function removes a core (built-in) factoid entirely, its text will never be displayed in any
entry then.
#### Parameter
`factoid_name` chooses the factoid you want to disable. The following core factoids can be disabled:
* `"node_mining"`: Mining properties of nodes
* `"tool_capabilities"`: Tool capabilities such as digging times
* `"groups"`: Group memberships
* `"fuel"`: How long the item burns as a fuel and if there's a leftover
* `"itemstring"`: The itemstring
* `"drops"`: Node drops
* `"connects_to"`: Tells to which nodes the node connects to
* `"light"`: Light and transparency information for nodes
* `"drop_destroy"`: Information about when the node causes to create its “drop” and if it gets destroyed by flooding
* `"gravity"`: Factoid for `falling_node` group
* `"sounds"`: Infos about sound effects related to the item
* `"node_damage"`: Direct damage and drowning damage caused by nodes
* `"node_movement"`: Nodes affecting player movement
* `"liquid"`: Liquid-related infos of a node
* `"basics"`: Collection of many basic factoids: The custom help texts, pointability, collidability, range, stack size, `liquids_pointable`, “punches don't work as usual”. Be careful with this one!
#### Background
Normally, the core factoids are written in a very general-purpose style, so this function might
not be needed at all. But it might be useful for subgames and mods which radically break with
some of the underlying core assumptions in Minetest. For example, if your mod completely changes
the digging system, the help texts provided by `doc_items` are probably incorrect, so you can
disable `node_mining` and register a custom factoid as a replacement.
Please do not use this function lightly because it touches the very core of `doc_items`. Try to
understand a core factoid before you consider to disable it. If you think a core factoid is just
broken or buggy in general, please file a bug instead.
### `doc.sub.items.add_friendly_group_names(groupnames)`
Use this function so set some more readable group names to show them
in the formspec, since the internal group names are somewhat cryptic
to players.
`groupnames` is a table where the keys are the “internal” group names and
the values are the group names which will be actually shown in the
Documentation System.
***Note***: This function is mostly there to work around a problem in
Minetest as it does not support “friendly” group names, which means exposing
groups to an interface is not pretty. Therefore, this function may be
deprecated when Minetest supports such a thing.
### `doc.sub.items.get_group_name(internal_group_name)`
Returns the group name of the specified group as displayed by this mod.
If the setting `doc_items_friendly_group_names` is `true`, this might
return a “friendly” group name (see above). If no friendly group name
exists, `internal_group_name` is returned.
If `doc_items_friendly_group_names` is `false`, the argument is always
returned.
### `doc.sub.items.add_notable_groups(groupnames)`
Add a list of groups you think are notable enough to be mentioned in the
“This item belongs to the following groups: (…)” factoid. This factoid
is intended to give a quick rundown of misc. groups which don't fit
to other factoids, yet they are still somewhat relevant to gameplay.
`groupnames` is a table of group names you wish to add.
#### What groups should be added
What is “notable” is subjective, but there are some guidelines:
Do add a group if:
* It is used in an ABM
* It is used for a custom interaction with another item
* It is simple enough for the player to know an item is member of this group
* You want to refer to this group in help texts
* The “don'ts” below don't apply
Do not add a group if:
* It is *only* used for crafting, `connects_to`, mining times or damage groups
* A factoid covering this group already exists
* The group membership itself requires an explanation (consider writing a factoid instead)
* The group has no gameplay relevance
* Group rating is important to gameplay (consider writing a factoid instead)
Groups which are used for crafting or in the `connects_to` field of item
definitions are already automatically added to this factoid.
##### Examples for good additions
* A group where its members can be placed in bookshelves.
so this group meets the “custom interaction” criterion
* `water` in Minetest Game: Used for water nodes in the obsidian ABM
* `sand` in Minetest Game: Used for the cactus growth ABM, but also crafting.
Since it is not *only* used for crafting, it is OK to be added
##### Examples for bad additions
* `stick` in Minetest Game: This group appears in many crafting recipes and
has no other use. It is already added automatically
* A group in which members turn into obsidian when they touch water (ABM):
This group is not trivial and should be introduced in a factoid instead
* `cracky` in Min
* `dig_immediate`: This group is already covered by the default factoids of this
mod
## Dependencies
If you only add the custom fields to your items, you do *not* need to depend
on this mod. If you use anything else from this mod (e.g. a function), you
probably *do* need to depend (optionally or mandatorily) on this mod.

68
mods/HELP/doc/doc_items/README.md Normal file
View file

@ -0,0 +1,68 @@
# Item Help [`doc_items`] (Version 1.1.0)
## Description
Automatically generated help texts of blocks, tools, weapons, crafting
items and other items.
The goal is to tell the player as much about basically almost all items as
possible, making it very convenient to look up simple things.
The ultimate goal of this mod is that eventually all relevant items have
a complete in-game documentation so no item leaves you confused.
This mod is useful to learn the hard facts about practically all items, like
how much damage weapon XYZ deals or whether you can dig that block.
This mod does *not* give you long explanations about how to use certain
nontrivial things, like the furnace from Minetest Game. This info might be
provided by other mods and insert it into the help.
This mod provides 3 new help categories (using the
Documentation System [`doc`]):
* Blocks (e.g. dirt, stone, wooden stair)
* Tools and weapons (e.g. wooden pickaxe, steel sword, screwdriver)
* Misc. items (e.g. dye, stick, flour)
Entries are automatically added. The information in the entries is
mostly automatically generated. It contains information about a wide range
of topics:
* Blocks
* Physics
* Digging properties
* Drops (including probabilities)
* Liquid information
* Pointability
* Luminance
* Much more
* Tools and weapons
* Mining capabilities
* Damage
* Durability
* More
* All items
* Range
* Stack size
* Group memberships
* Other information added by mods
This mod also allows for mods to adding custom written description
and usage help texts in free-form and even custom automatically generated texts
for mod-specific information like flammability in Minetest Game. This is
one of the core features of this mod; the mod relies on other mods to
provide their custom help texts for a complete help.
If you find a particular item which is lacking an explanation on usage,
request the mod author to add `doc_items` support.
## API
This mod has an API so that modders can add their own custom help texts,
custom factoids (single pieces of information extracted from the
item definition) and more.
For example, if your mods have some complex items which need
explanation, this mod can help you in adding help texts for them.
Read `API.md` to learn more.
## License
Everything in this mod is licensed under the MIT License.

2
mods/HELP/doc/doc_items/depends.txt Normal file
View file

@ -0,0 +1,2 @@
doc
intllib?

1
mods/HELP/doc/doc_items/description.txt Normal file
View file

@ -0,0 +1 @@
Adds automatically generated help texts for items.

1406
mods/HELP/doc/doc_items/init.lua Normal file
View file

File diff suppressed because it is too large Load diff

140
mods/HELP/doc/doc_items/locale/de.txt Normal file
View file

@ -0,0 +1,140 @@
\sUsing it as fuel turns it into: @1. = \sWird dieser Gegenstand als Brennstoff verwendet, verwandelt er sich zu: @1.
@1 seconds = @1 Sekunden
# Item count times item name
@1×@2 = @1×@2
# Itemname (25%)
@1 (@2%) = @1 (@2%)
# Itemname (<0.5%)
@1 (<0.5%) = @1 (<0,5%)
# Itemname (ca. 25%)
@1 (ca. @2%) = @1 (ca. @2%)
# List separator (e.g. “one, two, three”)
,\s = ,\s
# Final list separator (e.g. “One, two and three”)
\sand\s = \sund\s
1 second = 1 Sekunde
A transparent block, basically empty space. It is usually left behind after digging something. = Ein transparenter Block, praktisch leerer Raum. Er wird üblicherweise hinterlassen, nachdem man etwas ausgegraben hat.
Air = Luft
Blocks = Blöcke
Building another block at this block will place it inside and replace it. = Wird ein anderer Block an diesem Block gebaut, wird dieser andere Block seine Stelle einnehmen.
Building this block is completely silent. = Das Bauen dieses Blocks ist völlig lautlos.
Collidable: @1 = Kollidiert: @1
Description: @1 = Beschreibung: @1
Falling blocks can go through this block; they destroy it when doing so. = Fallende Blöcke können diesen Block durchdringen; sie zerstören ihn dabei.
Full punch interval: @1 s = Schlagintervall: @1 s
Hand = Hand
Hold it in your hand, then leftclick to eat it. = Halten Sie es in Ihrer Hand, dann klicken Sie mit der linken Maustaste, um es zu essen.
Hold it in your hand, then leftclick to eat it. But why would you want to do this? = Halten Sie es in Ihrer Hand, dann klicken Sie mit der linken Maustaste, um es zu essen. Aber warum sollten Sie das tun wollen?
Item reference of all wieldable tools and weapons = Gegenstandsreferenz aller tragbaren Werkzeugen und Waffen
Item reference of blocks and other things which are capable of occupying space = Gegenstandsreferenz aller Blöcke und anderen Dingen, die Raum belegen
Item reference of items which are neither blocks, tools or weapons (esp. crafting items) = Gegenstandsreferenz aller Gegenstände, welche weder Blöcke, Werkzeuge oder Waffen sind (insb. Fertigungsgegenstände)
Liquids can flow into this block and destroy it. = Flüssigkeiten können in diesen Block hereinfließen und ihn zerstören.
Maximum stack size: @1 = Maximale Stapelgröße: @1
Mining level: @1 = Grabestufe: @1
Mining ratings: = Grabewertungen:
• @1, rating @2: @3 s - @4 s = • @1, Wertung @2: @3 s - @4 s
• @1, rating @2: @3 s = • @1, Wertung @2: @3 s
Mining times: = Grabezeiten:
Mining this block is completely silent. = Das Abbauen dieses Blocks ist völlig lautlos.
Miscellaneous items = Sonstige Gegenstände
No = Nein
Pointable: No = Zeigbar: Nein
Pointable: Only by special items = Zeigbar: Nur von besonderen Gegenständen
Pointable: Yes = Zeigbar: Ja
Punches with this block don't work as usual; melee combat and mining are either not possible or work differently. = Schläge mit diesem Block funktionieren nicht auf die übliche Weise; Nahkampf und Graben sind damit entweder nicht möglich oder funktionieren auf andere Weise.
Punches with this item don't work as usual; melee combat and mining are either not possible or work differently. = Schläge mit diesem Gegenstand funktionieren nicht auf die übliche Weise; Nahkampf und Graben sind damit entweder nicht möglich oder funktionieren auf andere Weise.
Punches with this tool don't work as usual; melee combat and mining are either not possible or work differently. = Schläge mit diesem Werkzeug funktionieren nicht auf die übliche Weise; Nahkampf und Graben sind damit entweder nicht möglich oder funktionieren auf andere Weise.
Range: @1 = Reichweite: @1
# Range: <Hand> (<Range>)
Range: @1 (@2) = Reichweite: @1 (@2)
Range: 4 = Reichweite: 4
# Rating used for digging times
Rating @1 = Wertung @1
Rating @1-@2 = Wertung @1-@2
The fall damage on this block is increased by @1%. = Der Fallschaden auf diesem Block ist um @1% erhöht.
The fall damage on this block is reduced by @1%. = Der Fallschaden auf diesem Block ist um @1% reduziert.
This block allows light to propagate with a small loss of brightness, and sunlight can even go through losslessly. = Dieser Block ist lichtdurchlässig mit einen geringfügigen Helligkeitsverlust; Sonnenlicht passiert jedoch ohne Verlust.
This block allows light to propagate with a small loss of brightness. = Dieser Block ist lichtdurchlässig mit einen geringfügigen Helligkeitsverlust.
This block allows sunlight to propagate without loss in brightness. = Dieser Block ist vollkommen durchlässig für Sonnenlicht.
This block belongs to the @1 group. = Dieser Block gehört zur Gruppe »@1«.
This block belongs to these groups: @1. = Dieser Block gehört zu den folgenden Gruppen: @1.
This block can be climbed. = Dieser Block kann beklettert werden.
This block can be destroyed by any mining tool immediately. = Dieser Block kann von einem beliebigen Grabewerkzeug sofort zerstört werden.
This block can be destroyed by any mining tool in half a second. = Dieser Block kann von einem beliebigen Grabewerkzeug in einer halben Sekunde zerstört werden.
This block can be mined by any mining tool immediately. = Dieser Block kann von einem beliebigen Grabewerkzeug sofort abgebaut werden.
This block can be mined by any mining tool in half a second. = Dieser Block kann von einem beliebigen Grabewerkzeug in einer halben Sekunde abgebaut werden.
This block can be mined by mining tools which match any of the following mining ratings and its toughness level. = Dieser Block kann von Grabewerkzeugen abgebaut werden, falls sie auf eine der folgenden Grabewertungen sowie seinem Härtegrad passen.
This block can not be destroyed by ordinary mining tools. = Dieser Block kann nicht von Grabewerkzeugen zerstört werden.
This block can not be mined by ordinary mining tools. = Dieser Block kann nicht von gewöhnlichen Grabewerkzeugen abgebaut werden.
This block can serve as a smelting fuel with a burning time of @1. = Dieser Block kann als Brennstoff mit einer Brenndauer von @1 dienen.
This block causes a damage of @1 hit point per second. = Dieser Block richtet einen Schaden von @1 Trefferpunkt pro Sekunde an.
This block causes a damage of @1 hit points per second. = Dieser Block richtet einen Schaden von @1 Trefferpunkten pro Sekunde an.
This block connects to blocks of the @1 group. = Dieser Block verbindet sich mit Blöcken der Gruppe »@1«.
This block connects to blocks of the following groups: @1. = Dieser Block verbindet sich mit Blöcken der folgenden Gruppen: @1.
This block connects to these blocks: @1. = Dieser Block verbindet sich mit den folgenden Blöcken: @1.
This block connects to this block: @1. = Dieser Block verbindet sich mit diesem Block: @1.
This block decreases your breath and causes a drowning damage of @1 hit point every 2 seconds. = Dieser Block reduziert Ihren Atem und verursacht beim Ertrinken einen Schaden von @1 Trefferpunkt alle 2 Sekunden.
This block decreases your breath and causes a drowning damage of @1 hit points every 2 seconds. = Dieser Block reduziert Ihren Atem und verursacht beim Ertrinken einen Schaden von @1 Trefferpunkten alle 2 Sekunden.
This block glows faintly. It is barely noticable. = Dieser Block leuchtet schwach. Es ist kaum merklich.
This block is a light source with a light level of @1. = Dieser Block ist eine Lichtquelle mit einer Helligkeitsstufe von @1.
This block glows faintly with a light level of @1. = Dieser Block leuchtet schwach mit einer Helligkeitsstufe von @1.
This block is a building block for creating various buildings. = Dieser Block ist für den Bau diverser Gebäude vorgesehen.
This block is a liquid with these properties: = Dieser Block ist eine Flüssigkeit mit folgenden Eigenschaften:
This block is affected by gravity and can fall. = Dieser Block wird von der Schwerkraft beeinflusst und kann fallen.
This block is completely silent when mined or built. = Dieser Block kann vollkommen lautlos gebaut oder abgebaut werden.
This block is completely silent when walked on, mined or built. = Es ist vollkommen lautlos, wenn man auf diesen Block geht, ihn baut oder abbaut.
This block is destroyed when a falling block ends up inside it. = Dieser Block wird zerstört, wenn ein fallender Block in ihm landet.
This block negates all fall damage. = Auf diesem Block gibt es keinen Fallschaden.
This block points to liquids. = Mit diesem Block zeigt man auf Flüssigkeiten.
This block will drop as an item when a falling block ends up inside it. = Dieser Block wird sich als Gegenstand abwerfen, wenn ein fallender Block in ihn landet.
This block will drop as an item when it is not attached to a surrounding block. = Dieser Block wird sich als Gegenstand abwerfen, wenn er nicht an einen benachbarten Block befestigt ist.
This block will drop as an item when no collidable block is below it. = Dieser Block wird sich als Gegenstand abwerfen, wenn kein kollidierender Block unter ihn liegt.
This block will drop the following items when mined: %s. = Dieser Block wird nach dem Abbauen die folgenden Gegenstände abwerfen: %s.
This block will drop the following when mined: @1×@2. = Dieser Block wird nach dem Abbauen folgendes abwerfen: @1×@2.
This block will drop the following when mined: @1. = Dieser Block wird nach dem Abbauen folgendes abwerfen: @1.
This block will drop the following when mined: %s. = Dieser Block wird nach dem Abbauen folgendes abwerfen: %s.
This block will make you bounce off with an elasticity of @1%. = Dieser Block wird Sie mit einer Elastizität von @1% abprallen lassen.
This block will randomly drop one of the following when mined: %s. = Dieser Block wird nach dem Abbauen zufällig eines von den folgenden Dingen abwerfen: %s.
This block will randomly drop up to %d drops of the following possible drops when mined: %s. = Dieser Block nach dem Abbauen wird zufällig bis zu %d Abwürfe von den folgenden möglichen Abwürfen abwerfen: %s.
This block won't drop anything when mined. = Dieser Block wird nach dem Abbauen nichts abwerfen.
This is a decorational block. = Dieser Block dient zur Dekoration.
This is a melee weapon which deals damage by punching. = Dies ist eine Nahkampfwaffe, welche Schaden durch Schläge verursacht.
Maximum damage per hit: = Maximaler Schaden pro Treffer:
This item belongs to the @1 group. = Dieser Gegenstand gehört zur Gruppe »@1«.
This item belongs to these groups: @1. = Dieser Gegenstand gehört zu den folgenden Gruppen: @1.
This item can serve as a smelting fuel with a burning time of @1. = Dieser Gegenstand kann als Brennstoff mit einer Brenndauer von @1 dienen.
This item is primarily used for crafting other items. = Dieser Gegenstand wird primär für die Fertigung von anderen Gegenständen benutzt.
This item points to liquids. = Mit diesem Gegenstand zeigt man auf Flüssigkeiten.
This tool belongs to the @1 group. = Dieses Werkzeug gehört zur Gruppe »@1«.
This tool belongs to these groups: @1. = Dieses Werkzeug gehört zu den folgenden Gruppen: @1.
This tool can serve as a smelting fuel with a burning time of @1. = Dieses Werkzeug kann als Brennstoff mit einer Brenndauer von @1 dienen.
This tool is capable of mining. = Dies ist ein Grabewerkzeug.
Maximum toughness levels: = Maximale Härtegrade:
This tool points to liquids. = Mit diesem Werkzeug zeigt man auf Flüssigkeiten.
Tools and weapons = Werkzeuge und Waffen
Unknown Node = Unbekannter Node
Usage help: @1 = Benutzung: @1
Walking on this block is completely silent. = Auf diesem Block sind Schritte lautlos.
Whenever you are not wielding any item, you use the hand which acts as a tool with its own capabilities. When you are wielding an item which is not a mining tool or a weapon it will behave as if it would be the hand. = Wenn Sie keinen Gegenstand halten, benutzen Sie die Hand, welches als ein Werkzeug mit seinen eigenen Fägihkeiten dient. Wenn Sie einen Gegenstand halten, der kein Grabewerkzeug oder eine Waffe ist, wird er sich verhalten als wäre er die Hand.
Yes = Ja
You can not jump while standing on this block. = Man kann von diesem Block nicht abspringen.
any level = beliebige Stufe
level 0 = Stufe 0
level 0-@1 = Stufen 0-@1
unknown = unbekannt
Unknown item (@1) = Unbekannter Gegenstand (@1)
• @1: @2 = • @1: @2
• @1: @2 HP = • @1: @2 TP
• @1: @2, @3 = • @1: @2, @3
• Flowing range: @1 = • Fließweite: @1
• No flowing = • Kein Fließen
• Not renewable = • Nicht erneuerbar
• Renewable = • Erneuerbar
• Viscosity: @1 = • Zähflüssigkeit: @1
Itemstring: "@1" = Itemstring: »@1«
Durability: @1 uses = Haltbarkeit: @1 Benutzungen
Durability: @1 = Haltbarkeit: @1
Mining durability: = Grabehaltbarkeit:
• @1, level @2: @3 uses = • @1, Stufe @2: @3 Benutzungen
• @1, level @2: Unlimited = • @1, Stufe @2: Unbegrenzt
This block's rotation is affected by the way you place it: Place it on the floor or ceiling for a vertical orientation; place it at the side for a horizontal orientation. Sneaking while placing it leads to a perpendicular orientation instead. = Die Rotation dieses Blocks hängt davon ab, wie sie ihn platzieren: Platzieren Sie ihn auf den Boden oder an die Decke, um ihn vertikal aufzustellen; platzieren Sie in an der Seite für eine horizontale Ausrichtung. Wenn Sie während des Bauens schleichen, wird der Block stattdessen senkrecht zur üblichen Ausrichtung rotiert.

140
mods/HELP/doc/doc_items/locale/template.txt Normal file
View file

@ -0,0 +1,140 @@
\sUsing it as fuel turns it into: @1. =
@1 seconds =
# Item count times item name
%@1×@2 =
# Itemname (25%)
@1 (@2%) =
# Itemname (<0.5%)
@1 (<0.5%) =
# Itemname (ca. 25%)
@1 (ca. @2%) =
# List separator (e.g. “one, two, three”)
,\s =
# Final list separator (e.g. “One, two and three”)
\sand\s =
1 second =
A transparent block, basically empty space. It is usually left behind after digging something. =
Air =
Blocks =
Building another block at this block will place it inside and replace it. =
Building this block is completely silent. =
Collidable: @1 =
Description: @1 =
Falling blocks can go through this block; they destroy it when doing so. =
Full punch interval: @1 s =
Hand =
Hold it in your hand, then leftclick to eat it. =
Hold it in your hand, then leftclick to eat it. But why would you want to do this? =
Item reference of all wieldable tools and weapons =
Item reference of blocks and other things which are capable of occupying space =
Item reference of items which are neither blocks, tools or weapons (esp. crafting items) =
Liquids can flow into this block and destroy it. =
Maximum stack size: @1 =
Mining level: @1 =
Mining ratings: =
• @1, rating @2: @3 s - @4 s =
• @1, rating @2: @3 s =
Mining times: =
Mining this block is completely silent. =
Miscellaneous items =
No =
Pointable: No =
Pointable: Only by special items =
Pointable: Yes =
Punches with this block don't work as usual; melee combat and mining are either not possible or work differently. =
Punches with this item don't work as usual; melee combat and mining are either not possible or work differently. =
Punches with this tool don't work as usual; melee combat and mining are either not possible or work differently. =
Range: @1 =
# Range: <Hand> (<Range>)
Range: @1 (@2) =
Range: 4 =
# Rating used for digging times
Rating @1 =
# @1 is minimal rating, @2 is maximum rating
Rating @1-@2 =
The fall damage on this block is increased by @1%. =
The fall damage on this block is reduced by @1%. =
This block allows light to propagate with a small loss of brightness, and sunlight can even go through losslessly. =
This block allows light to propagate with a small loss of brightness. =
This block allows sunlight to propagate without loss in brightness. =
This block belongs to the @1 group. =
This block belongs to these groups: @1. =
This block can be climbed. =
This block can be destroyed by any mining tool immediately. =
This block can be destroyed by any mining tool in half a second. =
This block can be mined by any mining tool immediately. =
This block can be mined by any mining tool in half a second. =
This block can be mined by mining tools which match any of the following mining ratings and its toughness level. =
This block can not be destroyed by ordinary mining tools. =
This block can not be mined by ordinary mining tools. =
This block can serve as a smelting fuel with a burning time of @1. =
This block causes a damage of @1 hit point per second. =
This block causes a damage of @1 hit points per second. =
This block connects to blocks of the @1 group. =
This block connects to blocks of the following groups: @1. =
This block connects to these blocks: @1. =
This block connects to this block: @1. =
This block decreases your breath and causes a drowning damage of @1 hit point every 2 seconds. =
This block decreases your breath and causes a drowning damage of @1 hit points every 2 seconds. =
This block is a light source with a light level of @1. =
This block glows faintly with a light level of @1. =
This block is a building block for creating various buildings. =
This block is a liquid with these properties: =
This block is affected by gravity and can fall. =
This block is completely silent when mined or built. =
This block is completely silent when walked on, mined or built. =
This block is destroyed when a falling block ends up inside it. =
This block negates all fall damage. =
This block points to liquids. =
This block will drop as an item when a falling block ends up inside it. =
This block will drop as an item when it is not attached to a surrounding block. =
This block will drop as an item when no collidable block is below it. =
This block will drop the following items when mined: %s. =
This block will drop the following when mined: @1×@2. =
This block will drop the following when mined: @1. =
This block will drop the following when mined: %s. =
This block will make you bounce off with an elasticity of @1%. =
This block will randomly drop one of the following when mined: %s. =
This block will randomly drop up to %d drops of the following possible drops when mined: %s. =
This block won't drop anything when mined. =
This is a decorational block. =
This is a melee weapon which deals damage by punching. =
Maximum damage per hit: =
This item belongs to the @1 group. =
This item belongs to these groups: @1. =
This item can serve as a smelting fuel with a burning time of @1. =
This item is primarily used for crafting other items. =
This item points to liquids. =
This tool belongs to the @1 group. =
This tool belongs to these groups: @1. =
This tool can serve as a smelting fuel with a burning time of @1. =
This tool is capable of mining. =
Maximum toughness levels: =
This tool points to liquids. =
Tools and weapons =
Unknown Node =
Usage help: @1 =
Walking on this block is completely silent. =
Whenever you are not wielding any item, you use the hand which acts as a tool with its own capabilities. When you are wielding an item which is not a mining tool or a weapon it will behave as if it would be the hand. =
Yes =
You can not jump while standing on this block. =
any level =
level 0 =
level 0-@1 =
unknown =
Unknown item (@1) =
• @1: @2 =
• @1: @2 HP =
• @1: @2, @3 =
• Flowing range: @1 =
• No flowing =
• Not renewable =
• Renewable =
• Viscosity: @1 =
Itemstring: "@1" =
Durability: @1 uses =
Durability: @1 =
Mining durability: =
• @1, level @2: @3 uses =
• @1, level @2: Unlimited =
This block's rotation is affected by the way you place it: Place it on the floor or ceiling for a vertical orientation; place it at the side for a horizontal orientation. Sneaking while placing it leads to a perpendicular orientation instead. =

1
mods/HELP/doc/doc_items/mod.conf Normal file
View file

@ -0,0 +1 @@
name = doc_items

BIN
mods/HELP/doc/doc_items/screenshot.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 15 KiB

16
mods/HELP/doc/doc_items/settingtypes.txt Normal file
View file

@ -0,0 +1,16 @@
#This feature is experimental!
#If enabled, the mod will show alternative group names which are a bit
#more readable than the internally used (but canonical) group names. For
#example, the group “wood” may be rendered as “Wood”, “leaves” as
#“Leaves and Needles”, “oddly_breakable_by_hand” as “Hand-breakable”,
#and so on. Note that these alternative names are only used for better
#understanding, they are not official.
#This feature might be removed in later versions if it becomes obsolete.
doc_items_friendly_group_names (Show “friendly” group names) bool false
#If enabled, the mod will show the itemstring of the entry for each item to
#all players. If disabled, the itemstring will only be shown to players
#with the “give” or “debug” privilege.
#The itemstring is useful to power users and programmers and
#is used e.g. for the /give and /giveme commands.
doc_items_show_itemstrings (Show itemstrings) bool false