Update README.MD: WIP frontpage
Frontpage like the BukkitDev and Spigot Resources section.
This commit is contained in:
Thijs Wiefferink
parent
5176a1c2c5
commit
d5a29f6c32
86
README.md
86
README.md
|
|
@ -1,19 +1,79 @@
|
|||
#AreaShop
|
||||
|
||||
|
||||
Check the documentation at http://dev.bukkit.org/bukkit-plugins/regionbuyandrent/
|
||||
▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬<br/>
|
||||
**Usage and configuration:**
|
||||
[►Download (releases)](https://github.com/NLthijs48/AreaShop/releases)
|
||||
[►Commands and Permissions](https://github.com/NLthijs48/AreaShop/wiki/Commands-and-Permissions)
|
||||
[►Basic regions setup](https://github.com/NLthijs48/AreaShop/wiki/Basic-regions-setup)
|
||||
[►Advanced regions setup](https://github.com/NLthijs48/AreaShop/wiki/Advanced-regions-setup)
|
||||
[►Configuration files](https://github.com/NLthijs48/AreaShop/wiki/The-config-system)<br/>
|
||||
**Advanced features:**
|
||||
[►Save/restore region blocks](https://github.com/NLthijs48/AreaShop/wiki/Region-blocks-save-restore)
|
||||
[►Change the language](https://github.com/NLthijs48/AreaShop/wiki/Language-support)
|
||||
[►Limitgroups (setup how many regions players can rent/buy)](https://github.com/NLthijs48/AreaShop/wiki/Limitgroups-information-and-examples)<br/>
|
||||
**Troubleshooting:**
|
||||
[►Frequently Asked Questions](https://github.com/NLthijs48/AreaShop/wiki/Frequently-Asked-Questions)
|
||||
[►Common errors](https://github.com/NLthijs48/AreaShop/wiki/Common-errors)<br/>
|
||||
**Development:**
|
||||
[►Changelog](https://github.com/NLthijs48/AreaShop/wiki/Changelog)
|
||||
[►Compiling](https://github.com/NLthijs48/AreaShop/wiki/Compiling-AreaShop)
|
||||
[►Modules, packages and classes overview](https://github.com/NLthijs48/AreaShop/wiki/Modules,-packages-and-classes-overview)<br/>
|
||||
▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬
|
||||
|
||||
Every time I make a change to the code that is somewhat finished and possibly tested I will push the code to GitHub, this way you can follow the commit log to see the progress.
|
||||
This plugin is for giving players the option to rent or buy a region. It could be used to let them rent a jail in your Prison server or maybe a shop in the market of the Survival server. The player interacts with signs, making it easy to use. It also has a lot of commands to check the status of all regions, manage the renting and buying of a region and also features for admins. Also the plugin is capable of saving the region and restoring it later, this is very flexible and can be set general and per region, check the [config](https://github.com/NLthijs48/AreaShop/wiki/The-config-system) for more information.
|
||||
|
||||
# Compiling AreaShop
|
||||
[Check this wiki page](https://github.com/NLthijs48/AreaShop/wiki/Compiling-AreaShop)
|
||||
## All features in a list
|
||||
* Rent and sell regions to players + Players can resell their bought regions to other players.
|
||||
* [Signs](https://github.com/NLthijs48/AreaShop/wiki/Basic-regions-setup) for easy interacting and current status.
|
||||
* Change the [language](https://github.com/NLthijs48/AreaShop/wiki/Language-support) of the plugin or use of of the already provided language files (check [here](https://github.com/NLthijs48/AreaShop/tree/master/AreaShop/src/main/resources/lang) for supported languages, these are already packed with the plugin, just change the language setting in `config.yml`).
|
||||
* Automatically let the plugin [restore](https://github.com/NLthijs48/AreaShop/wiki/Region-blocks-save-restore) the region with schematics.
|
||||
* Change which [commands](https://github.com/NLthijs48/AreaShop/wiki/Commands-and-Permissions) players can use with [permissions](https://github.com/NLthijs48/AreaShop/wiki/Commands-and-Permissions).
|
||||
* Customize the plugin by changing the [config files](https://github.com/NLthijs48/AreaShop/wiki/The-config-system).
|
||||
* Automatically place the region name on the sign if it is placed inside a region.
|
||||
* Teleport to rent/buy regions and optionally set the teleport location (teleporting is safe and within the region).
|
||||
* Adding friends to regions (which also can teleport then).
|
||||
* Automatic unrent/sell for regions of which the owner is offline for a certain time.
|
||||
* Warning to players when their rent is about to run out (at login and while they are online).
|
||||
* [Group system](https://github.com/NLthijs48/AreaShop/wiki/The-config-system) to set options for a couple of regions instead of all of them.
|
||||
* All heavy tasks are spread over time (each tick a part is executed until done), so the plugin should not cause any lag.
|
||||
* Rent/buy limits can be different per permission node (player group), world or group of regions (possible situation: Normal players can buy 1 market region in survival + 1 build region in survival and 2 plots in creative, while VIPs have double limits for all those), [check these examples](https://github.com/NLthijs48/AreaShop/wiki/Limitgroups-information-and-examples).
|
||||
* Supports name changes because of saving player info by UUID, for more details check the FAQ entry: [What happens when a player changes his name?](https://github.com/NLthijs48/AreaShop/wiki/Frequently-Asked-Questions#what-happens-when-a-player-changes-his-name).
|
||||
|
||||
#### Description of packages and classes
|
||||
Check [this page](https://github.com/NLthijs48/AreaShop/wiki/Modules,-packages-and-classes-overview) on the wiki.
|
||||
You need to have WorldEdit, WorldGuard and Vault installed on your server, WorldGuard is used for creating and managing regions, WorldEdit for the saving and restoring the blocks in regions and Vault is used to let players pay for the regions.
|
||||
|
||||
#### Questions
|
||||
If you have any questions about how to use AreaShop or how to change the code of AreaShop then feel free to message me. You can reach me through [BukkitDev](http://dev.bukkit.org/profiles/NLThijs48/) or [Spigot](http://www.spigotmc.org/members/nlthijs48.15658/).
|
||||
## Tutorial & Feature overview (V2.0.1 of AreaShop)
|
||||
**Made by [[https://www.youtube.com/user/koz4christ|Koz4Christ]]**
|
||||
<<youtube 328WrStVkzs>>
|
||||
|
||||
#### TODO
|
||||
- Guide for saving custom data for the AreaShop regions
|
||||
- Starting guide, which methods to use to get regions etc.
|
||||
- -
|
||||
## Advanced Prison cell setup tutorial (V2.1.0 of AreaShop)
|
||||
**Made by [[https://www.youtube.com/user/PerkulatorTime|PerkulatorTime]]**
|
||||
<<youtube OQOsOG-EdNc>>
|
||||
|
||||
Old video for AreaShop v1.0: [Tutorial by VariationVault](https://www.youtube.com/watch?v=k2HMCxCCOYo)
|
||||
|
||||
## Planned features
|
||||
[Click here](https://github.com/NLthijs48/AreaShop/labels/Feature) to check the list of planned features (GitHub issues).
|
||||
|
||||
Are you interested in following the development of AreaShop? Check the commits on the [master branch on GitHub](https://github.com/NLthijs48/AreaShop/commits/master) and/or the [issues list](https://github.com/NLthijs48/AreaShop/issues?q=sort%3Aupdated-desc) to see what I'm doing.
|
||||
|
||||
## Metrics
|
||||
This plugin utilizes Hidendra's plugin metrics system, which means that the following information is collected and sent to mcstats.org:
|
||||
|
||||
*A unique identifier, the server's version of Java, whether the server is in offline or online mode, the plugin's version, the server's version, the OS version/name and architecture, the core count for the CPU, the number of players online, the Metrics version.*
|
||||
|
||||
This information will give me an indication how much the plugin is used and encourages me to continue development. Opting out of this service can be done by setting `sendStats` in the config of this plugin to `false`, if you want to disable Metrics for any plugin go to `plugins/Plugin Metrics/config.yml` and change `opt-out` to `true`. Check graphs of the statistics at this page: [mcstats.org/plugin/AreaShop](http://mcstats.org/plugin/AreaShop)
|
||||
|
||||
|
||||
|
||||
## Do you want to translate AreaShop?
|
||||
Help translating the plugin into different languages and to keep the translations up to date. Go to [this page](https://github.com/NLthijs48/AreaShop/wiki/Language-support#translating-on-transifex) for more information. Translating goes through the [Transifex](https://www.transifex.com/projects/p/areashop/) website and is very easy, sending files back and forth is not needed, you can translate lines online and whenever you want. Every line you translate will be saved, no need to do it all at once (this also allows for easy collaboration).
|
||||
|
||||
[](https://www.paypal.com/cgi-bin/webscr?return=http%3A%2F%2Fdev.bukkit.org%2Fbukkit-plugins%2Fregionbuyandrent%2F&cn=Add+special+instructions+to+the+addon+author%28s%29&business=nlthijs48%40gmail.com&bn=PP-DonationsBF%3Abtn_donateCC_LG.gif%3ANonHosted&cancel_return=http%3A%2F%2Fdev.bukkit.org%2Fbukkit-plugins%2Fregionbuyandrent%2F&lc=US&item_name=AreaShop+%28from+Bukkit.org%29&cmd=_donations&rm=1&no_shipping=1¤cy_code=USD)
|
||||
|
||||
AreaShop can also be found in the [Resources section of Spigot](http://www.spigotmc.org/resources/areashop.2991/), if you use AreaShop with Spigot then please leave a review there.
|
||||
|
||||
**Did you encounter a bug? Check the [buglist](https://github.com/NLthijs48/AreaShop/labels/Bug), or [create a bug report](https://github.com/NLthijs48/AreaShop/issues/new?body=Indicate%20the%20steps%20you%20did%20while%20encountering%20the%20problem,%20the%20expected%20outcome,%20and%20the%20actual%20outcome.%20Provide%20links%20to%20your%20config.yml,%20default.yml%20and%20groups.yml%20files%20(use%20pastebin.com%20or%20similar).%20Also%20provide%20a%20full%20startup%20log%20of%20your%20server%20(this%20indicates%20the%20plugin%20versions%20used).&labels=Bug) yourself.**
|
||||
|
||||
**Do you have a feature request? Check the [requested features list](https://github.com/NLthijs48/AreaShop/labels/Feature), or [add a feature request](https://github.com/NLthijs48/AreaShop/issues/new?body=Describe%20the%20feature%20with%20as%20much%20detail%20as%20possible:%20command,%20permissions,%20messages%20in%20chat,%20etc.%20Also%20indicate%20for%20which%20situations%20you%20would%20use%20it%20and%20why%20it%20should%20be%20added.&labels=Feature) yourself.**
|
||||
|
||||
**Do you have a question about the plugin? First check the [Frequently Asked Questions](https://github.com/NLthijs48/AreaShop/wiki/Frequently-Asked-Questions) page, if your question is not answered there then please [make a support ticket](https://github.com/NLthijs48/AreaShop/issues/new?body=Indicate%20the%20steps%20you%20did%20while%20encountering%20the%20problem,%20the%20expected%20outcome,%20and%20the%20actual%20outcome.%20Provide%20links%20to%20your%20config.yml,%20default.yml%20and%20groups.yml%20files%20(use%20pastebin.com%20or%20similar).%20Also%20provide%20a%20full%20startup%20log%20of%20your%20server%20(this%20indicates%20the%20plugin%20versions%20used).&labels=Support).**
|
||||
|
|
|
|||
Loading…
Reference in New Issue