Ocsethome: Difference between revisions

From Minetest
(Created page with "<div class="p44_navbar"> Wiki Top Minetest MT worlds Bucket Game Trolltest </div> <div class="p44_navbar"> [https://minetest.org/ minetest.org] [https://minetest.io minetest.io] [https://git.minetest.io/ 9,000 gits] [https://irc.minetest.org:9000/#/connect CoderChat] [https://edgy1.net/ EdgyNet] </div> <br /> <span id="introduction"></span> == Introduction == TODO: A discussion of the "ocsethome" mo...")
 
No edit summary
Line 16: Line 16:


<br />
<br />
<span id="introduction"></span>
<span id="ocsethome-howto"></span>
== Introduction ==
== How to Use ==


TODO: A discussion of the "ocsethome" mod in Bucket Game will go here. Topics to cover:
Bucket Game includes the "ocsethome" mod. This is a new version of
"sethome" which allows multiple homes. It supports commands similar to the
following:


* Can have multiple homes in a world
/sethome1 - Set  1st home location
* World host can set the maximum number of homes
/sethome2 - Set  2nd home location
* /sethome and /home are synced with Unified Inventory
/sethome3 - Set  3rd home location
/sethome4 - Set  4th home location
/sethome  - Same as /sethome1
 
/home1    - Go to 1st home location
/home2    - Go to 2nd home location
/home3    - Go to 3rd home location
/home4    - Go to 4th home location
/home    - Same as /home1
 
<span id="ocsethome-maxhomes"></span>
== Maximum number of homes ==
 
By default, by to 8 homes can be set at a time. The world host can
change the maximum number using settings of this form:
 
max_homes = 3
or
maxhomes  = 3
 
The world host can also use the following setting to disable extra
homes entirely:
 
disable_extra_homes = true
 
<span id="ocsethome-tech"></span>
== Technical notes ==
 
N01. This mod requires the "ocmkdir" mod.
 
N02. "ocsethome" calls "unified_inventory".  However,
"unified_inventory" shouldn't be listed in the "ocsethome"
"depends.txt" file;  not even as an optional dependency.
Such an entry would break things.
 
N03. This mod provides an undocumented API that can be used by other
mods. Presently, "unified_inventory" and SkyDoom make use of
the API.
 
N04. This implementation uses an improved mechanism to create the data
directory used.

Revision as of 23:40, 11 August 2023


How to Use

Bucket Game includes the "ocsethome" mod. This is a new version of "sethome" which allows multiple homes. It supports commands similar to the following:

/sethome1 - Set   1st home location
/sethome2 - Set   2nd home location
/sethome3 - Set   3rd home location
/sethome4 - Set   4th home location
/sethome  - Same as /sethome1
/home1    - Go to 1st home location
/home2    - Go to 2nd home location
/home3    - Go to 3rd home location
/home4    - Go to 4th home location
/home     - Same as /home1

Maximum number of homes

By default, by to 8 homes can be set at a time. The world host can change the maximum number using settings of this form:

max_homes = 3
or
maxhomes  = 3

The world host can also use the following setting to disable extra homes entirely:

disable_extra_homes = true

Technical notes

N01. This mod requires the "ocmkdir" mod.

N02. "ocsethome" calls "unified_inventory". However, "unified_inventory" shouldn't be listed in the "ocsethome" "depends.txt" file; not even as an optional dependency. Such an entry would break things.

N03. This mod provides an undocumented API that can be used by other mods. Presently, "unified_inventory" and SkyDoom make use of the API.

N04. This implementation uses an improved mechanism to create the data directory used.