mirror of
https://codeberg.org/usrib/emeraldbank.git
synced 2024-11-19 22:23:50 +01:00
readme update
This commit is contained in:
Freeman
parent
5c22b73fca
commit
2bdc96971b
84
README.md
84
README.md
@ -1,9 +1,8 @@
|
||||
|
||||
# Emerald Bank and Shops (MineClonia/MineClone2)
|
||||
|
||||
[](https://content.minetest.net/packages/NathanielFreeman/emeraldbank/)
|
||||
|
||||
|
||||
|
||||
|
||||
Code under AGPLv3-or-later License
|
||||
|
||||
@ -11,10 +10,7 @@ EmeraldBank Mod is [Libre/Free Software](https://www.gnu.org/philosophy/free-sw.
|
||||
|
||||
[This is not open source](https://www.gnu.org/philosophy/open-source-misses-the-point.html)!
|
||||
|
||||
|
||||
## Description
|
||||
|
||||
### Bank
|
||||
## Bank
|
||||
|
||||
Keep your Emeralds in a bank!
|
||||
|
||||
@ -30,8 +26,7 @@ Rightclick on bank open the bank interface, where you can deposit or withdraw yo
|
||||
|
||||
You can transfer money to other players in Bank interface.
|
||||
|
||||
|
||||
### Shops (Like fancy_vend mod)
|
||||
## Shops (Like fancy_vend mod)
|
||||
|
||||
The new shops are based in _fancy_vend_ mod shops
|
||||
|
||||
@ -39,7 +34,7 @@ The new shops are based in _fancy_vend_ mod shops
|
||||
|
||||
There are many vendor mods for Minetest, but most have too few options, lack support for automation mods, or are too tedious to set up and maintain. Fancy vendors are entirely self-contained nodes which provide light, trade, display and store items. Fancy vendors are _pipeworks_, _digilines_ and _mcl_awards_ compatible, enabling a variety of automation-based features.
|
||||
|
||||
#### Basic configuration
|
||||
### Basic configuration
|
||||
|
||||
Each fancy vendor needs 2 nodes of room. If the area you wish to place the vendor doesn't have enough space, due to either a node or a protected area, the node will not be placed. If the vendor has sufficient room, it will place a vendor node in addition to a display node on top. The display node's only purpose is aesthetics, to "contain" the rotating display object.
|
||||
|
||||
@ -57,7 +52,7 @@ If the vendor is intended to be used to purchase items, you may wish to set the
|
||||
|
||||
|
||||
|
||||
#### Buying items
|
||||
### Buying items
|
||||
Regular players who can't access a fancy vendor's inventory or configuration will be displayed a purchase screen when they access a vendor. This screen displays vendor information and status, as well as buying options. Unlike many vendor mods, fancy vendors give buyers to buy multiple "lots" at once. Doing this can save a lot of clicking, as the number of input and output items traded is multiplied by this number.
|
||||
|
||||
There is also a button labeled "Fill lots to max" which will pre-load the lots field with the maximum number of lots that the player can purchase from the vendor (which will be either the maximum the player can afford, or the maximum the shop can sell, whichever is smaller).
|
||||
@ -66,7 +61,7 @@ An example image of the buyer formspec can be seen below:
|
||||
|
||||
|
||||
|
||||
#### Advanced settings
|
||||
### Advanced settings
|
||||
Fancy vendors have many additional options which enable sellers to greatly customize vendors.
|
||||
|
||||
|
||||
@ -94,10 +89,10 @@ This tool can be used to easily copy vendor settings from one vendor to another.
|
||||
|
||||
|
||||
|
||||
#### Automation
|
||||
### Automation
|
||||
Fancy Vendors are digilines and pipeworks compatible, enabling the creation of highly automated shops.
|
||||
|
||||
##### Pipeworks
|
||||
#### Pipeworks
|
||||
Fancy vendors connect to pipeworks devices from the bottom, rear and sides. When the optional pipeworks dependancy is satisfied, a number of pipeworks-specific options will also appear in the settings menu:
|
||||
|
||||
|
||||
@ -111,10 +106,10 @@ When this option is enabled, the input items will be sent out of the **bottom**
|
||||
**Accept output only:**
|
||||
When this option is enabled, incoming items which aren't the output item will be rejected and not added to the vendor's inventory.
|
||||
|
||||
##### Hoppers
|
||||
#### Hoppers
|
||||
Fancy vendors are MCL hopper compatible. Also they have been tested to work with [TenPlus1's hopper mod](https://github.com/tenplus1/hopper) however should work with all hopper mods and forks. Hoppers can filter into vendors from the sides, however cannot be drained from the bottom as hoppers are protected and Fancy Vendors are locked. However, the shop owner is given the `Eject incoming currency` option which operates on hoppers similarly to how it does on pipeworks, by manually adding incoming currency to the inventory of a hopper placed below the vendor (or into the vendor's inventory if the hopper is full). Due to API limitations, `Accept output only` is not hopper-compatible and `Split incoming stacks` is not necessary.
|
||||
|
||||
##### Digilines
|
||||
#### Digilines
|
||||
Fancy vendors are digilines compatible. When the digilines dependency is satisfied, an option to set the digiline channel will appear in settings. If this channel is set, every purchase will result in the following table being sent over that channel:
|
||||
|
||||
```lua
|
||||
@ -151,20 +146,11 @@ Fancy Vendors and Fancy Vendor Display Nodes conduct digiline signals also.
|
||||
|
||||
This feature could theoretically make rewards-based shops feasable.
|
||||
|
||||
#### Out Of Stock Mail
|
||||
This mod integrates with several mail mods in order to alert shop owners when their shops lose stock. If multiple mods are in use, only one will be used to send the message. The order of which is:
|
||||
|
||||
- Mail By Athous
|
||||
- Email By Rubenwardy
|
||||
- Tell By Octacian
|
||||
|
||||
##### Mail (Athous)
|
||||
### Out Of Stock Mail
|
||||
This mod integrates with [Athous Mail Mod](https://github.com/mt-mods/mail) to alert shop owners when their shops lose stock.
|
||||
When a vendor empties, the mod sends mail telling them that their vendor is out of stock. In the event another mod empties, the previous message will be edited so as to avoid flooding their inbox if they have many vendors.
|
||||
|
||||
##### Tell & Email
|
||||
As there is no tidy way of sending very long messages with these mods, messages will simply be sent whenever a vendor goes out of stock.
|
||||
|
||||
#### Upgrading vendors
|
||||
### Upgrading vendors
|
||||
|
||||
**NOTE:** If you wish to simply run this mod in parallel with existing vendor mods, simply load this mod (no configuration required)
|
||||
|
||||
@ -184,6 +170,20 @@ Vendor upgrade:
|
||||
|
||||
|
||||
|
||||
## User Commands
|
||||
|
||||
User /pay command. Pay emeralds to another player:
|
||||
|
||||
```
|
||||
/pay <player> <num>
|
||||
```
|
||||
|
||||
User /money command. Show you the emeralds in your bank account in the chat.
|
||||
|
||||
```
|
||||
/money
|
||||
```
|
||||
|
||||
## Administration
|
||||
EmeraldBank mod also include a variety of tools for server administrators.
|
||||
|
||||
@ -195,10 +195,17 @@ Admin command to add emeralds in bank accounts:
|
||||
```
|
||||
|
||||
Add `<num>` emeralds to `<player>` account.
|
||||
|
||||
If num is 0 return emeralds in player account.
|
||||
|
||||
**Temporarily disabling vendors:**
|
||||
Any player with the disable_vendor privilege can run /disable_all_vendors to force all vendors into an inactive state. Please use this if you find a dangerous bug and are waiting for it to be fixed.
|
||||
Any player with the disable_vendor privilege can run
|
||||
|
||||
```
|
||||
/disable_all_vendors
|
||||
```
|
||||
|
||||
to force all vendors into an inactive state. Please use this if you find a dangerous bug and are waiting for it to be fixed.
|
||||
|
||||
**Admin vendors:**
|
||||
Admin vendors perform the same role as their regular counterparts, however they do so with no stock or inventory requirements, simply creating and destroying items as players purchase.
|
||||
@ -213,27 +220,6 @@ Fancy vend uses only one infrequent abm to refresh vendor objects in the event o
|
||||
|
||||
Note: Some clients using mobile and/or older devices, including PCs, may experience additional lag if many fancy vendors are used in a small space, however not to an extent greater than the majority of shops where players use itemframes or pedestals to achieve the same functionality as the fancy vendor's display.
|
||||
|
||||
**Settings:**
|
||||
The following minetest.conf settings can be configured to further modify the appearence of Fancy Vendors:
|
||||
|
||||
`fancy_vend_display_node` - Change the display node to something other than `mcl_core:glass` (ensure mod this node belongs to is in mod.conf)
|
||||
|
||||
`fancy_vend_log_max` - Change the maximum number of logs stored in a vendor's metadata
|
||||
|
||||
`fancy_vend_autorotate_speed` - Change the speed at which the display object rotates
|
||||
|
||||
### User Commands
|
||||
|
||||
User /pay command. Pay emeralds to another player:
|
||||
```
|
||||
/pay <player> <num>
|
||||
```
|
||||
|
||||
User /money command. Show you the emeralds in your bank account in the chat.
|
||||
```
|
||||
/money
|
||||
```
|
||||
|
||||
## More Info
|
||||
|
||||
This mod is for [MineClonia](https://content.minetest.net/packages/ryvnf/mineclonia/) or [MineClone2](https://content.minetest.net/packages/Wuzzy/mineclone2/) Games, dont work with MTG
|
||||
|
||||
Loading…
Reference in New Issue
Block a user