Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Content extension #26

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Content extension #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
75801e3
Document Gamerules
Palmidence Oct 13, 2019
16a27e0
Document Respawn
Palmidence Oct 13, 2019
7e2f039
Fix missing teams field in Respawn module
Palmidence Oct 13, 2019
cb8173d
Document missing item and flag attributes
Palmidence Oct 16, 2019
b849f74
Start generators.md
Palmidence Nov 2, 2019
8029bad
Update formatting, add some attributes
Nov 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions docs/gamerules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Gamerules

This module is used to modify gamerules native to Minecraft.

## Example

```json
"gamerules": {
"keepInventory": true,
"doDaylightCycle": true,
"doWeatherCycle": false
},
```

### Gamerules Attributes

| Attribute | Description | Value | Default |
|-----------|-----------------------------------------------------------------------|----------|---------|
| `announceAdvancements` | Whether advancements should be announced in chat. | Boolean | False |
| `commandBlockOutput` | Whether command blocks should notify admins when they perform commands. | Boolean | False |
| `disableElytraMovementCheck` | Whether the server should skip checking player speed when the player is wearing elytra. | Boolean | True |
| `disableRaids` | Whether raids are disabled. | Boolean | |
| `doDaylightCycle` | Whether the day-night cycle and moon phases progress. | Boolean | False |
| `doEntityDrops` | Whether entities that are not mobs should have drops. | Boolean | |
| `doFireTick` | Whether fire should spread and naturally extinguish. | Boolean | |
| `doInsomnia` | Whether phantoms can spawn in the nighttime. | Boolean | |
| `doImmediateRespawn` | Players respawn immediately without showing the death screen. | Boolean | |
| `doLimitedCrafting` | Whether players should be able to craft only those recipes that they've unlocked first. | Boolean | |
| `doMobLoot` | Whether mobs should drop items. | Boolean | |
| `doMobSpawning` | Whether mobs should naturally spawn. Does not affect monster spawners. | Boolean | False |
| `doTileDrops` | Whether blocks should have drops. | Boolean | |
| `doWeatherCycle` | Whether the weather can change. | Boolean | False |
| `drowningDamage` | Whether the player should take damage when drowning. | Boolean | |
| `fallDamage` | Whether the player should take fall damage. | Boolean | |
| `fireDamage` | Whether the player should take fire damage. | Boolean | |
| `keepInventory` | Whether the player should keep items in their inventory after death. | Boolean | False |
| `logAdminCommands` | Whether to log admin commands to server log. | Boolean | False |
| `maxCommandChainLength` | Determines the number at which the chain command block acts as a "chain". | Value | |
| `maxEntityCramming` | The maximum number of other pushable entities a mob or player can push, before suffocating. | Value | |
| `mobGriefing` | Whether or not mobs can interact with the environment. | Boolean | |
| `naturalRegeneration` | Whether the player can regenerate health naturally. | Boolean | |
| `randomTickSpeed` | How often a random block tick occurs. | Value | |
| `reducedDebugInfo` | Whether the debug screen shows all or reduced information. | Boolean | |
| `sendCommandFeedback` | Whether the feedback from commands executed by a player should show up in chat. | Boolean | |
| `showDeathMessages` | Whether death messages are put into chat when a player dies. | Boolean | |
| `spawnRadius` | The radius players spawn at the default world spawn point. | Value | |
| `spectatorsGenerateChunks` | Whether players in spectator mode can generate chunks. | Boolean | |

<span class="label label-note">Note</span> `doImmediateRespawn` should not be used to modify respawning; use `respawn` module.

<span class="label label-note">Note</span> `doTileDrops` should not be used to modify drops; use `itemremove` module.

<span class="label label-note">Note</span> `drowningDamage`, `fallDamage`, `fireDamage` should not be used to disable damage; use `damageControl` module.
73 changes: 73 additions & 0 deletions docs/generators.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Generators

This module is used to generate items in a map, with various tiers.

