From 0e63df608f90248d93af5d40427d6041a490df53 Mon Sep 17 00:00:00 2001
From: PretzelJohn <58197328+PretzelJohn@users.noreply.github.com>
Date: Tue, 11 Jan 2022 04:53:06 -0500
Subject: [PATCH] * Update readme to document new features
---
README.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++-----
1 file changed, 63 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index ad39b02..9b39c4e 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,8 @@
by PretzelJohn
Description:
-This Minecraft plugin limits the villager trade deals that players can get when they cure a zombie villager.
+This Minecraft plugin limits the villager trade deals that players can get.
+Click here to see this plugin on Spigot.
Commands:
@@ -15,12 +16,22 @@
/villagertradelimiter |
/vtl |
- shows a help message |
+ Shows a help message |
/villagertradelimiter reload |
/vtl reload |
- reloads config.yml |
+ Reloads config.yml |
+
+
+ /villagertradelimiter see <player> |
+ /vtl see <player> |
+ Shows the trades for another player. To use, look at the villager you want to see the trades for. |
+
+
+ /villagertradelimiter invsee |
+ /vtl invsee |
+ Shows the inventory of a villager. To use, look at the villager you want to see the trades for. |
@@ -33,7 +44,7 @@
villagertradelimiter.* |
- Allows players to use /vtl and /vtl reload |
+ Allows players to use ALL commands |
OP |
@@ -46,6 +57,16 @@
Allows players to reload config.yml and messages.yml |
OP |
+
+ villagertradelimiter.see |
+ Allows players to see the trades for another player with /vtl see <player> |
+ OP |
+
+
+ villagertradelimiter.invsee |
+ Allows players to see inventory of a villager with /vtl invsee |
+ OP |
+
Config:
@@ -61,6 +82,38 @@
bStats: |
This helps me keep track of what server versions are being used. Please leave this set to true. |
+
+ database.mysql: |
+ Whether to use MySQL for the database (true) or SQLite (false) |
+
+
+ database.host: |
+ The IP address or domain name of your MySQL server. If the MySQL database is on the same server as your Minecraft server, leave this as 127.0.0.1 |
+
+
+ database.port: |
+ The port number of your MySQL server. Usually 3306 . |
+
+
+ database.database: |
+ The name of your MySQL database, or schema. You must create a database (schema) before using this plugin! |
+
+
+ database.username: |
+ The username to access your MySQL database. |
+
+
+ database.password: |
+ The password to access your MySQL database. |
+
+
+ database.encoding: |
+ If your MySQL database uses an encoding other than utf8 , change this. |
+
+
+ database.useSSL: |
+ If your MySQL database can use SSL connections, set this to true ! |
+
DisableTrading: |
Whether to disable all villager trading for all worlds, some worlds, or no worlds. Options:
@@ -139,11 +192,15 @@
| Sets the maximum number of times a player can make the trade before the villager is out of stock |
- .Item1.Material:
.Item2.Material: |
+ .Cooldown: |
+ Sets the time between restocks for the trade, and applies to ALL villagers. Once the player reaches the MaxUses , the cooldown begins. The trade is disabled for all villagers until the cooldown expires. FORMAT: <Number><interval> EXAMPLE: 30s = 30 seconds, 5m = 5 minutes, 4h = 4 hours, 7d = 7 days |
+
+
+ .Item1.Material:
.Item2.Material:
.Result.Material: |
Sets the material of the 1st or 2nd item in the trade WARNING: This cannot be undone! |
- .Item1.Amount:
.Item2.Amount: |
+ .Item1.Amount:
.Item2.Amount:
.Result.Amount: |
Sets the amount of the 1st or 2nd item in the trade WARNING: This cannot be undone! |