From dea80df0954865f4f08ab07c3cdd4f480cbbc928 Mon Sep 17 00:00:00 2001 From: osfanbuff63 <91388253+osfanbuff63@users.noreply.github.com> Date: Sat, 26 Feb 2022 15:40:41 -0500 Subject: [PATCH 1/9] Create Economy.md --- Economy.md | 103 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 Economy.md diff --git a/Economy.md b/Economy.md new file mode 100644 index 0000000..3c3d286 --- /dev/null +++ b/Economy.md @@ -0,0 +1,103 @@ +# EssentialsX Economy +The built in economy API will redirect to any other detected economy system such as vault. This means you can use EssentialsX Economy as a economy API instead of Vault if your plugin is dependent on EssentialsX. + +## Commands +There are a number of commands for use in-game, including but not limited to: + - /eco, /economy: Allows you to take, give, or reset a player's money. + - /sell: Sells an item and amount at the price specified in the worth.yml. + - /balance, /bal, /money: Displays the current balance of a player. + - /baltop, /balancetop: Displays a list of the richest people. + - /pay: Pays a specified player from your balance. + +## Configuration +There are a number of different options related to the internal economy system which can be found in the `config.yml`. +Most of the config options are explained adequately in the comments: + +```yml +# Defines the balance with which new players begin. Defaults to 0. +starting-balance: 0 + +# Defines the cost to use the given commands PER USE. +# Some commands like /repair have sub-costs, check the wiki for more information. +command-costs: + # /example costs $1000 PER USE + #example: 1000 + # /kit tools costs $1500 PER USE + #kit-tools: 1500 + +# Set this to a currency symbol you want to use. +# Remember, if you want to use special characters in this document, +# such as accented letters, you MUST save the file as UTF-8, not ANSI. +currency-symbol: '$' + +# Enable this to make the currency symbol appear at the end of the amount rather than at the start. +# For example, the euro symbol typically appears after the current amount. +currency-symbol-suffix: false + +# Set the maximum amount of money a player can have. +# The amount is always limited to 10 trillion because of the limitations of a java double. +max-money: 10000000000000 + +# Set the minimum amount of money a player can have (must be above the negative of max-money). +# Setting this to 0, will disable overdrafts/loans completely. Users need 'essentials.eco.loan' perm to go below 0. +min-money: -10000 + +# Enable this to log all interactions with trade/buy/sell signs and sell command. +economy-log-enabled: false + +# Enable this to also log all transactions from other plugins through Vault. +# This can cause the economy log to fill up quickly so should only be enabled for testing purposes! +economy-log-update-enabled: false +``` + +EssentialsX adds the ability to specify the minimum transaction amount to prevent the dreaded microtransactions: + +```yml +# Minimum acceptable amount to be used in /pay. +minimum-pay-amount: 0.001 +``` + +EssentialsX adds currency format to improve the localization. You may uncomment the `currency-symbol-format-locale` to use our preformatted styles or uncomment `currency-format` and create your own: + +```yml +# The format of currency, excluding symbols. See currency-symbol-format-locale for symbol configuration. +# +# "#,##0.00" is how the majority of countries display currency. +#currency-format: "#,##0.00" + +# Format currency symbols. Some locales use , and . interchangeably. +# Some formats do not display properly in-game due to faulty Minecraft font rendering. +# +# For 1.234,50 use de-DE +# For 1,234.50 use en-US +# For 1'234,50 use fr-ch +#currency-symbol-format-locale: en-US +``` + +#### Permissions +[Permissions for commands can be found here](https://essinfo.xeya.me/permissions.html) (Community maintained list) + +Important permissions include `essentials.eco` and `essentials.pay`. + +## Signs & Shops +Signs may be used to create shops where players can buy and sell items/blocks to and from the server in exchange for money. + +#### Signs +To create a sign, ensure that you have the `signs.create.trade` permission and that you have uncommented `- buy` and `- sell` under `enabledSigns:` in the config.yml +Signs follow the format: +``` +[Buy]/[Sell] +Quantity +[Material](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html) +Cost +``` +###### Example: +What is typed into the sign UI | Essentials will turn the `[Buy]`/`[Sell]` blue when done sucessfully +:-------------------------------:|:-------------------------------: +| ![Image of Sign Creation UI](/images/EcoBuySignUI.png?v=4&s=360) | ![Image of Completed Buy/Sell Signs](/images/EcoBuySellSign.png?v=4&s=400) | + +The sign will allow players with the `signs.use.buy` permission to purchase 1 dirt for $1 when left clicked. If `[Buy]` is changed to `[Sell]` and the player has the respective permission, the player may sell 1 dirt to the server in exchange for $1. +#### Shops +To prevent players exploiting the the economy by purchasing from the server using a buy sign and `/sell`, only create Buy signs at or above the rates found in `worth.yml`. +A good server shop typically offers bulk Sell signs at better rates than the `worth.yml` to encourage players to use the shop over `/sell`. +Alternatively, if players aren't given the `essentials.sell` permission, their only option is to trade between players or go to the shop. From 57079706065747ff065ec766ec38b77b4c1863bb Mon Sep 17 00:00:00 2001 From: osfanbuff63 <91388253+osfanbuff63@users.noreply.github.com> Date: Sat, 26 Feb 2022 15:46:13 -0500 Subject: [PATCH 2/9] Begin changes to economy page --- Economy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Economy.md b/Economy.md index 3c3d286..fc7af3d 100644 --- a/Economy.md +++ b/Economy.md @@ -1,5 +1,5 @@ # EssentialsX Economy -The built in economy API will redirect to any other detected economy system such as vault. This means you can use EssentialsX Economy as a economy API instead of Vault if your plugin is dependent on EssentialsX. +EssentialsX comes with a simple, easy-to-use economy system. The built in economy API will redirect to any other detected economy system such as vault. This means you can use EssentialsX Economy as a economy API instead of Vault if your plugin is dependent on EssentialsX. ## Commands There are a number of commands for use in-game, including but not limited to: From a045efe88d4963f8005f7135074cbd02c89a1513 Mon Sep 17 00:00:00 2001 From: osfanbuff63 <91388253+osfanbuff63@users.noreply.github.com> Date: Tue, 1 Mar 2022 20:35:24 -0500 Subject: [PATCH 3/9] Continue changes Bulk of the changes here, but not done on the shops section yet. --- Economy.md | 22 ++++------------------ 1 file changed, 4 insertions(+), 18 deletions(-) diff --git a/Economy.md b/Economy.md index fc7af3d..d219a43 100644 --- a/Economy.md +++ b/Economy.md @@ -75,29 +75,15 @@ EssentialsX adds currency format to improve the localization. You may uncomment ``` #### Permissions -[Permissions for commands can be found here](https://essinfo.xeya.me/permissions.html) (Community maintained list) +Players need permissions to use economy commands. For example, you can grant them the `essentials.pay` permission to allow them to use `/pay`. -Important permissions include `essentials.eco` and `essentials.pay`. +Permissions for other economy commands can be found on [the EssentialsX permissions list](https://essinfo.xeya.me/permissions.html) (community maintained list). ## Signs & Shops Signs may be used to create shops where players can buy and sell items/blocks to and from the server in exchange for money. #### Signs -To create a sign, ensure that you have the `signs.create.trade` permission and that you have uncommented `- buy` and `- sell` under `enabledSigns:` in the config.yml -Signs follow the format: -``` -[Buy]/[Sell] -Quantity -[Material](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html) -Cost -``` -###### Example: -What is typed into the sign UI | Essentials will turn the `[Buy]`/`[Sell]` blue when done sucessfully -:-------------------------------:|:-------------------------------: -| ![Image of Sign Creation UI](/images/EcoBuySignUI.png?v=4&s=360) | ![Image of Completed Buy/Sell Signs](/images/EcoBuySellSign.png?v=4&s=400) | +Most economy commands can be used on signs, such as [buy], [sell], or [trade]. You can find an in-depth tutorial at [the original Essentials wiki](https://wiki.mc-ess.net/wiki/Sign_Tutorial) -The sign will allow players with the `signs.use.buy` permission to purchase 1 dirt for $1 when left clicked. If `[Buy]` is changed to `[Sell]` and the player has the respective permission, the player may sell 1 dirt to the server in exchange for $1. #### Shops -To prevent players exploiting the the economy by purchasing from the server using a buy sign and `/sell`, only create Buy signs at or above the rates found in `worth.yml`. -A good server shop typically offers bulk Sell signs at better rates than the `worth.yml` to encourage players to use the shop over `/sell`. -Alternatively, if players aren't given the `essentials.sell` permission, their only option is to trade between players or go to the shop. +WIP From baaafee0204dc34d944026794cdf1775053efe6f Mon Sep 17 00:00:00 2001 From: osfanbuff63 <91388253+osfanbuff63@users.noreply.github.com> Date: Fri, 4 Mar 2022 10:51:28 -0500 Subject: [PATCH 4/9] Update Economy.md --- Economy.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/Economy.md b/Economy.md index d219a43..2d476d5 100644 --- a/Economy.md +++ b/Economy.md @@ -1,16 +1,17 @@ # EssentialsX Economy -EssentialsX comes with a simple, easy-to-use economy system. The built in economy API will redirect to any other detected economy system such as vault. This means you can use EssentialsX Economy as a economy API instead of Vault if your plugin is dependent on EssentialsX. +EssentialsX comes with a simple, easy-to-use economy system built into the plugin. ## Commands -There are a number of commands for use in-game, including but not limited to: - - /eco, /economy: Allows you to take, give, or reset a player's money. - - /sell: Sells an item and amount at the price specified in the worth.yml. - - /balance, /bal, /money: Displays the current balance of a player. - - /baltop, /balancetop: Displays a list of the richest people. - - /pay: Pays a specified player from your balance. +There are a number of commands that players and admins can use in-game, including: + - `/eco`, `/economy`: Allows admins to take, give, or reset a player's money. + - `/sell`: Sells an item and amount at the price specified in the worth.yml. + - `/balance`, `/bal`, `/money`: Displays the current balance of a player. + - `/baltop`, `/balancetop`: Displays a list of the richest people. + - `/pay`: Pays a specified player from your balance. ## Configuration -There are a number of different options related to the internal economy system which can be found in the `config.yml`. +There are a number of different options related to EssentialsX's economy features which can be found in the `config.yml`. + Most of the config options are explained adequately in the comments: ```yml @@ -87,3 +88,6 @@ Most economy commands can be used on signs, such as [buy], [sell], or [trade]. Y #### Shops WIP + +## For plugin developers +EssentialsX's built-in economy API will redirect to any other detected economy system such as Vault. This means you can use EssentialsX's economy as a economy API instead of Vault if your plugin is dependent on EssentialsX. \ No newline at end of file From 33e5e54a4b799912506ada50bb0b0dcecf1d88dd Mon Sep 17 00:00:00 2001 From: osfanbuff63 <91388253+osfanbuff63@users.noreply.github.com> Date: Thu, 17 Mar 2022 10:14:12 -0400 Subject: [PATCH 5/9] Rephrase some things --- Economy.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Economy.md b/Economy.md index 2d476d5..d641f80 100644 --- a/Economy.md +++ b/Economy.md @@ -1,12 +1,12 @@ # EssentialsX Economy -EssentialsX comes with a simple, easy-to-use economy system built into the plugin. +EssentialsX comes with a simple, easy-to-use economy system built into the plugin. ## Commands There are a number of commands that players and admins can use in-game, including: - - `/eco`, `/economy`: Allows admins to take, give, or reset a player's money. - - `/sell`: Sells an item and amount at the price specified in the worth.yml. + - `/eco`, `/economy`: Allows admins to take, give, or reset any player's money. + - `/sell`: Sells an item and amount at the price specified in the `worth.yml` file. - `/balance`, `/bal`, `/money`: Displays the current balance of a player. - - `/baltop`, `/balancetop`: Displays a list of the richest people. + - `/baltop`, `/balancetop`: Displays a list of the people with the highest balance in your server. - `/pay`: Pays a specified player from your balance. ## Configuration From 2e8a321a193093b8091414273cad71a1f45c0e1f Mon Sep 17 00:00:00 2001 From: osfanbuff63 <91388253+osfanbuff63@users.noreply.github.com> Date: Thu, 17 Mar 2022 15:23:32 -0400 Subject: [PATCH 6/9] Merge signs and shops --- Economy.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/Economy.md b/Economy.md index d641f80..928d8f5 100644 --- a/Economy.md +++ b/Economy.md @@ -80,14 +80,8 @@ Players need permissions to use economy commands. For example, you can grant the Permissions for other economy commands can be found on [the EssentialsX permissions list](https://essinfo.xeya.me/permissions.html) (community maintained list). -## Signs & Shops -Signs may be used to create shops where players can buy and sell items/blocks to and from the server in exchange for money. - -#### Signs -Most economy commands can be used on signs, such as [buy], [sell], or [trade]. You can find an in-depth tutorial at [the original Essentials wiki](https://wiki.mc-ess.net/wiki/Sign_Tutorial) - -#### Shops -WIP +## Signs +Signs may be used to create shops where players can buy and sell items/blocks to and from the server in exchange for in-game money. Most economy commands can be used on signs, such as [Buy], [Sell], or [Trade]. You can find an in-depth tutorial at [the original Essentials wiki](https://wiki.mc-ess.net/wiki/Sign_Tutorial) ## For plugin developers EssentialsX's built-in economy API will redirect to any other detected economy system such as Vault. This means you can use EssentialsX's economy as a economy API instead of Vault if your plugin is dependent on EssentialsX. \ No newline at end of file From d7596193818ec4857a257f8d8c0817bceed1d8e3 Mon Sep 17 00:00:00 2001 From: osfanbuff63 <91388253+osfanbuff63@users.noreply.github.com> Date: Thu, 17 Mar 2022 15:35:44 -0400 Subject: [PATCH 7/9] More changes --- Economy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Economy.md b/Economy.md index 928d8f5..31ac850 100644 --- a/Economy.md +++ b/Economy.md @@ -1,5 +1,5 @@ # EssentialsX Economy -EssentialsX comes with a simple, easy-to-use economy system built into the plugin. +EssentialsX comes with a simple, easy-to-use economy system built into the core plugin, that you can access mostly through commands (in detail below). ## Commands There are a number of commands that players and admins can use in-game, including: From f252ca912e44dd9b157913ed6eb9109d8874a271 Mon Sep 17 00:00:00 2001 From: osfanbuff63 <91388253+osfanbuff63@users.noreply.github.com> Date: Fri, 18 Mar 2022 20:36:34 -0400 Subject: [PATCH 8/9] Fix a missing period --- Economy.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Economy.md b/Economy.md index 31ac850..b41ecb2 100644 --- a/Economy.md +++ b/Economy.md @@ -75,13 +75,13 @@ EssentialsX adds currency format to improve the localization. You may uncomment #currency-symbol-format-locale: en-US ``` -#### Permissions +### Permissions Players need permissions to use economy commands. For example, you can grant them the `essentials.pay` permission to allow them to use `/pay`. Permissions for other economy commands can be found on [the EssentialsX permissions list](https://essinfo.xeya.me/permissions.html) (community maintained list). ## Signs -Signs may be used to create shops where players can buy and sell items/blocks to and from the server in exchange for in-game money. Most economy commands can be used on signs, such as [Buy], [Sell], or [Trade]. You can find an in-depth tutorial at [the original Essentials wiki](https://wiki.mc-ess.net/wiki/Sign_Tutorial) +Signs may be used to create shops where players can buy and sell items/blocks to and from the server in exchange for in-game money. Most economy commands can be used on signs, such as [Buy], [Sell], or [Trade]. You can find an in-depth tutorial at [the original Essentials wiki](https://wiki.mc-ess.net/wiki/Sign_Tutorial). ## For plugin developers -EssentialsX's built-in economy API will redirect to any other detected economy system such as Vault. This means you can use EssentialsX's economy as a economy API instead of Vault if your plugin is dependent on EssentialsX. \ No newline at end of file +EssentialsX's built-in economy API will redirect to any other detected economy system such as Vault. This means you can use EssentialsX's economy as a economy API instead of Vault if your plugin is dependent on EssentialsX. From f79d4221b5d56df984d162219504248a4bd7097b Mon Sep 17 00:00:00 2001 From: osfanbuff63 <91388253+osfanbuff63@users.noreply.github.com> Date: Fri, 18 Mar 2022 20:37:07 -0400 Subject: [PATCH 9/9] Update Economy.md --- Economy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Economy.md b/Economy.md index b41ecb2..0f9d91b 100644 --- a/Economy.md +++ b/Economy.md @@ -81,7 +81,7 @@ Players need permissions to use economy commands. For example, you can grant the Permissions for other economy commands can be found on [the EssentialsX permissions list](https://essinfo.xeya.me/permissions.html) (community maintained list). ## Signs -Signs may be used to create shops where players can buy and sell items/blocks to and from the server in exchange for in-game money. Most economy commands can be used on signs, such as [Buy], [Sell], or [Trade]. You can find an in-depth tutorial at [the original Essentials wiki](https://wiki.mc-ess.net/wiki/Sign_Tutorial). +Signs may be used to create shops where players can buy and sell items/blocks to and from the server in exchange for in-game money. Most economy commands can be used on signs, such as `[Buy]`, `[Sell]`, or `[Trade]`. You can find an in-depth tutorial at [the original Essentials wiki](https://wiki.mc-ess.net/wiki/Sign_Tutorial). ## For plugin developers EssentialsX's built-in economy API will redirect to any other detected economy system such as Vault. This means you can use EssentialsX's economy as a economy API instead of Vault if your plugin is dependent on EssentialsX.