## Example

```json
"generators": [
{
"id": "middle-generator",
"item": {
"material": "diamond"
},
"location": "77, 6, 27",
"limit": 4,
"range": 5,
"interval": 1200,
"hologram": {
"timeUnit": "seconds",
"content": "&bDiamond &ewill spawn in &c%time% &e%span%"
},
"upgrades": {
"type": "scheduled",
"sequence": [
{
"time": 600,
"interval": 600,
"message": "&eGenerator &7has been upgraded to &eLevel %level%!",
"item": {
"material": "emerald"
},
"holoContent": "&aEmerald &ewill spawn in &c%time% &6%span%"
}
]
}
}
]
}
```

### Generators Attributes

| Attribute | Description | Value |
|------------|----------------------------------------------------------|------------|
| `id` | The name of the generator. | String |
| `item` | Nests the material and other item attributes. | Item |
| `location` | The coordinates in which the item will spawn. | Coordinate |
| `limit` | The amount of items active in a stack at a given time. | Number |
| `range` | Number of blocks a player must be in range for spawning. | Number |
| `interval` | The frequency of the item spawn. | Number |
| `hologram` | Hologram that displays information about the generator. | Parent |
| `upgrades` | Parent attribute that stores generator "tier" upgrading. | Parent |

### Hologram Attributes

| Attribute | Description | Value |
|--------------|----------------------------------------------------------|------------|
| `timeUnit` | The unit of time measurement used. | Boolean |
| `content` | Display of hologram (colors codes with `&` supported) | Boolean |

### Upgrades Attributes

| Attribute | Description | Value |
|---------------|----------------------------------------------------------|------------|
| `type` | Whether the generator should auto upgrade or manually | String |
| `sequence` | Parent attribute that stores how often to upgrade | Parent |


### Sequence Attributes

| Attribute | Description | Value |
|---------------|----------------------------------------------------------|------------|
| `someone` | finish this | Vice |
15 changes: 15 additions & 0 deletions docs/kits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,21 @@ Defines which kit each team receives.
| `slot` | The slot the item will spawn in. | Slot |
| `amount` | The amount of an item the player receives. Default is 1. | Number |
| `unbreakable` | Whether the item is breakable or not. | Boolean |
| `display_name`| The name of the item. | String |
| `lore` | The subtext (lore) of the item. | String |
| `flags` | The type of flags that are applied to the item. | Parent |

#### Flags Attributes

| Attribute | Description | Value |
|------------------|---------------------------------------------------------------|---------|
| `hide_attributes`| Hides attributes like damage. | Boolean |
| `hide_destroys` | Hides what an item stack can destroy. | Boolean |
| `hide_enchants` | Hides what enchantments the item has. | Boolean |
| `hide_placed_on` | Hides what a block can be placed against. | Boolean |
| `hide_potion_effects`| Hides the potion effects on an item stack. | Boolean |
| `hide_unbreakable` | Hides the unbreakable state. | Boolean |


### Effects Attributes

Expand Down
32 changes: 32 additions & 0 deletions docs/respawn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Respawn

This module is used to modify player respawning.

## Example

```json
"respawn": {
"rules": {
"freeze": true,
"blindness": true,
"confirm": false,
}
},
```

### Respawn Attributes

| Attribute | Description | Value | Default |
|-----------|-----------------------------------------------------------------------|----------|---------|
| `rules` | The attribute which fosters the mechanics that are modified. | Parent | |


### Rules Attributes

| Attribute | Description | Value | Default |
|-----------|-----------------------------------------------------------------------|----------|---------|
| `delay` | The duration until the player is allowed to respawn. | Value | |
| `freeze` | Whether or not the player may move when in the death screen. | Boolean | |
| `blindness` | Whether or not the player can see when in the death screen. | Boolean | |
| `confirm` | Whether or not the player must interact with the death screen to respawn. | Boolean | |
| `teams` | Defines which teams will be affected by rules attributes. | Team ID | |