From 8c26a4c9d0e1c7428c133aac19d26b3addc4f9ef Mon Sep 17 00:00:00 2001 From: Daniel Saukel Date: Wed, 18 Sep 2019 02:40:03 +0200 Subject: [PATCH] Updated Getting started (markdown) --- Getting-started.md | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/Getting-started.md b/Getting-started.md index fab7153..38dbd49 100644 --- a/Getting-started.md +++ b/Getting-started.md @@ -6,24 +6,22 @@ Especially if you're using Minecraft 1.7.x or 1.8.x, you should read the [legacy # The first dungeon ## Creation -First of all, you should create a first dungeon map to start. +Let's start by creating a first dungeon map. + +Every dungeon map is a fully functional dungeon by itself (single floor dungeon), but it can also be used in the context of another multi floor dungeon, where each floor is a separate map. The command _/dxl create {map name}_ will create a new flat world where you can build the structures you desire to be inside your dungeon. The player who created the new map will instantly be teleported to the map spawn. You can always leave a dungeon map (or, precisely: A dungeon player group) with _/dxl leave_. A player who leaves a dungeon gets his old inventory, potion effects, levels, game mode etc. back. ### 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. - -_Beta 0.14 and higher:_ +Of course, you can use an already built map as well. Just copy any map you want as a DXL map to _DungeonsXL/maps/_; DungeonsXL will find and recognize it. You can also easily import a map from the world container of the server (the world container of CraftBukkit is the main directory) with _/dxl import {map name}_. ### Editing the map If you want to work on an existing map, just type in _/dxl edit {map name}_. You can see a list of all existing maps with _/dxl list_. If a player edits a map, he gets creative mode, the inventory is saved and cleared and all commands are denied unless the player has the permission node _dxl.bypass_. Therefore, a player who is editing a dungeon map is **unable to interact with the main worlds of the server**. This is quite useful if you want to provide a possibility to build in creative mode without the need to grant dangerous permissions. -Block structures are not the only thing to prepare in the edit mode. You can also setup the details of the game experience, like where the players spawn, checkpoints, enemy spawn points and so on. This can be done with signs with special codes. The signs will disappear when players play the game, though, so you do not have to worry about hiding them. A list of all sign codes is available [here](signs). - A player is allowed to edit a map if he has the permission node _dxl.edit_ or if he is explicitely invited to work on a map. To invite a player, run the command _/dxl invite {player name} {map}_. ## Setting up the details of the game @@ -31,13 +29,13 @@ A player is allowed to edit a map if he has the permission node _dxl.edit_ or if ![Sign concept](http://feuerstern.bplaced.net/ressourcen/DXLSigns/SignConcept.png) -If you have built a map, you will probably want to add some game mechanics like defining spawn points of the players, NPC enemies and maybe the position of the end of the dungeon. Things like that can be done with edit signs. +Block structures are not the only thing to prepare in the edit mode. You can also setup the details of the game experience, like where the players spawn, checkpoints, enemy spawn points and so on. This can be done with signs with special codes. Dungeon signs will disappear when players play the game, so you do not need to worry about hiding them. A list of all sign codes is available [here](signs). -The concept of edit signs is quite simple if you get used to using them: Their goal is to define: +Dungeon signs define... **...what happens...** -The first line of the sign defines the type of the sign. The second and the third line contain information to handle the details of "what happens". A list of all signs is available [here](signs#edit-signs). +The first line of the sign defines the type of the sign. The second and the third line contain information to handle the details of "what happens". **...where...** @@ -45,13 +43,13 @@ The position where you place the sign is the position where the actions defined **...under which circumstances.** -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). +The fourth line of each sign contains one or more triggers. A trigger is a condition which must be fulfilled before the action defined in the first three 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 A dungeon can be entered through multiple different ways. The principle is always the same, though: -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. +1. The players form a group. This may be skipped if one player plays the dungeon alone. +2. Multiple groups are added to the game. This may be skipped if one group plays 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. @@ -61,13 +59,13 @@ Players can setup their groups with a [group](signs#group) sign in one of the ma The portal does not need any link to the dungeon as this is defined by the signs; just create it with _/dxl portal_ and DungeonsXL will handle the rest. -If you'd like to, you can specify other materials than the portal block through the command, for example through _/dxl portal WATER_. Portal blocks are recommended because they obviously are the block that is intended to be a portal. They are explicitly supported, while other materials are not handled specifically and might not work as intended or break upon new Minecraft versions if there physics change. +If you'd like to, you can specify other materials than the portal block through the command, for example through _/dxl portal WATER_. Portal blocks are recommended because they obviously are the block that is intended to be a portal. They are explicitly supported, while other materials are not handled specifically and might not work as intended or break upon new Minecraft versions if their physics change. A correct sign / portal setup should look similar to this: ![Enter with a portal](http://feuerstern.bplaced.net/ressourcen/DXLSigns/EnterPortal.png) -To remove a portal or global sign, use _/dxl break_. +**To remove a portal or global sign, use _/dxl break_.** ### Command A game can also be started with the _/dxl play_ command. This is the easiest way to test your dungeons. Groups can be set up with the _/dxl group_ command. Make sure to give players the correct permissions if you want to use this feature - by default, they are disabled. @@ -78,10 +76,10 @@ A global announcer repeatingly continually invites all players or all players wh ### Testing without reward 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](dungeon-configuration). You can then join an MFD with /dxl play d [dungeon] or with a group sign with the + attribute. +## Multi floor dungeons (MFDs) +As mentioned above, dungeons can also consist of multiple instances that are linked together. Creating a multi floor dungeon is as simple as creating a [dungeon configuration](dungeon-configuration). You can then join an MFD with _/dxl play {script name}_. -## ADVANCED: Game types +## Game types _TO DO_ # API \ No newline at end of file