Upstream/DungeonsXL
1
0
Fork 0
mirror of https://github.com/DRE2N/DungeonsXL.git synced 2024-11-28 21:48:43 +01:00
Code Issues Projects Releases Wiki Activity

Created Getting started (markdown)

Daniel Saukel 2016-03-22 14:45:46 +01:00
parent 6c78d799f2
commit b2edd0d80b
1 changed files with 74 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
Getting-started.md Normal file

@ -0,0 +1,74 @@
# 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
Even though DungeonsXL is standalone, you will achieve the best experiences if you use some of this plugins:
### [CommandsXL](https://github.com/DRE2N/CommandsXL)
CommandsXL unleashes a lot of the potential of DungeonsXL through the possibility to create command signs that use the CXL API to execute commands.
### [MythicMobs](https://www.spigotmc.org/resources/mythicmobs.5702)
MythicMobs allows you to create much more sophisticated mobs than DungeonsXL is able to provide itself.
### [RPGMe](https://www.spigotmc.org/resources/rpgme.7857)
_Upcoming_
### [BetonQuest](https://www.spigotmc.org/resources/betonquest.2117)
_Upcoming_
### [Factions](https://www.spigotmc.org/resources/factionsone.9249)
_Upcoming_
### Integrations
Besides that, DungeonsXL integrates with [Vault](http://dev.bukkit.org/bukkit-plugins/vault) to support the permission system of [PermissionsEx](http://dev.bukkit.org/bukkit-plugins/permissionsex) and the economy system of [CraftConomy](https://www.spigotmc.org/resources/craftconomy.2395). Other permission or economy plugins might work if they support Vault, but they are completely unsupported.
# The first dungeon
## Creation
_TO DO_
### Importing maps
Of course, you do not have to build a new map. Just copy any map you want as a DXL map to _DungeonsXL/maps/_; DungeonsXL will find and recognize it.
## Setting up the floor configuration
_TO DO_
## Entering the dungeon
_TO DO_
### Group setup
_TO DO_
### Testing without reward
_TO DO_
## ADVANCED: Multi floor dungeons (MFDs)
_TO DO_
### Setting up the dungeon config
_TO DO_
### Linking floors
_TO DO_
## ADVANCED: Game types
_TO DO_
# API