Skip to content

Commit 8e51f31

Browse files
committedSep 30, 2015
Rename to Minetest Game
Rename in game.conf and documentation Update game_api.txt documentation for bucket API and tree functions Fix tab, space and comment formatting in game_api.txt Rename in mod READMEs
1 parent 93a2c40 commit 8e51f31

File tree

21 files changed

+106
-93
lines changed

21 files changed

+106
-93
lines changed
 

Diff for: ‎README.txt

+14-13
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
1-
The main game for the Minetest game engine [minetest_game]
2-
==========================================================
1+
Minetest Game [minetest_game]
2+
=============================
3+
The main subgame for the Minetest engine
4+
========================================
35

4-
To use this game with Minetest, insert this repository as
5-
/games/minetest_game
6-
in the Minetest Engine.
6+
To use this subgame with the Minetest engine, insert this repository as
7+
/games/minetest_game
78

8-
The Minetest Engine can be found in:
9-
https://github.com/minetest/minetest/
9+
The Minetest engine can be found in:
10+
https://github.com/minetest/minetest/
1011

1112
Compatibility
1213
--------------
13-
The minetest_game github master HEAD is generally compatible with the github
14-
master HEAD of minetest.
14+
The Minetest Game github master HEAD is generally compatible with the github
15+
master HEAD of the Minetest engine.
Has a conversation. Original line has a conversation.
1516

16-
Additionally, when the minetest engine is tagged to be a certain version (eg.
17-
0.4.10), minetest_game is tagged with the version too.
17+
Additionally, when the Minetest engine is tagged to be a certain version (eg.
18+
0.4.10), Minetest Game is tagged with the version too.
1819

19-
When stable releases are made, minetest_game is packaged and made available in
20-
http://minetest.net/download
20+
When stable releases are made, Minetest Game is packaged and made available in
21+
http://minetest.net/download
2122
and in case the repository has grown too much, it may be reset. In that sense,
2223
this is not a "real" git repository. (Package maintainers please note!)
2324

Diff for: ‎game.conf

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
name = Minetest
1+
name = Minetest Game

Diff for: ‎game_api.txt

+58-45
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
minetest_game API
2-
======================
1+
Minetest Game API
2+
=================
33
GitHub Repo: https://github.com/minetest/minetest_game
44

55
Introduction
66
------------
7-
The minetest_game gamemode offers multiple new possibilities in addition to Minetest's built-in API, allowing you to
8-
add new plants to farming mod, buckets for new liquids, new stairs and custom panes.
7+
The Minetest Game subgame offers multiple new possibilities in addition to the Minetest engine's built-in API,
8+
allowing you to add new plants to farming mod, buckets for new liquids, new stairs and custom panes.
99
For information on the Minetest API, visit https://github.com/minetest/minetest/blob/master/doc/lua_api.txt
1010
Please note:
1111
[XYZ] refers to a section the Minetest API
@@ -17,23 +17,24 @@ Bucket API
1717
The bucket API allows registering new types of buckets for non-default liquids.
1818

1919
bucket.register_liquid(
20-
"default:lava_source", -- Source node name
21-
"default:lava_flowing", -- Flowing node name
22-
"bucket:bucket_lava", -- Name to be used for bucket
23-
"bucket_lava.png", -- Bucket texture (for wielditem and inventory_image)
24-
"Lava Bucket" -- Bucket description
20+
"default:lava_source", -- name of the source node
21+
"default:lava_flowing", -- name of the flowing node
22+
"bucket:bucket_lava", -- name of the new bucket item (or nil if liquid is not takeable)
23+
"bucket_lava.png", -- texture of the new bucket item (ignored if itemname == nil)
24+
"Lava Bucket", -- text description of the bucket item
25+
{lava_bucket = 1} -- groups of the bucket item, OPTIONAL
2526
)
2627

