Documentation moved to GitHub Wiki

This commit is contained in:
William Blake Galbreath
2020-04-12 13:10:23 -05:00
parent b4ab7a4f19
commit 95538dd1d7
5 changed files with 1 additions and 1600 deletions

View File

@@ -1,38 +0,0 @@
=============
Biomes.yml
=============
This page details the biome specific options found in biomes.yml
.. |br| raw:: html
.. contents::
:depth: 1
:local:
Biomes
===============
spawn-data
~~~~~~~~~~
* **description**: Spawn data is a map of key->value pairs for each entity and it's natural spawn settings per biome. The
value consists of 3 integers representing the weight, minimum group, and maximum group.
Weight represents the chance the entity has to spawn. It's not really a percent chance, it's the number of chances this
entity gets in the rng roll. Take the `ocean` biome, for example. If you add up all the weights for all the entities
you get a total of 540. Enderman has a weight of 10 here, so it gets 10/540 chance of winning the rng roll.
There are still other rules to be met before a mob is spawned. Each entity has their own set of rules, which can be
learned by researching the official minecraft wiki or google. But, for example, lets say a water location was chosen
to spawn a mob at random and enderman won the rng roll. The enderman will _not_ spawn because it's in water. This tick
the spawn chance gets skipped and nothing spawns. The rng roll happens every tick until the mob cap has been reached, so
keep all this in mind when creating your weights.
The minimum and maximum group values are exactly as they sound. It is the number of mobs of this type that will spawn
from this attempt.
.. note::
The default biomes.yml file matches perfectly with the vanilla gameplay. If you find something not right, please let me
know on discord.
More biome specific customizations are planned for the future.

File diff suppressed because it is too large Load Diff

View File

@@ -1,14 +0,0 @@
==========
Contact Us
==========
.. contents::
:depth: 2
:local:
Discord
=======
Our main presence is on Discord. You can use the following link to join it
* `<https://discord.gg/mtAAnkk>`_

View File

@@ -7,22 +7,4 @@ Purpur documentation
:alt: Purpur logo
:align: center
.. warning::
This documentation is a work in progress. Some things are still missing. If
you'd like to see it completed faster, you can contribute to the documentation
`here <https://github.com/pl3xgaming/Purpur>`_.
Welcome to the official documentation source for the
`Purpur <https://www.github.com/pl3xgaming/Purpur>`__ project.
Purpur is a fork of Paper used by the Pl3xCraft server. It contains many gameplay
changes to suit our server that are deemed too wild to be included directly upstream into Paper.
.. toctree::
:maxdepth: 2
:titlesonly:
configuration
permissions
biomes
contact
This documentation has moved over to the GitHub Wiki `here <https://github.com/pl3xgaming/Purpur/wiki/>`_.

View File

@@ -1,84 +0,0 @@
==========
Permissions
==========
.. contents::
:depth: 2
:local:
Permissions
=======
Purpur adds a few new permission nodes for some of it's added features.
By default **all** of these permissions are for OP users only. Any other users will
need to be granted the permissions you want them to have using a permissions plugin.
* **bukkit.command.purpur**
- **description**: This permission gives the ability to use the /purpur command
* **allow.ride.<mob_id>**
- **description**: This permission gives the ability to ride a certain mob by shift
right clicking it. Once mounted you can use WASD to move around, and spacebar to jump
or fly. Just replace "<mob_id>" with the mob's Entity ID.
- **examples**:
- `allow.ride.cow`
- `allow.ride.zombie_pigman`
- `allow.ride.snow_golem`
* **allow.special.<mob_id>**
- **description**: This permission gives the ability to activate a ridable mob's
special ability. Not all mobs have a special ability. Just replace "<mob_id>" with
the mob's Entity ID.
* **allow.powered.creeper**
- **description**: This permission gives the ability to toggle a creeper's powered state.
Hold spacebar while not moving to charge the toggle. Instead of blowing up the powered
state will toggle on or off.
* **purpur.debug.f3n**
- **description**: Allows the use of the F3+N debug hotkey to swap gamemodes.
Player must have this perm _and_ the gamemode perm for it to work.
* **purpur.drop.spawners**
- **description**: Players with this permission can use a diamond pickaxe with silk
touch enchantment to mine up any spawner cage instead of disappearing.
* **purpur.place.spawners**
- **description**: Players with this permission can place down a spawner cage and
have the mob type restored to what it was when it was mined using silk touch.
* **purpur.sign.edit**
- **description**: Allows players to open the sign editor when right clicking a sign
while holding a sign.
* **purpur.sign.color**
- **description**: Allows players to use color codes on signs
* **purpur.sign.style**
- **description**: Allows players to use style codes on signs (except the magic/obfuscated code)
* **purpur.sign.magic**
- **description**: Allows players to use the magic/obfuscated style code on signs
* **purpur.enderchest.rows.six**
- **description**: Allows players to have 6 rows in their enderchest
* **purpur.enderchest.rows.five**
- **description**: Allows players to have 5 rows in their enderchest
* **purpur.enderchest.rows.four**
- **description**: Allows players to have 4 rows in their enderchest
* **purpur.enderchest.rows.three**
- **description**: Allows players to have 3 rows in their enderchest
* **purpur.enderchest.rows.two**
- **description**: Allows players to have 2 rows in their enderchest
* **purpur.enderchest.rows.one**
- **description**: Allows players to have 1 row in their enderchest
.. note::
Enderchest row permissions require `settings.blocks.ender_chest.six-rows` to be enabled!