doc/minetest.6


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

.TH minetest 6 "2 February 2019" "" ""

.SH NAME
minetest, minetestserver \- Multiplayer infinite-world block sandbox

.SH SYNOPSIS
.B minetest
[\fB--server SERVER OPTIONS\fR | \fBCLIENT OPTIONS\fR]
[\fBCOMMON OPTIONS\fR]
[\fBWORLD PATH\fR]

.B minetestserver
[\fBSERVER OPTIONS\fR]
[\fBCOMMON OPTIONS\fR]
[\fBWORLD PATH\fR]

.SH DESCRIPTION
.B Minetest is one of the first InfiniMiner/Minecraft(/whatever) inspired games
(started October 2010), with a goal of taking the survival multiplayer gameplay
in a slightly different direction.
.PP
The main design philosophy is to keep it technically simple, stable and
portable. It will be kept lightweight enough to run on fairly old hardware.

.SH COMMON OPTIONS
.TP
.B \-\-help
Print allowed options and exit
.TP
.B \-\-version
Print version information and exit
.TP
.B \-\-config <value>
Load configuration from specified file
.TP
.B \-\-logfile <value>
Set logfile path ('' for no logging)
.TP
.B \-\-info
Print more information to console
.TP
.B \-\-verbose
Print even more information to console
.TP
.B \-\-trace
Print enormous amounts of information to console
.TP
.B \-\-quiet
Print only errors to console
.TP
.B \-\-color <value>
Colorize the logs ('always', 'never' or 'auto'), defaults to 'auto'
.TP
.B \-\-gameid <value> | list
Set gameid or list available ones
.TP
.B \-\-worldname <value>
Set world path by name
.TP
.B \-\-world <value>
Set world path
.TP
.B \-\-worldlist path | name | both
Get list of worlds ('path' lists paths, 'name' lists names, 'both' lists both)
.TP
.B \-\-map\-dir <value>
Same as \-\-world (deprecated)
.TP
.B \-\-port <value>
Set network port (UDP) to use
.TP
.B \-\-run\-unittests
Run unit tests and exit

.SH CLIENT OPTIONS
.TP
.B \-\-address <value>
Address to connect to
.TP
.B \-\-go
Disable main menu
.TP
.B \-\-name <value>
Set player name
.TP
.B \-\-password <value>
Set password
.TP
.B \-\-password\-file <value>
Set password from contents of file
.TP
.B \-\-random\-input
Enable random user input, for testing (client only)
.TP
.B \-\-videomodes
List available video modes (client only)
.TP
.B \-\-speedtests
Run speed tests

.SH SERVER OPTIONS
.TP
.B \-\-migrate <value>
Migrate from current map backend to another. Possible values are sqlite3,
leveldb, redis, postgresql, and dummy.
.TP
.B \-\-migrate-auth <value>
Migrate from current auth backend to another. Possible values are sqlite3 and
files.
.TP
.B \-\-migrate-players <value>
Migrate from current players backend to another. Possible values are sqlite3,
postgresql, dummy, and files.
.TP
.B \-\-terminal
Display an interactive terminal over ncurses during execution.

.SH ENVIRONMENT
.TP
.B MINETEST_SUBGAME_PATH
Colon delimited list of directories to search for games.

.SH BUGS
Please report all bugs at https://github.com/minetest/minetest/issues.

.SH AUTHOR
.PP
Perttu Ahola <celeron55@gmail.com> and contributors.
.PP
This man page was originally written by
Juhani Numminen <juhaninumminen0@gmail.com>.