2728
Beds API
2829
--------
2930
beds.register_bed(
30-
"beds:bed", -- Bed name
31-
def: See [#Bed definition] -- Bed definition
31+
"beds:bed", -- Bed name
32+
def: See [#Bed definition] -- Bed definition
3233
)
3334

34-
beds.read_spawns() -- returns a table containing players respawn positions
35-
beds.kick_players() -- forces all players to leave bed
36-
beds.skip_night() -- sets world time to morning and saves respawn position of all players currently sleeping
35+
beds.read_spawns() -- returns a table containing players respawn positions
36+
beds.kick_players() -- forces all players to leave bed
37+
beds.skip_night() -- sets world time to morning and saves respawn position of all players currently sleeping
3738

3839
#Bed definition
3940
---------------
@@ -50,11 +51,11 @@ Beds API
5051
}
5152
},
5253
nodebox = {
53-
bottom = regular nodebox, see [Node boxes], -- bottm part of bed
54-
top = regular nodebox, see [Node boxes], -- top part of bed
54+
bottom = regular nodebox, see [Node boxes], -- bottm part of bed
55+
top = regular nodebox, see [Node boxes], -- top part of bed
5556
},
56-
selectionbox = regular nodebox, see [Node boxes], -- for both nodeboxes
57-
recipe = { -- Craft recipe
57+
selectionbox = regular nodebox, see [Node boxes], -- for both nodeboxes
58+
recipe = { -- Craft recipe
5859
{"group:wool", "group:wool", "group:wool"},
5960
{"group:wood", "group:wood", "group:wood"}
6061
}
@@ -104,9 +105,9 @@ doors.register_trapdoor(name, def)
104105
sound_open = sound to play when opening the trapdoor, OPTIONAL,
105106
sound_close = sound to play when closing the trapdoor, OPTIONAL,
106107
-> You can add any other node definition properties for minetest.register_node,
107-
such as wield_image, inventory_image, sounds, groups, description, ...
108-
Only node_box, selection_box, tiles, drop, drawtype, paramtype, paramtype2, on_rightclick
109-
will be overwritten by the trapdoor registration function
108+
such as wield_image, inventory_image, sounds, groups, description, ...
109+
Only node_box, selection_box, tiles, drop, drawtype, paramtype, paramtype2, on_rightclick
110+
will be overwritten by the trapdoor registration function
110111
}
111112

