Upstream
/
DungeonsXL
mirror of https://github.com/DRE2N/DungeonsXL.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated Home (markdown)

Daniel Saukel 2015-12-28 23:50:53 +01:00
parent 0ed067a98a
commit acdceb609d
1 changed files with 25 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
Home.md

@ -1,85 +1,34 @@
### Welcome to the DungeonsXL wiki
### General information
DungeonsXL is a plugin for CraftBukkit.
## What is DungeonsXL?
DungeonsXL is a plugin for CraftBukkit which adds the possibility to create complex custom adventure maps and dungeons with ease.
It adds the possibility to create custom dungeons or adventure maps with ease.
## Features
* Create as many dungeons as you wish
* Dungeons can be played by multiple groups of players at the same time without clashes
* Dungeons are accessable through portals in one of your main worlds (/dxl portal, /dxl break, create group signs like above to join a group)
* Invite players to edit single dungeons without the need to give them any permissions (/dxl invite <player>, /dxl uninvite <player>)
* Set checkpoints, breakable blocks, triggers, messages and much more through signs in the edit mode
* Per dungeon configuration (you should try that after you became familiar with the basics of this plugin)
* Link multiple floors together to create large dungeons with multiple levels
* Use a dungeon as a tutorial and give them a PEX group when they finish it
**Fine, so how does it work?**
# Compatibilty
Let's explain it step by step.
## Server
First of all, create a dungeon (e.g. /dxl create mycooldungeon). You'll be teleported into a flat world where you can build. There, you can place [signs](https://github.com/DieReicheErethons/DRE2N/wiki/Signs) that will do actions when a player or a group of players plays the dungeon. For example, a sign can spawn mobs, define a breakable block or change a normal chest into a reward chest that gives items to your players when they finished the dungeon. Create a lobby with the [lobby] sign as described at the sign instructions page. Players team up and get into the lobby using [DXL] signs and a portal you define in the main world (/dxl portal). In the lobby, your players will be able to select a configurable class. When everyone has one and clicked at the [ready] sign, the group is teleported to the [start] sign inside your creation and has to find the [end] sign. They succeed if everyone touches the sign before he loses his last life.
### Recommended: CraftBukkit or any CB mod for Minecraft 1.8 - 1.8.8
### Supported: CraftBukkit or any CB mod for Minecraft 1.7.9 . 1.8.8
*Some basic information concerning signs:
## Java
7 and higher.
A group sign contains this lines: 1. [DXL] / 2. Group / 3. dungeon name / 4. amount of groups,amount of players per group.
## UUIDs
Supported.
![[DXL] / Group / TEST / 1,3](https://proxy.spigotmc.org/b1b510ba834350baad225bb8cc67e94719741a95?url=http%3A%2F%2Ffs2.directupload.net%2Fimages%2F150715%2Fav897yeq.png)
## Known incompatibilities
* Towny
* Corpses
Try PerWorldPlugins to fix it!
You should create a leave sign as well. It allows a player to leave his group.
![[DXL] / Leave](https://proxy.spigotmc.org/5bc61dc606530c3379ea9a753ce4a73283e1da43?url=http%3A%2F%2Ffs2.directupload.net%2Fimages%2F150715%2Futbtnw9l.png)
Inside dungeons, you can use [this](https://github.com/DRE2N/DungeonsXL/wiki/Signs) signs. A German documentation is available [here](https://github.com/DRE2N/DungeonsXL/wiki/Schilder).
If you became familiar with the basics, you can unleash the whole potential of DXL if you learn a littlebit about its configuration.
It's important to know that there are two types of configuration files: A global one and one per dungeon. The global one contains not only global configuration but also a basic per dungeon configuration that is called by every dungeon that doesn't have its own one. If you want to go into detail and to create different classes per dungeon, then you should copy the per dungeon config.yml from the wiki to plugins/DungeonsXL/dungeons/*dungeonname*/config.yml and modify it to match your needs.
#### Commands
* /dungeonsxl,dxl - main command. If you do not enter any arguments, help page 1 will show up.
* /dungeonsxl,dxl help <page> - shows a specific help page to you
* /dungeonsxl,dxl create <name> - creates a new dungeon
* /dungeonsxl,dxl save - saves the current dungeon
* /dungeonsxl,dxl leave - lets you leave the current dungeon
* /dungeonsxl,dxl escape - lets you eaves the current dungeon without saving
* /dungeonsxl,dxl edit <name> - teleports you into an existing dungeon in edit mode and sets you to creative mode sothat you can edit it
* /dungeonsxl,dxl portal - creates a portal that leads into a dungeon
* /dungeonsxl,dxl deleteportal - deletes the portal you are looking at
* /dungeonsxl,dxl chat - makes you join the chat channel of you dungeon
* /dungeonsxl,dxl chatspy - toggles chatspy sothat you can read what those who play a dungeon write
* /dungeonsxl,dxl list - lists all dungeons
* /dungeonsxl,dxl invite <player> <dungeon> - invites a player to edit a dungeon
* /dungeonsxl,dxl uninvite <player> <dungeon> - removes an invitation
* /dungeonsxl,dxl msg <id> - shows a message
* /dungeonsxl,dxl mesg <id> <msg> - edits a message
* /dungeonsxl,dxl test <dungeon> - lets you test a dungeon without the need of a portal
* /dungeonsxl,dxl lives <playrt> - show the lives a player has left
* /dungeonsxl,dxl reload - reloads configuration and save files
#### Permissions
Permissions are faithful to command argument one: Simply use dxl.<argument>. This commands do not have a node, though:
* /dxl escape
* /dxl leave
* /dxl chat
* /dxl list
* /dxl lives
Note that you can edit dungeons even if you do not have permission to do so if you are invited.
In addition, each sign has its own permission node. This nodes are dxl.sign.<sign name> (e.g. dxl.sign.chest).
#### Compatibilty
_Server_
* CraftBukkit for Minecraft 1.7.9 - 1.8.7*
* CraftBukkit mods like Spigot or SportBukkit for the same version
*DungeonsXL works with 1.7.9 and higher. However, support for 1.8.x has a higher priority than support for 1.7.x. Some API stuff changed and DXL is coded to be used with the latest version of CraftBukkit, so it's possible that some things do not work as good as with 1.8.x. Known caveats if you use 1.7.x:
* /dxl deleteportal does not work
_Java_
* 7 and higher
_UUIDs_
* Supported.
_Known incompatibilities_
* Towny
# [Development builds](https://dre2n.github.io/DungeonsXL.html)