mirror of
https://github.com/IntellectualSites/PlotSquared.git
synced 2024-11-26 15:16:45 +01:00
commit
821e828f07
138
README.md
138
README.md
@ -1,71 +1,67 @@
|
||||
<p align="center">
|
||||
<img src="https://i.imgur.com/Kd7N6uf.png">
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
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, 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.
|
||||
|
||||
## Links
|
||||
|
||||
* [Download](https://github.com/IntellectualSites/PlotSquared/releases/tag/dev)
|
||||
* [Jenkins](https://ci.athion.net/job/PlotSquared/)
|
||||
* [Spigot Page](https://www.spigotmc.org/resources/plotsquared.1177/)
|
||||
* [Discord](https://discord.gg/a6NZPV2)
|
||||
* [WebChat/IRC]: #IntellectualCrafters on irc.esper.net
|
||||
* [Discord](https://discord.gg/ngZCzbU)
|
||||
* [Wiki](https://github.com/intellectualcrafters/plotsquared/wiki)
|
||||
|
||||
### Developer Resources
|
||||
* [JavaDocs](http://empcraft.com/plotsquared/doc/)
|
||||
* [[Git Mirror](https://incendo.org/git/sauilitired/PlotSquared/)]
|
||||
* [[Build Server](http://ci.athion.net/job/PlotSquared/)] [[Alternative](https://incendo.org/ci/job/PlotSquared/)]
|
||||
* [[Maven Repo](http://ci.athion.net/job/PlotSquared/ws/mvn/)] [[Alternative](https://incendo.org/ci/job/PlotSquared/ws/mvn/)]
|
||||
* [API Documentation](https://github.com/IntellectualSites/PlotSquared/wiki/Developer-documentation-(WIP))
|
||||
|
||||
# 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
|
||||
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`
|
||||
|
||||
## Suggestions
|
||||
Suggestions are welcome! We have a separate issue tracker for suggestions, that can be found in [this](https://github.com/IntellectualSites/PlotSquaredSuggestions) repository.
|
||||
|
||||
# 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/)
|
||||
* [PlotZSux](https://www.spigotmc.org/resources/plotzsux.9563/)
|
||||
* [IslandPlots](https://www.spigotmc.org/resources/islandplots.9421/)
|
||||
* [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]: https://webchat.esper.net/?nick=&channels=IntellectualCrafters
|
||||
<p align="center">
|
||||
<img src="https://i.imgur.com/Kd7N6uf.png">
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
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, 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.
|
||||
|
||||
## Links
|
||||
|
||||
* [Download](https://github.com/IntellectualSites/PlotSquared/releases/tag/dev)
|
||||
* [Jenkins](https://ci.athion.net/job/PlotSquared/)
|
||||
* [Spigot Page](https://www.spigotmc.org/resources/plotsquared.1177/)
|
||||
* [Discord](https://discord.gg/ngZCzbU)
|
||||
* [Wiki](https://github.com/intellectualcrafters/plotsquared/wiki)
|
||||
|
||||
### Developer Resources
|
||||
* [JavaDocs](http://empcraft.com/plotsquared/doc/)
|
||||
* [[Git Mirror](https://incendo.org/git/sauilitired/PlotSquared/)]
|
||||
* [[Build Server](http://ci.athion.net/job/PlotSquared/)] [[Alternative](https://incendo.org/ci/job/PlotSquared/)]
|
||||
* [[Maven Repo](http://ci.athion.net/job/PlotSquared/ws/mvn/)] [[Alternative](https://incendo.org/ci/job/PlotSquared/ws/mvn/)]
|
||||
* [API Documentation](https://github.com/IntellectualSites/PlotSquared/wiki/Developer-documentation-(WIP))
|
||||
|
||||
# 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
|
||||
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`
|
||||
|
||||
## Suggestions
|
||||
Suggestions are welcome! We have a separate issue tracker for suggestions, that can be found in [this](https://github.com/IntellectualSites/PlotSquaredSuggestions) repository.
|
||||
|
||||
# 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/)
|
||||
* [PlotZSux](https://www.spigotmc.org/resources/plotzsux.9563/)
|
||||
* [IslandPlots](https://www.spigotmc.org/resources/islandplots.9421/)
|
||||
* [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/)
|
@ -16,6 +16,7 @@ buildscript {
|
||||
}
|
||||
|
||||
plugins {
|
||||
id 'maven-publish'
|
||||
id 'io.franzbecker.gradle-lombok' version '1.14'
|
||||
}
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user