112113
Farming API
@@ -122,11 +123,11 @@ farming.register_plant(name, Plant definition)
122123
#Hoe Definition
123124
---------------
124125
{
125-
description = "", -- Description for tooltip
126-
inventory_image = "unknown_item.png", -- Image to be used as wield- and inventory image
127-
max_uses = 30, -- Uses until destroyed
128-
material = "", -- Material for recipes
129-
recipe = { -- Craft recipe, if material isn't used
126+
description = "", -- Description for tooltip
127+
inventory_image = "unknown_item.png", -- Image to be used as wield- and inventory image
128+
max_uses = 30, -- Uses until destroyed
129+
material = "", -- Material for recipes
130+
recipe = { -- Craft recipe, if material isn't used
130131
{"air", "air", "air"},
131132
{"", "group:stick"},
132133
{"", "group:stick"},
@@ -136,12 +137,12 @@ farming.register_plant(name, Plant definition)
136137
#Plant definition
137138
-----------------
138139
{
139-
description = "", -- Description of seed item
140-
inventory_image = "unknown_item.png", -- Image to be used as seed's wield- and inventory image
141-
steps = 8, -- How many steps the plant has to grow, until it can be harvested
140+
description = "", -- Description of seed item
141+
inventory_image = "unknown_item.png", -- Image to be used as seed's wield- and inventory image
142+
steps = 8, -- How many steps the plant has to grow, until it can be harvested
142143
^ Always provide a plant texture for each step, format: modname_plantname_i.png (i = stepnumber)
143-
minlight = 13, -- Minimum light to grow
144-
maxlight = default.LIGHT_MAX -- Maximum light to grow
144+
minlight = 13, -- Minimum light to grow
145+
maxlight = default.LIGHT_MAX -- Maximum light to grow
145146
}
146147

147148
Screwdriver API
@@ -155,7 +156,7 @@ on_rotate(pos, node, user, mode, new_param2)
155156
^ mode: screwdriver.ROTATE_FACE or screwdriver.ROTATE_AXIS
156157
^ new_param2: the new value of param2 that would have been set if on_rotate wasn't there
157158
^ return value: false to disallow rotation, nil to keep default behaviour, true to allow
158-
it but to indicate that changed have already been made (so the screwdriver will wear out)
159+
it but to indicate that changed have already been made (so the screwdriver will wear out)
159160
^ use on_rotate = screwdriver.disallow to always disallow rotation
160161
^ use on_rotate = screwdriver.rotate_simple to allow only face rotation
161162

@@ -215,10 +216,10 @@ The following nodes use the group `connect_to_raillike` and will only connect to
215216
raillike nodes within this group and the same group value.
216217
Use `minetest.raillike_group(<Name>)` to get the group value.
217218

218-
| Node type | Raillike group name
219-
+-----------------------+----------------------------------
220-
| default:rail | "rail"
221-
| tnt:gunpowder | "gunpowder"
219+
| Node type | Raillike group name
220+
+-----------------------+--------------------
221+
| default:rail | "rail"
222+
| tnt:gunpowder | "gunpowder"
222223
| tnt:gunpowder_burning | "gunpowder"
223224

224225
Example:
@@ -281,13 +282,13 @@ default.player_get_animation(player)
281282
Model Definition
282283
----------------
283284
{
284-
animation_speed = 30, -- Default animation speed, in FPS.
285-
textures = {"character.png", }, -- Default array of textures.
286-
visual_size = {x=1, y=1,}, -- Used to scale the model.
285+
animation_speed = 30, -- Default animation speed, in FPS.
286+
textures = {"character.png", }, -- Default array of textures.
287+
visual_size = {x = 1, y = 1}, -- Used to scale the model.
287288
animations = {
288-
-- <anim_name> = { x=<start_frame>, y=<end_frame>, },
289-
foo = { x= 0, y=19, },
290-
bar = { x=20, y=39, },
289+
-- <anim_name> = {x = <start_frame>, y = <end_frame>},
290+
foo = {x = 0, y = 19},
291+
bar = {x = 20, y = 39},
291292
-- ...
292293
},
293294
}
@@ -375,10 +376,22 @@ dye.excolors
375376
Trees
376377
-----
377378
default.grow_tree(pos, is_apple_tree)
378-
^ Grows a tree or apple tree at pos
379+
^ Grows a mgv6 tree or apple tree at pos
379380

380381
default.grow_jungle_tree(pos)
381-
^ Grows a jungletree at pos
382+
^ Grows a mgv6 jungletree at pos
382383

383384
default.grow_pine_tree(pos)
384-
^ Grows a pinetree at pos
385+
^ Grows a mgv6 pinetree at pos
386+
387+
default.grow_new_apple_tree(pos)
388+
^ Grows a new design apple tree at pos
389+
390+
default.grow_new_jungle_tree(pos)
391+
^ Grows a new design jungle tree at pos
392+
393+
default.grow_new_pine_tree(pos)
394+
^ Grows a new design pine tree at pos
395+
396+
default.grow_new_acacia_tree(pos)
397+
^ Grows a new design acacia tree at pos

Diff for: ‎minetest.conf.example

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# This file contains settings of minetest_game that can be changed in
2-
# minetest.conf
3-
#
1+
# This file contains settings of Minetest Game that can be changed in minetest.conf
42
# By default, all the settings are commented and not functional.
53
# Uncomment settings by removing the preceding #.
64

Diff for: ‎mods/beds/README.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Minetest mod "Beds"
2-
===================
1+
Minetest Game mod: beds
2+
=======================
33
by BlockMen (c) 2014-2015
44

55
Version: 1.1.1

Diff for: ‎mods/boats/README.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
Minetest 0.4 mod: boats
2-
=======================
3-
by PilzAdam, slightly modified for NeXt
1+
Minetest Game mod: boats
2+
========================
3+
by PilzAdam
44

55
License of source code:
66
-----------------------

Diff for: ‎mods/bones/README.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Minetest 0.4 mod: bones
2-
=======================
1+
Minetest Game mod: bones
2+
========================
33

44
License of source code:
55
-----------------------

Diff for: ‎mods/bucket/README.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Minetest 0.4 mod: bucket
1+
Minetest Game mod: bucket
22
=========================
33

44
License of source code:

Diff for: ‎mods/creative/README.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Minetest 0.4 mod: creative
2-
==========================
1+
Minetest Game mod: creative
2+
===========================
33

44
Implements creative mode.
55

Diff for: ‎mods/default/README.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Minetest 0.4 mod: default
1+
Minetest Game mod: default
22
==========================
33

44
License of source code:

Diff for: ‎mods/doors/README.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Minetest 0.4 mod: doors
2-
=======================
1+
Minetest Game mod: doors
2+
========================
33
version: 1.3
44

55
License of source code:

Diff for: ‎mods/dye/README.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Minetest 0.4 mod: dye
1+
Minetest Game mod: dye
22
======================
33

44
See init.lua for documentation.

Diff for: ‎mods/farming/README.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Minetest 0.4 mod: farming
2-
=========================
1+
Minetest Game mod: farming
2+
==========================
33

44
License of source code:
55
-----------------------
@@ -45,4 +45,4 @@ Created by Gambit (License: WTFPL):
4545
farming_cotton_*.png
4646
farming_flour.png
4747
farming_cotton_seed.png
48-
farming_wheat_seed.png
48+
farming_wheat_seed.png

Diff for: ‎mods/fire/README.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Minetest 0.4 mod: fire
2-
======================
1+
Minetest Game mod: fire
2+
=======================
33

44
License of source code:
55
-----------------------

Diff for: ‎mods/flowers/README.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Minetest 0.4 mod: flowers
2-
=========================
1+
Minetest Game mod: flowers
2+
==========================
33

44
License of source code:
55
-----------------------

Diff for: ‎mods/screwdriver/readme.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Minetest mod: screwdriver
2-
=========================
1+
Minetest Game mod: screwdriver
2+
==============================
33

44
License of source code:
55
-----------------------
@@ -18,4 +18,4 @@ Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
1818
http://creativecommons.org/licenses/by-sa/3.0/
1919

2020
Created by Gambit (WTFPL):
21-
screwdriver.png
21+
screwdriver.png

Diff for: ‎mods/stairs/README.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Minetest 0.4 mod: stairs
1+
Minetest Game mod: stairs
22
=========================
33

44
License of source code:

Diff for: ‎mods/tnt/README.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
=== TNT mod for Minetest ===
1+
Minetest Game mod: tnt
2+
======================
23
by PilzAdam and ShadowNinja
34

45
Introduction:

Diff for: ‎mods/vessels/README.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Minetest 0.4 mod: vessels
1+
Minetest Game mod: vessels
22
==========================
33

44
Crafts

Diff for: ‎mods/wool/README.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Minetest 0.4 mod: wool
2-
======================
1+
Minetest Game mod: wool
2+
=======================
33

44
Mostly backward-compatible with jordach's 16-color wool mod.
55

Diff for: ‎mods/xpanes/README.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Minetest 0.4.x mod: xpanes
2-
==========================
1+
Minetest Game mod: xpanes
2+
=========================
33

44
License:
55
--------

0 commit comments

Comments
 (0)
Please sign in to comment.