Updated Installation (markdown)

boy0001 2015-02-16 18:22:25 +11:00
parent 57af472eb0
commit 9d863189cf

@ -1,16 +1,13 @@
## Initial Setup:
- Download the files (download from plugin page)
- Extract the contents from the zip
- Extract the contents from the zip (if it's in a zip file)
- Put "PlotSquared.jar" into your "plugins" directory for the server
- Run the server once to generate the necessary files
## Database Configuration
### Database: SQLite
**Please remember you can only have SQLite or MySQL but not both**
- Navigate to "storage.yml"
- Configure the settings for your SQLite database by setting "sqlite.use" to "true"
If you do not have a MySQL database, storage should automatically be set for SQLite and you may skip this step.
### Database: MySQL
**Please remember you can only have MySQL or SQLite but not both**
@ -19,7 +16,7 @@
- Configure the settings for your MySQL database
- See here if you have no idea what MySQL is.
## PlotMe conversion
## PlotMe conversion (Optional)
Please make sure you have completed the steps above
_(For conversion of more than 5000 plots we recommend you use MySQL)_
- If you are upgrading PlotMe, please wait until after it has updated its database to install PlotSquared _(i.e. run the server with the new PlotMe, and let it do it's thing for a bit)_
@ -36,20 +33,25 @@ If you have multiverse or multiworld, you can change the generator within the th
If you start the server without having switched over the generators, you may see a debug message saying: `Plot 'X;Z' in DB for world 'plotworld' does not exist! Please create this world, or remove the plots from the DB!`. This is a gentle reminder that you need to switch the generator over for a world.
## World Creation
#### [Click here for information on creating partial plot worlds](https://github.com/IntellectualCrafters/PlotSquared/wiki/Augmented-Plot-Worlds)
(You will need any plot worlds to be using the PlotSquared generator)
### Step 1: Create Configs
To create the configuration
- `/plot setup {world} {generator}`
- where {world} is the name of the world and {generator} is the generator you are using (Default PlotSquared)
(Of course you could still create the configuration manually if you really wanted to)
### Step 2: Create World
### Step 1: Create a world with Multiverse
####Option 1: Creating a world with Multiverse:
`/mv create normal -g PlotSquared`
`/mv create <world> normal -g PlotSquared`
It will also accept several arguments:
- `s` or `size` (plot size)
- `g` or `gap` (road width)
- `h` or `height` (plot height)
- `f` or `floor` (plot floor block)
- `m` or `main` (plot main block)
- `w` or `wall` (plot wall block)
- `b` or `border` (plot border block)
Examples:
- `/plot create <world> normal -g PlotSquared:size=64`
- `/plot create <world> normal -g PlotSquared:h=64,main=5:2`
####Option 2: Creating a world with Multiworld:
`/mw create PlotSquared`
`/mw create <world> PlotSquared`
####Option 3: Editing the generator using Bukkit.yml:
- navigate to you bukkit.yml file (in the root folder)
@ -82,86 +84,5 @@ If all is well, you can begin regenerating the roads in the entire map. Open up
`/plot regenallroads`
## Example Config File
[Gist](https://gist.github.com/Uncleleech/a0eed30e1a724b98da74)
```YAML
version: 1
teleport:
on_login: false
UUID:
offline: false
read-from-disk: false
clear:
auto:
enabled: false
days: 365
'on':
ban: false
worldguard:
enabled: false
debug: true
claim:
max-auto-area: 4
mob_pathfinding: true
worldedit:
require-selection-in-mask: true
plotme-alias: false
plotme-convert:
enabled: true
schematics:
save_path: /var/www/schematics
titles: true
uuid:
api:
custom: true
location: http://www.intellectualsites.com/minecraft.php
fecthing: false
max_plots: 127
auto_update: false
kill_road_mobs: false
metrics: true
worlds:
plotworld:
plot:
height: 64
biome: FOREST
size: 32
filling:
- '1:0'
auto_merge: false
floor:
- '2:0'
wall:
filling: '1:0'
block_claimed: '44:1'
height: 64
block: '44:0'
event:
pve: false
pvp: false
spawn:
egg: false
breeding: false
custom: true
road:
block: '155:0'
height: 64
width: 8
schematic:
specify_on_claim: false
on_claim: false
file: 'null'
economy:
prices:
merge: 100.0
sell: 75.0
claim: 100.0
use: false
chat:
enabled: false
natural_mob_spawning: false
flags: {}
world:
border: true
```
## Example configuration:
[https://github.com/IntellectualCrafters/PlotSquared/wiki/Example-configuration](Click here)