.SH WWW
http://www.minetest.net/
/*
Minetest
Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/

#include "lua_api/l_particles.h"
#include "lua_api/l_internal.h"
#include "common/c_converter.h"
#include "server.h"

// add_particle({pos=, velocity=, acceleration=, expirationtime=,
// 		size=, collisiondetection=, vertical=, texture=, player=})
// pos/velocity/acceleration = {x=num, y=num, z=num}
// expirationtime = num (seconds)
// size = num
// collisiondetection = bool
// vertical = bool
// texture = e.g."default_wood.png"
int ModApiParticles::l_add_particle(lua_State *L)
{
	// Get parameters
	v3f pos, vel, acc;
	    pos= vel= acc= v3f(0, 0, 0);
	float expirationtime, size;
	      expirationtime= size= 1;
	bool collisiondetection, vertical;
	     collisiondetection= vertical= false;
	std::string texture = "";
	const char *playername = "";

	if (lua_gettop(L) > 1) // deprecated
	{
		log_deprecated(L,"Deprecated add_particle call with individual parameters instead of definition");
		pos = check_v3f(L, 1);
		vel = check_v3f(L, 2);
		acc = check_v3f(L, 3);
		expirationtime = luaL_checknumber(L, 4);
		size = luaL_checknumber(L, 5);
		collisiondetection = lua_toboolean(L, 6);
		texture = luaL_checkstring(L, 7);
		if (lua_gettop(L) == 8) // only spawn for a single player
			playername = luaL_checkstring(L, 8);
	}
	else if (lua_istable(L, 1))
	{
		int table = lua_gettop(L);
		lua_pushnil(L);
		while (lua_next(L, table) != 0)
		{
			const char *key = lua_tostring(L, -2);
				  if(strcmp(key,"pos")==0){
					pos=check_v3f(L, -1);
			}else if(strcmp(key,"vel")==0){
					vel=check_v3f(L, -1);
			}else if(strcmp(key,"acc")==0){
					acc=check_v3f(L, -1);
			}else if(strcmp(key,"expirationtime")==0){
					expirationtime=luaL_checknumber(L, -1);
			}else if(strcmp(key,"size")==0){
					size=luaL_checknumber(L, -1);
			}else if(strcmp(key,"collisiondetection")==0){
					collisiondetection=lua_toboolean(L, -1);
			}else if(strcmp(key,"vertical")==0){
					vertical=lua_toboolean(L, -1);
			}else if(strcmp(key,"texture")==0){
					texture=luaL_checkstring(L, -1);
			}else if(strcmp(key,"playername")==0){
					playername=luaL_checkstring(L, -1);
			}
			lua_pop(L, 1);
		}
	}
	if (strcmp(playername, "")==0) // spawn for all players
	{
		getServer(L)->spawnParticleAll(pos, vel, acc,
			expirationtime, size, collisiondetection, vertical, texture);
	}
	else
	{
		getServer(L)->spawnParticle(playername,
			pos, vel, acc, expirationtime,
			size, collisiondetection, vertical, texture);
	}
	return 1;
}

// add_particlespawner({amount=, time=,
//				minpos=, maxpos=,
//				minvel=, maxvel=,
//				minacc=, maxacc=,
//				minexptime=, maxexptime=,
//				minsize=, maxsize=,
//				collisiondetection=,
//				vertical=,
//				texture=,
//				player=})
// minpos/maxpos/minvel/maxvel/minacc/maxacc = {x=num, y=num, z=num}
// minexptime/maxexptime = num (seconds)
// minsize/maxsize = num
// collisiondetection = bool
// vertical = bool
// texture = e.g."default_wood.png"
int ModApiParticles::l_add_particlespawner(lua_State *L)
{
	// Get parameters
	u16 amount = 1;
	v3f minpos, maxpos, minvel, maxvel, minacc, maxacc;
	    minpos= maxpos= minvel= maxvel= minacc= maxacc= v3f(0, 0, 0);
	float time, minexptime, maxexptime, minsize, maxsize;
	      time= minexptime= maxexptime= minsize= maxsize= 1;
	bool collisiondetection, vertical;
	     collisiondetection= vertical= false;
	std::string texture = "";
	const char *playername = "";

	if (lua_gettop(L) > 1) //deprecated
	{
		log_deprecated(L,"Deprecated add_particlespawner call with individual parameters instead of definition");
		amount = luaL_checknumber(L, 1);
		time = luaL_checknumber(L, 2);
		minpos = check_v3f(L, 3);
		maxpos = check_v3f(L, 4);
		minvel = check_v3f(L, 5);
		maxvel = check_v3f(L, 6);
		minacc = check_v3f(L, 7);
		maxacc = check_v3f(L, 8);
		minexptime = luaL_checknumber(L, 9);
		maxexptime = luaL_checknumber(L, 10);
		minsize = luaL_checknumber(L, 11);
		maxsize = luaL_checknumber(L, 12);
		collisiondetection = lua_toboolean(L, 13);
		texture = luaL_checkstring(L, 14);
		if (lua_gettop(L) == 15) // only spawn for a single player
			playername = luaL_checkstring(L, 15);
	}
	else if (lua_istable(L, 1))
	{
		int table = lua_gettop(L);
		lua_pushnil(L);
		while (lua_next(L, table) != 0)
		{
			const char *key = lua_tostring(L, -2);
			      if(strcmp(key,"amount")==0){
					amount=luaL_checknumber(L, -1);
			}else if(strcmp(key,"time")==0){
					time=luaL_checknumber(L, -1);
			}else if(strcmp(key,"minpos")==0){
					minpos=check_v3f(L, -1);
			}else if(strcmp(key,"maxpos")==0){
					maxpos=check_v3f(L, -1);
			}else if(strcmp(key,"minvel")==0){
					minvel=check_v3f(L, -1);
			}else if(strcmp(key,"maxvel")==0){
					maxvel=check_v3f(L, -1);
			}else if(strcmp(key,"minacc")==0){
					minacc=check_v3f(L, -1);
			}else if(strcmp(key,"maxacc")==0){
					maxacc=check_v3f(L, -1);
			}else if(strcmp(key,"minexptime")==0){
					minexptime=luaL_checknumber(L, -1);
			}else if(strcmp(key,"maxexptime")==0){
					maxexptime=luaL_checknumber(L, -1);
			}else if(strcmp(key,"minsize")==0){
					minsize=luaL_checknumber(L, -1);
			}else if(strcmp(key,"maxsize")==0){
					maxsize=luaL_checknumber(L, -1);
			}else if(strcmp(key,"collisiondetection")==0){
					collisiondetection=lua_toboolean(L, -1);
			}else if(strcmp(key,"vertical")==0){
					vertical=lua_toboolean(L, -1);
			}else if(strcmp(key,"texture")==0){
					texture=luaL_checkstring(L, -1);
			}else if(strcmp(key,"playername")==0){
					playername=luaL_checkstring(L, -1);
			}
			lua_pop(L, 1);
		}
	}
	if (strcmp(playername, "")==0) //spawn for all players
	{
		u32 id = getServer(L)->addParticleSpawnerAll(	amount, time,
							minpos, maxpos,
							minvel, maxvel,
							minacc, maxacc,
							minexptime, maxexptime,
							minsize, maxsize,
							collisiondetection,
							vertical,
							texture);
		lua_pushnumber(L, id);
	}
	else
	{
		u32 id = getServer(L)->addParticleSpawner(playername,
							amount, time,
							minpos, maxpos,
							minvel, maxvel,
							minacc, maxacc,
							minexptime, maxexptime,
							minsize, maxsize,
							collisiondetection,
							vertical,
							texture);
		lua_pushnumber(L, id);
	}
	return 1;
}

// delete_particlespawner(id, player)
// player (string) is optional
int ModApiParticles::l_delete_particlespawner(lua_State *L)
{
	// Get parameters
	u32 id = luaL_checknumber(L, 1);

	if (lua_gettop(L) == 2) // only delete for one player
	{
		const char *playername = luaL_checkstring(L, 2);
		getServer(L)->deleteParticleSpawner(playername, id);
	}
	else // delete for all players
	{
		getServer(L)->deleteParticleSpawnerAll(id);
	}
	return 1;
}

void ModApiParticles::Initialize(lua_State *L, int top)
{
	API_FCT(add_particle);
	API_FCT(add_particlespawner);
	API_FCT(delete_particlespawner);
}