nalc/areas
1
0
Fork 1
forked from mff/areas
Code Issues Pull Requests Releases Wiki Activity

Tweak README

Browse Source
This commit is contained in:
ShadowNinja 2014-10-25 14:00:19 -04:00
parent 21c9e6a4c0
commit 3666f7debb
1 changed files with 65 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

125
README.md
View File

@ -1,99 +1,102 @@
Areas mod for Minetest 0.4.8+ Areas mod for Minetest 0.4.8+
============================= =============================
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Configuration Configuration
------------- -------------
If you wish to specify configuration options, such as whether players are If you wish to specify configuration options, such as whether players are
allowed to protect their own areas with /protect (Disabled by default), you allowed to protect their own areas with the `protect` command (disabled by
should check config.lua and set the appropriate settings in your minetest.conf. default), you should check config.lua and set the appropriate settings in your
server's configuration file (probably `minetest.conf`).
Tutorial Tutorial
-------- --------
To protect an area you must first set the corner positions of the area. To protect an area you must first set the corner positions of the area.
In order to set the corner positions you run: In order to set the corner positions you can run:
1. "/area\_pos set" punch the two border nodes. * `/area_pos set` and punch the two corner nodes to set them.
2. "/area\_pos set1/2" punch only the first or second border node. * `/area_pos set1/set2` and punch only the first or second corner node to
3. "/area\_pos1/2" set position one or two to your current position. set them one at a time.
4. "/area\_pos1/2 X Y Z" set position one or two to the specified coordinates. * `/area_pos1/2` to set one of the positions to your current position.
* `/area_pos1/2 X Y Z` to set one of the positions to the specified
coordinates.
Once you have set the border positions you can protect the area by running: Once you have set the border positions you can protect the area by running one
1. "/set\_owner <OwnerName> <AreaName>" of the following commands:
-- If you are a administrator or moderator with the "areas" privilege. * `/set_owner <OwnerName> <AreaName>` -- If you have the `areas` privilege.
2. "/protect &lt;AreaName&gt;" * `/protect <AreaName>` -- If you have the `areas` privilege or the server
-- If the server administraor has enabled area self-protection. administrator has enabled area self-protection.
The area name is used so that you can easily find the area that you want when The area name is used only for informational purposes (so that you know what
using a command like /list\_areas. It is not used for any other purpose. an area is for). It is not used for any other purpose.
For example: /set\_owner SomePlayer Diamond city For example: `/set_owner SomePlayer Mese city`
Now that you own an area you may want to add sub-owners to it. You can do this Now that you own an area you may want to add sub-owners to it. You can do this
with the /add\_owner command. Anyone with an area can use the add\_owner with the `add_owner` command. Anyone with an area can use the `add_owner`
command on their areas. Before using the add\_owner command you have to select command on their areas. Before using the `add_owner` command you have to
the corners of the sub-area as you did for set\_owner. If your markers are select the corners of the sub-area as you did for `set_owner`. If your markers
still around your original area and you want to grant access to your entire are still around your original area and you want to grant access to your
area you will not have to re-set them. You can also use select\_area to place entire area you will not have to re-set them. You can also use `select_area` to
the markers at the corners of an existing area. place the markers at the corners of an existing area if you've reset your
The add\_owner command expects three arguments: markers and want to grant access to a full area.
1. The id of the parent area. (The area that you want it to be a sub-area of) The `add_owner` command expects three arguments:
1. The ID number of the parent area (the area that you want to add a
sub-area to).
2. The name of the player that will own the sub-area. 2. The name of the player that will own the sub-area.
3. The name of the sub-area. 3. The name of the sub-area. (can contain spaces)
For example: /add\_owner 123 BobTheBuilder Diamond lighthouse For example: `/add_owner 123 BobTheBuilder Diamond lighthouse`
Chat commands
-------------
* /protect &lt;AreaName&gt;
Protects an area for yourself. (If self-protection is enabled)
* /set\_owner &lt;OwnerName&gt; &lt;AreaName&gt; Commands
Protects an area. (Requires the "areas" privilege) --------
* /add\_owner &lt;ParentID&gt; &lt;OwnerName&gt; &lt;ChildName&gt; * `/protect <AreaName>` -- Protects an area for yourself. (if
Grants another player control over part (or all) of an area. self-protection is enabled)
* /rename\_area &lt;ID&gt; &lt;NewName&gt; * `/set_owner <OwnerName> <AreaName>` -- Protects an area for a specified
Renames an existing area, useful after converting from node_ownership player. (requires the `areas` privilege)
when all areas are unnamed.
* /list\_areas * `/add_owner <ParentID> <OwnerName> <ChildName>` -- Grants another player
Lists all of the areas that you own. control over part (or all) of an area.
(Or all of them if you have the "areas" privilege)
* /find\_areas &lt;Regex&gt; * `/rename_area <ID> <NewName>` -- Renames an existing area.
Finds areas using a Lua regular expresion.
For example:
/find_areas [Cc]astle To find castles.
* /remove\_area &lt;ID&gt; * `/list_areas` -- Lists all of the areas that you own, or all areas if you
Removes an area that you own. Any sub-areas of that area are made sub-areas have the `areas` privilege.
of the removed area's parent, if it exists. Otherwise they will have no
parent.
* /recursive\_remove\_areas &lt;ID&gt; * `/find_areas <Regex>` -- Finds areas using a Lua regular expresion.
Removes an area and all sub-areas of it. For example, to find castles:
* /change\_owner &lt;ID&gt; &lt;NewOwner&gt; /find_areas [Cc]astle
Change the owner of an area.
* /select\_area &lt;ID&gt; * `/remove_area <ID>` -- Removes an area that you own. Any sub-areas of that
Sets the area positions to those of an existing area. area are made sub-areas of the removed area's parent, if it exists.
If the removed area has no parent it's sub-areas will have no parent.
* /area\_pos {set,set1,set2,get} * `/recursive_remove_areas <ID>` -- Removes an area and all sub-areas of it.
Sets the area positions by punching nodes or shows the current area positions.
* /area\_pos1 \[X,Y,Z|X Y Z\] * `/change_owner <ID> <NewOwner>` -- Change the owner of an area.
Sets area position one to your position or the one supplied.
* /area\_pos2 \[X,Y,Z|X Y Z\] * `/select_area <ID>` -- Sets the area positions to those of an existing
Sets area position two to your position or the one supplied. area.
* `/area_pos {set,set1,set2,get}` -- Sets the area positions by punching
nodes or shows the current area positions.
* `/area_pos1 [X,Y,Z|X Y Z]` -- Sets area position one to your position or
the one supplied.
* `/area_pos2 [X,Y,Z|X Y Z]` -- Sets area position two to your position or
the one supplied.
License License
------- -------
Copyright (C) 2013 ShadowNinja Copyright (C) 2013 ShadowNinja
Licensed under the GNU LGPL version 2.1 or higher. Licensed under the GNU LGPL version 2.1 or later.
See LICENSE.txt and http://www.gnu.org/licenses/lgpl-2.1.txt See LICENSE.txt and http://www.gnu.org/licenses/lgpl-2.1.txt