Upstream/DungeonsXL
1
0
Fork 0
mirror of https://github.com/DRE2N/DungeonsXL.git synced 2025-02-26 17:21:40 +01:00
Code Issues Projects Releases Wiki Activity

Updated Scripts (markdown)

Daniel Saukel 2021-10-23 03:23:57 +02:00
parent 1be5656c09
commit 565db22c51
1 changed files with 5 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
Scripts.md

@ -2,41 +2,14 @@ A *script* is a [YAML](https://en.wikipedia.org/wiki/YAML) file located at _plug
***
1. [Announcements](#announcements)
2. [Classes](#classes)
3. [Mobs](#mobs)
4. [Signs](#signs)
5. [Loot tables](#loot-tables)
6. [Commands](#commands)
1. [Classes](#classes)
2. [Mobs](#mobs)
3. [Signs](#signs)
4. [Loot tables](#loot-tables)
5. [Commands](#commands)
***
## Announcements
Announcements are chat messages that pop up from time to time (you can adjust the interval in the main config). If a player clicks at the message, a menu pops up.
![Announcer GUI](http://feuerstern.bplaced.net/ressourcen/DXLSigns/AnnouncerGUI.png)
The player can join a group by clicking at its button. If enough players join the announced game, it gets scheduled. The players see a progress bar and can join and leave at will until the time is over.
![ProgressBar](http://feuerstern.bplaced.net/ressourcen/DXLSigns/ProgressBar.png)
```
description:
- "&6====================================================="
- "&2Insert witty text to explain the announced game here..."
- "&6====================================================="
# The name of a map if multiFloor is false, the name of a dungeon if multiFloor is true.
identifier: TEST
# If the dungeon to play has multiple floors.
multiFloor: false
# The game starts automatically thirty seconds after the minimum requirements are fulfilled.
minGroupsPerGame: 2
minPlayersPerGroup: 1
maxGroupsPerGame: 4
maxPlayersPerGroup: 4
```
## Classes
If players should not play the dungeon with their own items but with a set inventory, class scripts are the way to go. Thanks to the [CaliburnAPI](https://github.com/DRE2N/CaliburnAPI) / [ItemsXL](https://github.com/DRE2N/ItemsXL) integration, DungeonsXL supports three different ways to store items in configuration files.