Beginnings of Economy page #10
Conversation
ice-fly
commented
May 20, 2020
ice-fly
commented
- Begin resolving Add economy page #1
- Added images
Add sign creation images for Eco page
* Create Economy.md Begin resolving #1 Referenced old essentials wiki. Added new config options with their explanation. Added how to use signs with economy. Still needs: Explain how to use an alternative economy plugin * Add images for Eco Page Two images: 1. Shows what is typed 2. Shows the resulting Buy/Sell sign * Update Economy.md
Used `inline code` for all refrences to config-yml names. Resized & moved images to example section. Re-added multiline code section about sign formatting *(Still not certain on best way to communicate the format)*
Fix images through use of table & minor formatting
| @@ -0,0 +1,93 @@ | |||
| # EssentialsX Economy | |||
| The built in economy API will redirect to any other detected economy system such as vault. This means you can use EssEco api as a economy api instead of vault if your plugin is dependent on Essentials. | |||
There was a problem hiding this comment.
IMO the start of the page should explain what the economy is, perhaps something like "EssentialsX comes with a simple, easy-to-use economy system built into the plugin." or similar?
This part about the API should probably be in a separate section at the bottom, since it's only useful to developers and doesn't mean much to most people who want to use EssentialsX.
(Also tiny nitpicks: "vault" should be "Vault", "EssEco" should be "EssentialsX's economy", "api" should be "API")
| #### 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 | ||
| :-------------------------------:|:-------------------------------: | ||
| |  |  | | ||
|
|
||
| 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. |
There was a problem hiding this comment.
The signs are already explained on the old original Essentials wiki, and it thoroughly explains all the signs already (including [trade] which is missing here). I'd prefer it if this section just mentions that [trade], [buy] and [sell] exist and then linked to that page. We can add our own page for signs later down the line.
| #### 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. |
There was a problem hiding this comment.
This should probably be replaced by a section explaining /setworth, /worth and /sell. The bit about sign shops should be included in the sign shops section.
| ## 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 |
There was a problem hiding this comment.
The essentials.signs.<action>.trade permissions are for the [trade] sign, which this section doesn't actually explain. The buy and sell permissions are for the [buy] and [sell] signs respectively. This also doesn't explain that players need to be given permissions to use the signs too, or that creating [buy] and [sell] should be limited to admins only.
|
Hey there, we're deprecating this repository in favour of https://github.com/EssentialsX/Website. The content from this repository has moved to the Since this PR seems to be abandoned and #23 replaces it, I'm going to close this. |
