Remove “(WIP)”
[minetest_doc_basics.git] / init.lua
blob77fe6c71f095b8ebecb4d2f3d2d8debfd9d14dc0
1 doc.new_category("basics",
3 name="Basics",
4 description = "Everything you need to know about Minetest to get started with playing",
5 sorting = "custom",
6 sorting_data = {"minetest", "controls", "sneak", "cam", "minimap", "players", "inventory", "hotbar", "tools", "blocks", "liquids", "craft", "cook", "groups", "settings","glossary", "online"},
7 build_formspec = doc.entry_builders.text_and_gallery,
8 })
10 doc.new_category("online",
12 name="Online multiplayer",
13 description = "Help about playing online with other players",
14 sorting = "custom",
15 sorting_data = {"intro", "commands", "privs"},
16 build_formspec = doc.entry_builders.text,
19 doc.new_entry("basics", "minetest", {
20 name="Minetest",
21 data = {
22 text =
23 [=[Minetest is a free software game engine to create various games based on voxel gameplay, inspired by InfiniMiner, Minecraft, and the like. Minetest was originally created by Perttu Ahola (alias “celeron55”).
25 The basic idea of each game is always the same: The player is thrown into a huge world made out of cubes/blocks. Most of the time, these cubes make the landscape and these blocks can be removed and placed almost entirely freely. Using the collected items, new tools and other items can be crafted. Games (“subgames” in Minetest terms) in Minetest can, however, be much more complex than this.
27 A core concept of Minetest is a built-in modding capability, based on the Lua programming language. Mods allow one or more certain aspects of an existing game to be modified. Minetest mods can be as simple as adding a few decorational blocks or very complex by (for example) introducing complex new gameplay concepts or generating a completely different kind of world, and many other things. For the player, using a new mod requires to copy or extract some files into a certain location and pressing some buttons in Minetest's interface.
29 Minetest can be played alone or online together with multiple players. When playing online, from the player perspective all mods will work out of the box with no need for additional tools as they are entirely provided by the server.
31 Minetest is usually bundled with a simple default game, named “Minetest Game” (shown in images 1 and 2). You probably already have it. Other games for Minetest can be downloaded from the official Minetest forums <https://forum.minetest.net/viewforum.php?f=48>.
33 Minetest as well as Minetest Game are both unfinished at the moment, so please forgive us when not everything works out perfectly.]=],
34 images = {{image="doc_basics_gameplay_mtg_1.png"}, {image="doc_basics_gameplay_mtg_2.png"}, {image="doc_basics_gameplay_carbone_ng.png"}, {image="doc_basics_gameplay_lott.png"}, {image="doc_basics_gameplay_pixture.png"}, {image="doc_basics_gameplay_outback.png"}, {image="doc_basics_gameplay_moontest.png"},
35 {image="doc_basics_gameplay_hades.png"}, {image="doc_basics_gameplay_xtraores_xtension.png"},}
36 }})
38 doc.new_entry("basics", "sneak", {
39 name="Sneaking",
40 data = { text =
41 [=[Sneaking is a special move. As long as you sneak, you walk slower, but you are guaranteed to not accidentally fall off the edge of a block. This also allows you to “lean over” in a sense.
42 To sneak, keep the sneak key pressed. As soon as you release the sneak key, you walk at normal speed again. Be careful not releasing the sneak key when you are at a ledge, you might fall!
44 • Sneak: [Shift]
46 Keep in mind that the [Shift] key is used for a large number of other things in Minetest. Sneaking only works when you are not in a liquid, stand on solid ground and are not at a ladder.
48 If you jump while holding the sneak key, you also jump slightly higher than usual.
50 Note that in some subgames, sneaking might be disabled. If this is the case, you still walk slower by sneaking, but you will no longer be prevented from falling off ledges.]=],
51 images = { { image = "doc_basics_sneak.png" } },
52 }})
54 doc.new_entry("basics", "controls", {
55 name="Controls",
56 data = { text = [=[This entry lists all default controls in Minetest:
58 Basic movement:
59 • Moving the mouse around: Look around
60 • W: Move forwards
61 • A: Move to the left
62 • D: Move to the right
63 • S: Move backwards
65 While standing on solid ground:
66 • Space: Jump
67 • Shift: Sneak (You walk slower and can't fall over the edge of a block)
69 While on a ladder, swimming in a liquid or fly mode is active
70 • Space: Move up
71 • Shift: Move down
73 Extended movement (requires privileges):
74 • J: Toggle fast mode, makes you run or fly fast (requires “fast” privilege)
75 • K: Toggle fly mode, makes you move freely in all directions (requires “fly” privilege)
76 • H: Toggle noclip mode, makes you go through walls in fly mode (requires “noclip” privilege)
77 • E: Walk fast in fast mode
79 World interaction:
80 • Left mouse button: Punch, mine blocks or collect dropped items
81 • Right mouse button: Use pointed block if applicable (e.g. open chest); build blocks otherwise
82 • Shift+Right mouse button: Build blocks without using pointed block
83 • Roll mouse wheel: Select next/previous item in hotbar
84 • 0-9: Select item in hotbar directly
85 • Q: Drop entire wielded item stack
86 • Shift+Q: Drop single item of wielded item stack
87 • I: Show/hide inventory menu
89 Inventory interaction:
90 See the entry “Inventory”.
92 Interface:
93 • Esc: In the game: Opens menu window (pauses in single-player mode) or close current window. In the main menu: Quit Minetest.
94 • F1: Show/hide HUD
95 • F2: Show/hide chat and the “Minetest” text at the top left
96 • F7: Toggle camera mode
97 • F8: Toggle cinematic mode
98 • F9: Toggle minimap, minimap mode and zoom
99 • Shift+F9: Toggle minimap shape (square or circle)
100 • F10: open/close console/chat log
101 • F12: Take a screenshot (as a PNG image)
103 Server interaction:
104 • T: Open chat window (You require the “shout” privilege to chat.)
105 • /: Start issuing a server command
107 Technical:
108 • R: Toggle far view (disables all fog and allows viewing far away, may cause massive FPS drop)
109 • + (numpad)**: Increase minimal viewing distance
110 • - (numpad)**: Decrease minimal viewing distance
111 • F3: Enable/disable fog
112 • F5: Enable/disable debug screen which also shows your coordinates
113 • F6: Only useful for developers. Enables/disables profiler
114 • P: Only useful for developers. Writes current stack traces]=]
117 doc.new_entry("basics", "players", {
118 name="Players",
119 data = {
120 text =
121 [=[Players (actually: “player characters”) are the characters which user control.
123 Players are living beings which occupy a space of roughly 1×2×1 cubes and start with 20 health points and 10 breath points.
124 Players are capable of walking, sneaking, jumping, climbing ladders, swimming, diving, mining, building, fighting and using tools and blocks.
126 Players can take damage for a variety of reasons, here are some:
127 • Taking fall damage
128 • Touching a block which causes direct damage
129 • Drowning
130 • Being attacked by another player
131 • Being attacked by a computer enemy
133 At a health of 0, the player dies after which the player can just respawn in the world, usually somewhere else.
134 Other consequences of death vary wildly between subgame. The player could lose all items, or lose the round in a competitive game.
136 Breath is reduced for being with the head inside some block which causes drowning damage (usually liquids, but really any block cause this). Such blocks reduce the breath by 1 for every 2 seconds and start to cause damage every 2 seconds when the player has lost all breath. When being inside any other block, the breath is quickly restored.
138 Damage can be disabled on any world. Without damage, players are basically immortal. Health and breath don't play a role anymore and are hidden.
140 In online multiplayer, the name of other players is written above their head.]=],
141 images = {{image="doc_basics_players_sam.png"}, {image="doc_basics_players_lott.png"}, {image="doc_basics_players_flat.png"}},
144 doc.new_entry("basics", "tools", {
145 name="Tools and weapons",
146 data = { text =
147 [=[Some items may serve as a tool, melee weapon or both when wielded.
149 Any item which has some special use which can be directly used by its wielder is considered a tool.
151 A common tool in Minetest are, of course, mining tools. These are important to break all kinds of blocks.
153 Other tools with special uses (usually accessed by punching or right-click) may also be introduced.
155 Melee weapons deal damage by punching players and possibly other animate objects.
157 For melee weapons, another attribute is important: The full punch interval. This is basically the time it takes for completely recovering from a punch with this weapon.
158 A melee weapon only deals its full damage when it has completely recovered. This can be seen by the animation of the wielded item. As long it is still moving, the full punch interval is not over yet. The full punch interval does not limit how fast one can deal punches, it rather limits the damage: Any hit done before the end of a full punch interval will deal reduced damage.
160 When nothing is wielded, players use their hand which may or may not act as mining tool and melee weapon (depending on the subgame). The hand is always capable of collecting dropped items simply by punching them.]=],
161 images = {{image="doc_basics_tools.png"}, {image="doc_basics_tools_mining.png"}},
166 doc.new_entry("basics", "cam", {
167 name="Camera",
168 data = {
169 text =
170 [=[Minetest has 3 different views which determine the way you see the world. The modes are:
172 • First-person view (default)
173 • Third-person view from behind
174 • Third-person view from the front
176 You can change the camera mode by pressing [F7] (but you have to close this window first).
178 There is also Cinematic Mode which can be toggled with [F8]. Normally, the camera moves instantly as you move your mouse around. With Cinematic Mode enabled, the camera movements become more smooth. Some players don't like it, it is a matter of taste.
180 • Switch camera mode: [F7]
181 • Toggle Cinematic Mode: [F8]]=],
182 images = {{image="doc_basics_camera_ego.png"}, {image="doc_basics_camera_behind.png"}, {image="doc_basics_camera_front.png"}}
185 doc.new_entry("basics", "blocks", {
186 name="Blocks",
187 data = {
188 text =
189 [=[The world of Minetest is made entirely out of blocks, or voxels, to be precise. Blocks can be added or removed with the correct tools.
191 Blocks can have a wide range of different properties which determine mining times, behavior, looks, shape, and much more. These are the most important attributes:
193 • Collidability: With collidable blocks block the way for players and other things, they cannot be passed through and they are walked upon by players. Non-collidable blocks can be passed through freely.
194 • Pointability: Pointable blocks will show a wireframe or a halo box when you point at them. But you will just point through non-pointable blocks as if they were not there. Liquids are usually non-pointable but they can be pointed at by some special tools.
195 • Mining properties: Mining properties determine by which tool a block can be mined (if at all).
196 • Climbability: While you are at a climbable block, you won't fall and you can climb and decent on it with the jump and sneak keys. Ladders are one example.
197 • Group memberships: Blocks may be a member of any number of groups. Groups are used to group similar items and blocks together. Most importantly, group memberships are used for mining. They are also used for many other purposes like crafting or interactions between blocks.
198 • Drowning damage: See the entry “Basics > Player”.
199 • Liquids: See the entry “Basics > Liquids”.]=],
202 doc.new_entry("basics", "liquids", {
203 name = "Liquids",
204 data = {
205 text =
206 [=[Liquids are special dynamic blocks. Liquids like to spread and flow to their surrounding blocks. Players can swim and drown in them.
208 Liquids usually come in two forms: In source form (S) and in flowing form (F).
209 Liquid sources have the shape of a full cube. A liquid source will generate flowing liquids around it from time to time, and, if the liquid is renewable, it also generates liquid sources. A liquid source can sustain itself. If no special event happens, a liquid source will keep its place forever and it will never drain out.
210 Flowing liquids take a sloped form. Flowing liquids spread around the map until they drain. A flowing liquid can not sustain itself and always comes from a liquid source, either directly or indirectly. Without a liquid source, a flowing liquid will eventually drain out and disappear.
212 All liquids share the following properties:
213 • All properties of blocks (including drowning damage)
214 • Renewability: Renewable liquids can create new sources (see below)
215 • Flowing range: How many flowing liquids are created at maximum per liquid source, it determines how far the liquid will “spread”, ranges from 0 to 8. If 0, no flowing liquids are generated at all.
216 • Viscosity: How slow players move through it and how fast new flowing liquids are created (i.e. how fast the liquid spreads)
218 Renewable liquids create new liquid sources at open spaces. A new liquid source is created when:
219 • Two renewable liquid blocks of the same type touch each other diagonally
220 • These blocks are also on the same height
221 • One of the two “corners” is open space which allows liquids to flow in
223 When those criteria are met, the open space is filled with a new liquid source of the same type.
225 Swimming in a liquid is fairly straightforward: The usual direction keys for basic movement, the jump key for rising and the sneak key for sinking.
227 The physics for swimming and diving in a liquid are:
228 • The higher the viscosity, the slower your movement speed
229 • If you don't do anything, you will slowly sink
230 • There is no fall damage for falling into a liquid as such
231 • If you fall into a liquid, you will be slowed down on impact (but don't come instantly to a halt). The faster you fell, the deeper you'll get. The slow-down effect is much stronger for liquids with a high viscosity. For a safe high drop into a liquid, make sure there is enough liquid above the ground, otherwise you might hit the ground and take fall damage
233 Liquids are usually not pointable. However, all liquids can be pointed by special items.]=],
234 images = {
235 { image="doc_basics_liquids_types.png",
236 caption="A source liquid and its flowing liquids" },
237 { image="doc_basics_liquids_renewable_1.png",
238 caption="Renewable liquids need to be arranged like this to create a new source block" },
239 { image="doc_basics_liquids_renewable_2.png",
240 caption="A new liquid source is born" },
241 { image="doc_basics_liquids_nonrenewable.png",
242 caption="Non-renewable liquids creates a flowing liquid (F) instead" },
243 { image="doc_basics_liquids_range.png",
244 caption="Liquid with a flowing range of 2" },
249 doc.new_entry("basics", "craft", {
250 name = "Crafting",
251 data = {
252 text =
253 [=[Crafting is the task of taking several items and combining them to form a new item. Crafting is another important task in Minetest.
255 To craft something, you need a few items and a so-called crafting grid (C). A crafting grid behaves like a normal inventory, with the addition that it can be used for crafting. In order to craft, items need to be put in a certain pattern into the crafting grid. Next to the crafting grid is an output slot (O), in which the result of a craft appears when you placed items in a valid arrangement. Note this is initially just a preview.
257 To complete the craft, take the result item from the output slot (like you would take items from other inventory slots), which will consume items from the crafting grid and creates a new item. It is not possible to place items into the output slot directly.
259 The description on how to craft a particular item is called a “crafting recipe”. In order to craft, you have to know some crafting recipes beforehand. One way is by using a crafting guide, which contains a list of available crafting recipes. Some subgames provide such crafting guides. There are also some mods which you can download online for installing a crafting guide.
261 Crafting recipes consist of at least one input item and exactly one stack of output items. When performing a single craft, it will consume exactly one item from each stack of the crafting grid, unless the crafting recipe defines replacements.
263 There are multiple kinds of crafting recipes: Shaped, shapeless, cooking and repairing.
265 • Shaped recipe (image 2): Items need to be placed in a particular shape
266 • Shapeless recipe (images 4 and 5): Items need to be placed in the crafting grid, but their positions don't matter (the images show the same recipe)
267 • Cooking: Explained in “Basics > Cooking”
268 • Repairing (image 6): Place two damaged tools of the same kind into the crafting grid anywhere, which gives you a new tool which is repaired by a certain percentage. This recipe may not be available in all subgames
270 In some crafting recipes, some or all input item do not need to be a concrete item, instead it needs to be a member of a particular group (see “Basics > Groups”). Such recipes offer a bit more freedom in the input items. Images 7 and 8 show a group-based recipe. Here, 8 items of the “stone” group are required, which is true for all of the shown items. Both images show the same crafting recipe.
272 Rarely, crafting recipes have replacements. This means, whenever you perform a craft, particular items in the crafting grid will not be consumed, but instead will be replaced by another item.
273 ]=],
274 -- TODO: Replace image 3
275 -- TODO: Maybe add images demonstrating replacements
276 images = {
277 {image="doc_basics_craft_grid.png"}, {image="doc_basics_craft_shaped.png"}, {image="doc_basics_craft_shaped.png"},
278 {image="doc_basics_craft_repair.png"}, {image="doc_basics_craft_shapeless_1.png"}, {image="doc_basics_craft_shapeless_2.png"},
279 {image="doc_basics_craft_groups_1.png"}, {image="doc_basics_craft_groups_2.png"}, {image="doc_basics_craft_groups_3.png"},
283 -- TODO
284 doc.new_entry("basics", "cook", {
285 name = "Cooking",
286 data = {
287 text =
288 [=[Cooking (or smelting) is a form of crafting, which does not involve a crafting grid. Cooking is done with a special block (usually a furnace), an cookable item, a fuel item and time in order to yield a new item.
290 Each fuel item has a burning time. This is the time a single item of the fuel keeps a furnace burning.
291 Each cookable item requires time to be cooked. This time is specific to the item type and the item must be “on fire” for the entirety of its cooking time to actually yield the result.
293 How cooking works in detail depends on the subgame and mods.]=]}})
295 doc.new_entry("basics", "hotbar", {
296 name="Hotbar",
297 data = {
298 text =
299 [=[At the bottom of the screen you see some squares aligned horizontally. This is called the “hotbar”. The hotbar allows you to quickly access the first items from your player inventory.
300 You can change the selected item with the mouse wheel, or the number keys.
302 • Select previous item in hotbar: [Mouse wheel up]
303 • Select next item in hotbar: [Mouse wheel down]
304 • Select item in hotbar directly: [0]-[9]
306 The selected item is also your wielded item.]=],
307 images = {{image="doc_basics_hotbar.png"}, {image="doc_basics_hotbar_relations.png"}},
310 doc.new_entry("basics", "minimap", {
311 name="Minimap",
312 data = {
313 text =
314 [=[Press the [F9] key to make a minimap appear on the top right. The minimap helps you to find your way around the world. Press it again to toggle through different minimap modes and zoom levels.
316 There are 2 minimap modes and 3 zoom levels.
318 Surface mode is a top-down view of the world, roughly resembling the colors of the blocks this world is made on. It only shows the topmost blocks, everything below is hidden, like a satellite photo. Surface mode is useful if you got lost.
320 Radar mode is more complicated. It displays the “denseness” of the area around you and changes with your height. Roughly, the more green an area is, the less "dense" it is. Black areas have many blocks. Use the radar to find caverns, hidden areas, walls and more.
322 There are also two different direction modes. Normally, “up” on the minimap is always pointing to the North. But if you press [Shift]+[F9], the minimap will instead rotate with your looking direction, so “up” is always your looking direction.
324 In some subgames, the minimap may be disabled.
326 • Toggle minimap mode: [F9]
327 • Toggle minimap rotating: [Shift]+[F9]]=],
328 images = {{image="doc_basics_minimap_map.png"}, {image="doc_basics_minimap_radar.png"}, {image="doc_basics_minimap_round.png"}},
331 doc.new_entry("basics", "inventory", {
332 name="Inventory",
333 data = {
334 text =
335 [=[An inventory is primarily used to store item stacks. There are other uses, such as crafting. An inventory consists of a rectangular grid of item slots. Each item slot can be either empty or hold one item stack. Item stacks can be moved freely between slot and slot, given that the destination slot is either empty or of the same item type.
336 You have your own inventory which is called your “player inventory”, you can open it with the inventory key (default: [I]). The first inventory slots are also used as slots in your hotbar.
337 Blocks can also have their own inventory, for example, things like chests and furnaces.
339 Inventory controls:
341 Taking: You can take items from an occupied slot if the cursor holds nothing.
342 • Left click: take entire item stack
343 • Right click: take half from the item stack (rounding up if odd number)
344 • Middle click: take 10 items from the item stack
346 Putting: You can put items onto a slot if the cursor holds 1 or more items and the slot is either empty or contains an item stack of the same item type.
347 • Left click: put entire item stack
348 • Right click: put 1 item of the item stack
349 • Middle click: put 10 items of the item stack
351 Exchanging: You can exchange items if the cursor holds 1 or more items and the destination slot is occupied by a different item type.
352 • Left, middle and right click: exchange item stacks from cursor and from selected item slot
354 Throwing away: If you hold an item stack and click with it somewhere outside the menu, the item stack gets thrown away into the environment.
356 Quick transfer: You can quickly transfer an item stack to/from the player inventory to/from another item's inventory slot like a furnace, chest, or any other item with an inventory slot when that item's inventory is accessed. The inventories chosen for quick transfer are context-dependent, usually those are the inventories which are considered to be most useful in this context.
357 • Sneak+Left click: Automatically transfer item stack.]=],
358 images = {{image="doc_basics_inventory.png"}, {image="doc_basics_inventory_detail.png"}},
361 doc.new_entry("basics", "online", {
362 name="Online help",
363 data = { text=
364 [=[You may want to check out these online resources related to Minetest:
366 Official homepage of Minetest: <http://minetest.net/>
367 The main place to find the most recent version of Minetest.
369 Community wiki: <http://wiki.minetest.net/>
370 A community-based documentation website for Minetest. Anyone with an account can edit it! It also features a documentation of Minetest Game.
372 Web forums: <http://forums.minetest.net/>
373 A web-based discussion platform where you can discuss everything related to Minetest. This is also a place where player-made mods and subgames are published and discussed. The discussions are mainly in English, but there is also space for discussion in other languages.
375 Chat: <irc://irc.freenode.net#minetest>
376 A generic Internet Relay Chat channel for everything related to Minetest where people can meet to discuss in real-time. If you do not understand IRC, see the Community Wiki for help.]=]
379 -- TODO
380 doc.new_entry("basics", "groups", {
381 name="Groups",
382 data = {
383 text =
384 [=[Items, players and objects (animate and inanimate) can be member of any number of groups. Groups serve multiple purposes:
386 • Crafting recipes: Sometimes, slots in a crafting recipe do not require a specific item, but instead they require an item which is a member of a particular group, or multiple groups
387 • Digging times: Diggable blocks belong to groups which are used to determine digging times. Mining tools are capable of digging blocks belonging to certain groups
388 • Block behavior: Blocks may behave in a special way and interact with other blocks when they belong to a particular group
389 • Damage and armor: Objects and players have armor groups, weapons have damage groups. A weapon is able to deal damage to things where at least one of its damage groups is also present at the attacked object. The actual damage depends on the weapon strength (stronger weapon means less damage) and the armor strength (stronger armor means less damage)
390 • Other uses: Groups can be used for a few other things as well, which largely depends on the mods being used
392 In the item help, most important groups of which an item is a member of are mentioned and explained.]=]}})
394 doc.new_entry("basics", "glossary", {
395 name = "Glossary",
396 data = {
397 text =
398 [=[This is a list of commonly used terms in Minetest parlance:
400 Controls:
401 • Wielding: Holding an item in hand
402 • Pointing: Looking with the crosshair at something in range
403 • Dropping: Throwing an item or item stack to the ground
404 • Punching: Attacking with left-click, is also used on blocks
405 • Sneaking: Walking slowly while (usually) avoiding to fall over edges
406 • Climbing: Moving up or down a climbable block
408 Blocks:
409 • Block: Cubes that the worlds are made out of
410 • Mining/digging: Using a mining tool to break a block
411 • Building/placing: Putting a block somewhere
412 • Drop: The items you (may) get after mining a block
413 • Using a block: Right-clicking a block to access its special function
415 Items:
416 • Item: A single thing that players can possess
417 • Item stack: A collection of items of the same kind
418 • Maximum stack size: Maximum amount of items in an item stack
419 • Slot / inventory slot: Can hold one item stack
420 • Inventory: Provides several inventory slots for storage
421 • Player inventory: The main inventory of a player
422 • Tool: An item which you can use to do special things with when wielding
423 • Range: How far away things can be to be pointed by an item when wielding it
424 • Mining tool: A tool which allows to break blocks
425 • Craft item: An item which is (primarily or only) used for crafting
427 Gameplay:
428 • “heart”: A single health symbol, indicates 2 HP
429 • “bubble”: A single breath symbol, indicates 1 BP
430 • HP: Hit point (equals half a “heart”)
431 • BP: Breath point, indicates breath when swimming
432 • Mob: Computer-controlled enemy
433 • Crafting: Combining multiple items to create new ones
434 • Crafting guide: A helper which shows available crafting recipes; provided by mods
435 • Spawning: Appearing in the world
436 • Respawning: Appearing again in the world after death
437 • Group: Used to group similar things together; determines mining times, armor, damage, and more
438 • noclip: Allows to fly through walls
440 Interface
441 • Hotbar: The inventory slots at the bottom which you can select for wielding
442 • Statbar: Indicator made out of half-symbols, used for health and breath
443 • Minimap: The map or radar at the top right
444 • Crosshair: Seen in the middle, used to point to things
446 Online multiplayer:
447 • PvP: Player vs Player. Indicates that players can attack and deal damage to each other
448 • Griefing: Destroying the buildings of other players against their will
449 • Protection: Mechanism to own areas of the world, which only allows the owners to modify blocks inside
451 Technical:
452 • Minetest: This game engine
453 • Minetest Game: A subgame for Minetest from the Minetest developers
454 • Subgame: A complete playing experience to be used in Minetest; can be a game, a sandbox or something else
455 • Mod: A single subsystem which adds or modifies functionality; is the basic building block of subgames and can be used to further enhance or modify them
456 • Privilege: Allows a player to do something
457 • Node: Other word for “block”
458 ]=]}})
460 -- TODO
461 doc.new_entry("basics", "settings", {
462 name="Settings",
463 data = {
464 text =
465 [=[There is a large variety of settings to configure Minetest. Pretty much every aspect can be changed that way.
467 These are a few of the most important gameplay settings:
469 • Damage enabled (enable_damage): Enables the health and breath attributes for all players. If disabled, players are immortal
470 • Creative Mode (creative_mode): Enables sandbox-style gameplay focusing on creativity rather than a challenging gameplay. The meaning mostly depends on subgames but usually this means that you can access almost all items for free, can dig faster and some other “creative” changes
471 • PvP (enable_pvp): Short for “Player vs Player”. If enabled, players can deal damage to each other
473 For a full list of all available settings, use the “Advanced settings” dialog in the main menu.]=]
477 -- TODO
478 doc.new_entry("online", "intro", {
479 name="Introduction to online multiplayer",
480 data=
482 Every Minetest server is (more or less) different. A server can have any subgame and mods the server operator likes to.
484 Servers provide ALL gameplay functionality (subgame, mods) and media files out of the box, no additional configuration necessary. You only need to make sure to have a recent Minetest version to be able to connect to most servers.
485 ]=]})
487 -- TODO
488 doc.new_entry("online", "commands", {
489 name="Server commands",
490 data=
491 [=[Server commands are special commands to the server that can be entered by any player via the chat to cause the server to do something. There are a few commands which can be issued by everyone, but some commands only work if you have certain privileges granted on the server.
493 To issue a command, simply type it like a chat message or use the console. All commands have to begin with “/”, for example “/mods”.
495 Try it for yourselves: Close this window and say “/mods” in chat. This server will show you a list of mods installed on this server.
497 In Minetest, there is a small set of basic commands which are always available. Additional commands may be added by mods. This means, on other servers you might have new commands.
499 To help you get started, here are some basic commands:
501 • /help all: Lists and describes all server commands
502 • /privs: Lists your privileges]=]
505 -- TODO
506 doc.new_entry("online", "privs", {
507 name="Privileges",
508 data=[=[Every player has a set of privileges, which differ from server to server. Roughly spoken, one’s privileges determine what one is able to do and what not. Each privilege has a name. Privileges can be granted and revoked from other players by any player who has the privilege called “privs”.
510 On a multiplayer server with a default configuration, new players start with the privileges called “interact” and “shout”. The interact privilege is required for the most basic gameplay actions such as building, mining, using, etc. The shout privilege allows the player to use the chat.
512 Just like with server commands, there is a small set of core privileges which you'll find on every server, and other privileges might be added by mods.
514 To view your own privileges, issue the server command “/privs”.
516 Here are a few basic privilege-related commands:
517 • /privs: Lists your privileges
518 • /privs <player>: Lists the privileges of <player>
519 • /help privs: Shows a list and description about all privileges
521 Players with the “privs” privilege can modify privileges at will:
522 • /grant <player> <privilege>: Grant <privilege> to <player>
523 • /revoke <player> <privilege>: Revoke <privilege> from <player>
525 In single-player mode, you can use the shortcut “/grant singleplayer all” to allow you to do everything (this is considered cheating).]=]