diff --git a/Home.md b/Home.md index bb555f0..d560e01 100644 --- a/Home.md +++ b/Home.md @@ -1,51 +1,61 @@ -_[(If you are looking for the developer documentation, please visit this page)](https://github.com/IntellectualCrafters/PlotSquared/wiki/Developer-documentation-(WIP))_ +# `PlotSquared` +#### Plot plugin by Citymonstret & Empire92 & MBon29 + - ### [`IRC`](http://webchat.esper.net/?nick=&channels=IntellectualCrafters&fg_color=000&fg_sec_color=000&bg_color=FFF) + - ### [`Discord`](https://discord.gg/JktPC) + - ### [`Source`](https://github.com/IntellectualSites/PlotSquared) + - ### [`Dev Builds`](https://ci.athion.net/job/PlotSquared/) + - ### [`JavaDocs`](http://empcraft.com/plotsquared/doc/) + + *** -#### PlotSquared is currently in development, and we are continually making improvements -You shouldn't run a server with an inadequate plot plugin. PlotSquared was created to be fast, efficient, and scalable. It comes as a world generator and a complete plot management system. Action packed with loads of cool features, complete control and configuration, and a rock solid API for other plugins to hook into. Why not try it out? - -For those of you that currently use PlotMe, the conversion process is is fast and simple. There are instructions below if you need help. - -## Features -* Fast and Efficient -* Multiworld -* PlotMe Converter -* MySQL and SQLite integration -* Plot Merging -* Instant plot clearing -* Mob protection -* Extensive flag system for plots -* Four tiers of plot allowance (Owner, Helper, Trusted, Denied) -* Web interface to upload/download schematics for your plot -* Configurable messages -* Configurable plot generation -* Plot naming -* Solid API -* WorldEdit restricted to plots -* VoxelSniper restricted to plots (with VoxelSniperRegions plugin) -* WorldGuard support for plot flags -* Supports non square plots (with AdvPlots addon) -* Dynmap integration (with Plot2Dynmap addon) -* Metrics (disable in config) +# `Wiki Links` +## > [Developer API documentation](https://github.com/IntellectualCrafters/PlotSquared/wiki/Developer-documentation-(WIP)) < ## Installation -An overview can be found on the [[installation]] page - -## Usage -An overview can be found on the [[usage]] page - -## Commands and Permissions -An overview can be found on the [[commands and permissions]] page - -## Add-ons -* [PlotWebPHP](http://empcraft.com/plotsquared/plotwebphp.zip) (PlotSquared web interface) -* [Plot2Dynmap](http://www.spigotmc.org/resources/plot2dynmap.1292/) (required for dynmap integration) -* [AdvPlots](http://www.spigotmc.org/resources/advplots-%CE%B2.1500/) (For schematic based world generation) -* [BasicPlots](http://www.spigotmc.org/resources/basicplots.6901/) (plot generator with 1 plot per chunk) -* [BiomeGenerator](http://www.spigotmc.org/resources/biomegenerator.1663//) (Generate natural biomes in your plots) -* [PlotRankup](http://www.spigotmc.org/resources/plotrankup.1571/) (Plot rankup and approval system) -* [VoxelSniperRegions](http://dev.bukkit.org/bukkit-plugins/vsr/) (used to restrict VoxelSniper to plots) -* [HoloPlots](http://www.spigotmc.org/resources/holoplots.4880/) (display plot info on holograms) -* [RedstoneClockPreventer2](http://www.spigotmc.org/resources/redstoneclockpreventer-2.6678/) (Prevent clocks) -* [WorldEdit](http://dev.bukkit.org/bukkit-plugins/worldedit/) (can be restricted to plots) -* [PlotMe](http://dev.bukkit.org/bukkit-plugins/plotme/) (for conversion purposes) \ No newline at end of file + - ### [`Setup`](https://github.com/IntellectualCrafters/PlotSquared/wiki/Installation#initial-setup) + - ### [`Usage`](https://github.com/IntellectualSites/PlotSquared/wiki/Usage) + - ### [`Permissions`](https://github.com/IntellectualSites/PlotSquared/wiki/Commands-and-Permissions) +###### World Creation + - [PlotMe conversion](https://github.com/IntellectualCrafters/PlotSquared/wiki/Installation#plotme-conversion-optional) + - [Standard Creation](https://github.com/IntellectualCrafters/PlotSquared/wiki/Installation#world-creation) + - [Augmented Partial](https://github.com/IntellectualCrafters/PlotSquared/wiki/Augmented-Plot-Worlds) + - [Augmented custom](https://github.com/IntellectualCrafters/PlotSquared/wiki/TerrainControl) +###### Further installation + - [Road schematics](https://github.com/IntellectualCrafters/PlotSquared/wiki/Installation#adding-road-schematics) + - [settings.yml](https://github.com/IntellectualCrafters/PlotSquared/wiki/Example-configuration) + - [commands.yml](https://github.com/IntellectualSites/PlotSquared/wiki/commands.yml) + - [worlds.yml](https://github.com/IntellectualSites/PlotSquared/wiki/worlds.yml) + - [PlotSquared.use_THIS.yml](https://github.com/IntellectualCrafters/PlotSquared/wiki/translations) + - [style.yml](https://github.com/IntellectualCrafters/PlotSquared/wiki/styles) + - [templates](https://github.com/IntellectualCrafters/PlotSquared/wiki/templates) + - [UUID conversion](https://github.com/IntellectualSites/PlotSquared/wiki/UUID-conversion) + - [ChestShop Compatibility](https://github.com/IntellectualSites/PlotSquared/wiki/ChestShop-Compatibility) +#### Commands + - [Base permissions](https://github.com/IntellectualCrafters/PlotSquared/wiki/Commands-and-Permissions#base-permissions) + - [Bypass permissions](https://github.com/IntellectualCrafters/PlotSquared/wiki/Commands-and-Permissions#admin-bypass-permissions) + - [Main commands](https://github.com/IntellectualSites/PlotSquared/wiki/Commands) + - [Cluster commands](https://github.com/IntellectualCrafters/PlotSquared/wiki/Commands-and-Permissions#cluster-commands) +#### Usage +###### Customization + - [Translation](https://github.com/IntellectualCrafters/PlotSquared/wiki/translations) + - [Command aliases](https://github.com/IntellectualCrafters/PlotSquared/wiki/aliases) + - [Web interface](https://github.com/IntellectualSites/PlotSquared/wiki/Plot-web-interface) +###### World optimization + - [Border](https://github.com/IntellectualCrafters/PlotSquared/wiki/World-reduction#world-border) + - [Expiry](https://github.com/IntellectualCrafters/PlotSquared/wiki/World-reduction#plot-expiry) + - [Condensation](https://github.com/IntellectualCrafters/PlotSquared/wiki/World-reduction#plot-condensation-added-in-275-intensive) + - [Trim](https://github.com/IntellectualCrafters/PlotSquared/wiki/World-reduction#world-trim-intensive) + - [ChunkProcessor](https://github.com/IntellectualCrafters/PlotSquared/wiki/Chunk-processor) + - [Fast WorldEdit](https://github.com/IntellectualSites/PlotSquared/wiki/WorldEdit-processing) + - [Plot analysis](https://github.com/IntellectualSites/PlotSquared/wiki/Plot-analysis) +###### World types + - [Augmented](https://github.com/IntellectualCrafters/PlotSquared/wiki/TerrainControl) + - [Augmented-Partial](https://github.com/IntellectualCrafters/PlotSquared/wiki/Augmented-Plot-Worlds) +###### Schematics + - [on Claim](https://github.com/IntellectualCrafters/PlotSquared/wiki/Usage:-Schematic-on-claim) + - [exporting](https://github.com/IntellectualCrafters/PlotSquared/wiki/Usage:-Schematic-export) +###### Plot + - [Merging](https://github.com/IntellectualCrafters/PlotSquared/wiki/Usage:-Plot-merging) + - [Tiers](https://github.com/IntellectualCrafters/PlotSquared/wiki/Usage:-Plot-tiers) + - [Flags](https://github.com/IntellectualCrafters/PlotSquared/wiki/Usage:-Plot-flags) \ No newline at end of file