TotalFreedomMC/TF-PlotSquared
1
0
Fork 0
mirror of https://github.com/TotalFreedomMC/TF-PlotSquared.git synced 2024-12-23 00:15:06 +00:00
Code Issues Projects Releases Wiki Activity

Update README

Browse source
This commit is contained in:
Sauilitired 2015-07-14 16:56:35 +02:00
parent 0a26ed8f8e
commit 35fa448252
1 changed files with 22 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -1,20 +1,28 @@
PlotSquared Official Repo
==========================================================
PlotSquared - Plot Plugin Extraordinaire.
# PlotSquared
For the end user, PlotSquared is packed with a tonne of cool features. It allows you to merge plots, and build together with your friends. You can alos change a lot of plot specific settings, such as weather and time, or even toggle gamemodes and pvp allowance.
## Compile: ##
Build the project using your favourite compiler (maven is the recommended way to build), then package the jar using `mvn package` **MAVEN IS REQUIRED TO BUILD AND PACKAGE THE JAR**
The most important thing, however, is not a whole load of features. Because, if the server is unable to run the plugin with efficiency, then the features won't matter. That's why we have focused heavily on making PlotSquared as fast and lightweight as possible. PlotSquared runs well even with hundreds of thousands of plots. Plot clearing is near instant, and you can keep your world clean with lots of use functions, such as: plot purging, condensation, automatic expirty, world trimming, dynamic world-borders, chunk-processor and more...
## API: ##
The main API class can be found [here](https://github.com/IntellectualCrafters/PlotSquared/blob/master/PlotSquared/src/main/java/com/intellectualcrafters/plot/api/PlotAPI.java "API"). JavaDoc's can be found [here](http://empcraft.com/plotsquared/doc/ "JDOCS").
## Links
## Links: ##
### Server Owner
* [Spigot Page](https://www.spigotmc.org/resources/plotsquared.1177/)
* [WebChat/IRC](http://webchat.esper.net/?nick=&channels=IntellectualCrafters&fg_color=000&fg_sec_color=000&bg_color=FFF)
* [Wiki](https://github.com/intellectualcrafters/plotsquared/wiki)
* [Website](http://plotsquared.co)
- [Spigot Page](http://www.spigotmc.org/resources/plotsquared.1177/ "SpigotMc")
- [Bukkit Page](http://dev.bukkit.org/bukkit-plugins/plotsquared/ "Bukkit")
### Developer Resources
* [JavaDocs](http://empcraft.com/plotsquared/doc/)
* [Build Server](http://ci.nixium.com/job/PlotSquared/)
## Addons ##
- [Plot2Dynmap](http://www.spigotmc.org/resources/plot2dynmap.1292/ "Plot2Dynmap")
- [AdvPlots](http://www.spigotmc.org/resources/advplots-%CE%B2.1500/ "AdvPlots")
- [PlotRankup](http://www.spigotmc.org/resources/plotrankup.1571/ "PlotRankup")
# Building
Build the project using your favourite compiler (maven is the recommended way to build), then package the jar using `mvn package`.
# Contributing
Feel free to contribute, if you feel like you can improve the plugin in any way. Make sure to test your code before sending it away from us, as committing broken code will block you from future contribution.
# Official Addons
* [Plot2Dynmap](http://www.spigotmc.org/resources/plot2dynmap.1292/)
* [AdvPlots](http://www.spigotmc.org/resources/advplots-%CE%B2.1500/)
* [PlotRankup](http://www.spigotmc.org/resources/plotrankup.1571/)