EpicKnarvik97/PlotSquared
1
0
Fork 0
mirror of https://github.com/IntellectualSites/PlotSquared.git synced 2025-06-26 10:44:42 +02:00
Code Issues Projects Releases Wiki Activity

Update README.md and commit code style

Browse Source
This commit is contained in:
sauilitired
2018-08-10 16:52:35 +02:00
parent 3d8d75170d
commit 02ee1e8fa1
3 changed files with 363 additions and 386 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -1,10 +1,9 @@
# PlotSquared [![forthebadge](http://forthebadge.com/images/badges/built-by-developers.svg)](http://forthebadge.com)
[![Join the chat at https://gitter.im/PlotSquared/Lobby](https://badges.gitter.im/PlotSquared/Lobby.svg)](https://gitter.im/PlotSquared/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# 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 also change a lot of plot specific settings in the form of
flags. Such as: weather, time, gamemodes, pvp status.
flags. Such as: weather, time, game modes, pvp status.
Whilst we provide a whole load of unique features, the biggest focus
is to provide a lag-free and smooth experience.
@ -13,21 +12,39 @@ is to provide a lag-free and smooth experience.
### Server Owner
* [Spigot Page](https://www.spigotmc.org/resources/plotsquared.1177/)
* [Discord](https://discord.gg/a6NZPV2)
* [WebChat/IRC]: #IntellectualCrafters on irc.esper.net
* [Wiki](https://github.com/intellectualcrafters/plotsquared/wiki)
* [Website](http://plotsquared.com)
### Developer Resources
* [JavaDocs] Link Temporarily Unavailable
* [Build Server] [![Build Status](http://ci.plotsquared.com/buildStatus/icon?job=PlotSquared)](http://ci.athion.net/job/PlotSquared/)
* [Maven Repo] Link Temporarily Unavailable
* [Build Server](http://ci.athion.net/job/PlotSquared/)
* [Maven Repo](http://ci.athion.net/job/PlotSquared/ws/mvn/)
# Building
Gradle is the **recommended** way to build the project. Use `./gradlew build` in the main project directory to build the project. Gradle is required if you intend to build or develop the Sponge module.
If you prefer to use maven, a `pom.xml` file is provided for working with the Bukkit part of the plugin.
# 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.
If you feel like you can improve the plugin any way, then you are
more than welcome to contribute to PlotSquared. It would be highly
appreciated if you made sure to test your code before committing it,
as it will save us a lot of time and effort.
### Code Style
If you are planning to commit any changes to the project,
it would be highly appreciated if you were to follow the
project code style conventions. To make this easier we have
provided settings that can be imported into your IDE.
**Eclipse:**
`Window > Preferences > Java > Code Style > Formatter`
Press `Import` and select `...path/to/project/code_style.xml`
**IntelliJ:**
`File > Settings > Editor > Code Style`. Next to "Scheme" there is a cog wheel, press that and then
`Import Scheme > IntelliJ IDEA Code Style XML` and then select `..path/to/project/code_style.xml`
# Official Addons
* [Plot2Dynmap](http://www.spigotmc.org/resources/plot2dynmap.1292/)
@ -38,6 +55,4 @@ Feel free to contribute, if you feel like you can improve the plugin in any way.
* [BiomeGenerator](https://www.spigotmc.org/resources/biomegenerator.1663/)
* [PlotSquaredMG](https://www.spigotmc.org/resources/plotsquaredmg.8025/)
* [BasicPlots](https://www.spigotmc.org/resources/basicplots.6901/)
* [HoloPlots](https://www.spigotmc.org/resources/holoplots.4880/)
[WebChat/IRC]: http://webchat.esper.net/?nick=&channels=IntellectualCrafters&fg_color=000&fg_sec_color=000&bg_color=FFF
* [HoloPlots](https://www.spigotmc.org/resources/holoplots.4880/)