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

Updated Getting started (markdown)

Daniel Saukel 2016-06-10 00:11:23 +02:00
parent 4923e6eaae
commit a25eb6be94
1 changed files with 17 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
Getting-started.md

@ -1,24 +1,4 @@
# Installation
## SHADED or ORIGINAL?
First of all, you should decide which version of DungeonsXL you would like to use. There are two:
### SHADED
* Standard distribution version
* Contains [BRCommons](https://github.com/DRE2N/BRCommons)
* Standalone
* Available at [SpigotMC.org](https://www.spigotmc.org/resources/dungeonsxl.9488) and at the [build server](http://feuerstern.bplaced.net/repo/io/github/dre2n/dungeonsxl)
Use the shaded version if you do not need the benefits of the original version.
### ORIGINAL
* The pure DungeonsXL without any dependencies shaded into the jar
* Requires [BRCommons](https://github.com/DRE2N/BRCommons)
* Available at the [build server](http://feuerstern.bplaced.net/repo/io/github/dre2n/dungeonsxl)
Use the original version if you want to run DungeonsXL with a Minecraft version which is not supported by DungeonsXL or if you use another plugin by DRE2N.
## Addons and connected plugins
# Addons and connected plugins
Even though DungeonsXL is standalone, you will achieve the best experiences if you use some of this plugins:
### [CommandsXL](https://github.com/DRE2N/CommandsXL)
@ -77,23 +57,28 @@ The position where you place the sign is the position where the actions defined
The fourth line of each sign (except some exceptions ;) ) contains one or more triggers. A trigger is a condition which must be fulfilled before the action defined in the first lines happens. Common examples are distance triggers that trigger their sign if a player walks more or less close to it or mob triggers that require PvE kills. A list of all triggers is available [here](signs#triggers).
## Entering the dungeon
_TO DO_
A dungeon can be entered through multiple different ways. The principle is always the same, though:
### Group setup
_TO DO_
1. The players setup a group. This may be skipped if one player wants to play the dungeon alone.
2. Multiple groups form a game. This may be skipped if one group wants to play the dungeon without competition.
3. The group(s) enter the dungeon lobby.
4. There, they choose a class and their equipment. If this is done, they enter the actual game area.
5. The game starts.
### Sign and portal
### Command
### Announcer
A global announcer repeatingly continually invites all players or all players who are on a specific map to join a game. Read more [here](scripts#announcements) for details.
### Testing without reward
Use /dxl test in a lobby.
You can test a dungeon without rewards by using the test game type. A test game can be started with /dxl test while the command sender is in a dungeon lobby.
## ADVANCED: Multi floor dungeons (MFDs)
Creating one is as simple as creating a dungeon configuration. You can then join an MFD with /dxl play d [dungeon] or with a group sign with the + attribute.
_TO DO_
### Setting up the dungeon config
_TO DO_
### Linking floors
_TO DO_
## ADVANCED: Game types
_TO DO_