Note that a new, more organized article about this feature is being made here.
Global signs
DungeonsXL offers signs which can be placed in the main world of your server to allow players to team up in parties, sothat they can loot the dungeon.
Group
You can create a group sign with these lines:
![[DXL] / Group / TEST / 3,GroupName](http://feuerstern.bplaced.net/ressourcen/DXLSigns/GroupNew.png)
The third line equals the name of the dungeon or, if only one floor shall be played, of the map. The last line defines the amount of players in one group. Note that the second line is not a placeholder, but what you are literally supposed to enter there :)
| 1 | [DXL] | |
|---|---|---|
| 2 | Group | |
| 3 | Dungeon | The name of the dungeon script or map that identifies the dungeon to play |
| 4 | Max players per group(,group name,amount of players to start the dungeon automatically) | Group settings |
Leave
You should also add a leave sign as an alternative for the command.
![[DXL] / Leave](http://feuerstern.bplaced.net/ressourcen/DXLSigns/Leave.png)
Game
![[DXL] / Game / TEST / 3](http://feuerstern.bplaced.net/ressourcen/DXLSigns/GameNew.png)
A game sign works just like the group sign with the difference that it stores a collection of groups instead of a collection of players. Use a game sign if you want to create an instance for multiple groups. Players have to be the captain of their group to be allowed to punch the sign in order to add their group to the game.
| 1 | [DXL] | |
|---|---|---|
| 2 | Game | |
| 3 | Dungeon | The name of the dungeon script or map that identifies the dungeon to play |
| 4 | Max groups per game(,amount of groups to start the dungeon automatically) | Group settings |
Edit signs
In the edit mode you can place different signs with different functions executed when they are triggered. They won't appear in game mode. The first line determines the type. The two lines in the middle contain additional values. The bottommost line contains the triggers executing the sign functions.
Each dungeon needs at least these signs:
- lobby
- ready
- start
- end / floor
Lobby
Creates a lobby spawn point.
Ready
Creates a "Ready" Sign, which, after choosing the class in the lobby, has to be triggered / klicked to start the dungeon. In the second line, you may specify a game type. (Game types have been merged with game rules in v0.18.) The third line can be used to specify the time in seconds until the game starts automatically. Both the second and the third line are optional.
You can of course specify a trigger in the last line. Ready signs will however generate an interact trigger automatically if nothing is specified.
Leave
Players who trigger this sign will leave the dungeon.
Start
This sign sets the start location of the map. When all players are ready, they will get teleported to this point. In MFDs, start signs mark the beginning of each floor. The start floor is the only floor which needs a lobby (unless it is bypassed in the config).
The number in the second line is optional and defines which group will spawn at this location. If you wish to create a PvP map for two groups, create one sign with "0" and one with "1".
End
You may use the second line to specify a floor.
In multi floor dungeons, when each player of the group triggered this sign, the floor is finished and the players are be teleported to the next one. If there is no floor specified in the second line, the player will be teleported to a random floor from the list inside the dungeon configuration as long as the floorCount is higher than 0. In single floor dungeons and when no floors are left, the dungeon ends. End signs generate an interact trigger automatically if none is specified.
Classes
Creates a class sign. The name entered in the second line must be the name of a class script.
Command
WARNING: Do not use this feature to spawn mobs. Use mob signs and the custom mob provider registry in the main config instead.
This sign executes a command script defined by the name specified in the second line, while line three contains the delay and mode: Commands can be executed by the console ("console"), as an operator ("op") or just with the players own permissions ("default").
Mob
Creates a mob spawn point. Note that the old MythicMobs and ExternalMob signs have been merged with mob signs.
| 1 | [Mob] | |
|---|---|---|
| 2 | Type | The type of the Mob. You can use custom mobs from scripts. |
| 3 | delay,amount(,provider) | The delay determines how many seconds it takes for the next mob to spawn and the amount how many mobs are spawned altogether. The third, optional parameter specifies which external mob provider will be used. |
| 4 | Trigger |
DungeonsXL provides built-in support for InsaneMobs, MythicMobs, CustomMobs and Citizens.
| Plugin | External mob provider tag |
|---|---|
| Citizens | CI |
| CustomMobs | CM |
| InsaneMobs | IM |
| MythicMobs | MM |
You can also add other custom mob plugins if they provide a spawn command with a mob identifier and a location (world name and coordinates) in the main configuration.
Message
Sends a Message that was set before.
| 1 | [Msg] | |
|---|---|---|
| 2 | ID | The ID of the message. It can be defined in the config.yml or via /dxl msg |
| 3 | ||
| 4 | Trigger |
Place
Allows placing of Blocks on this position.
| 1 | [Place] | |
|---|---|---|
| 2 | BlockID | [Optional] The Block ID of the Block, that can be placed here |
| 3 | Further arguments: | [Optional] The Side of the Block, to that the block can be placed like on a compass and fired sign triggers (e.g. "N,NNE,1") |
| 4 |
The fired sign trigger works like a trigger sign, so the argument "[anything],1" fires a sign with the trigger "T1".
Checkpoint
Creates a Checkpoint. If you die, you will automatically get to the latest Checkpoint, otherwise to the Startpoint.
Reward chest
The image has not yet been updated. Use "RewardChest" instead of "Chest" in the first line.
All containers (chests, furnaces, barrels etc.) in near by a reward chest sign become reward chests. When a player opens a reward chest in a dungeon, the content will be added to his group's reward inventory which contains items the players get in the main world of the server when they finish the dungeon.
| 1 | RewardChest | |
|---|---|---|
| 2 | money,levels | [Optional] A money reward (requires Vault) and a EXP level reward |
| 3 | table name | [Optional] The name of a loot table script. The loot from the table gets, depending on the chance value, added randomly to the rewards. Content from the container inventory will not get overriden. |
| 4 | Trigger | No trigger is needed here because the sign is triggered automatically when the game starts and transforms the chest into a reward chest. |
If a loot table is specified and no container is in near by the sign, a chest will be generated at the position of the sign.
Dungeon chest
Dungeon chests are to be set up similarly to reward chests. They are used to fill normal chests that don't give loot but items to use in the dungeon with loot table items.
| 1 | DungeonChest | |
|---|---|---|
| 2 | ||
| 3 | table name | The name of a loot table script. The loot from the table gets, depending on the chance value, added randomly to the chest contents. Content from the chest inventory will not get overriden. |
| 4 | Trigger | No trigger is needed here because the sign is triggered automatically when the game starts and transforms the chest into a dungeon chest. |
If a loot table is specified and no chest is in near by the sign, a chest will be generated at the position of the sign.
Trigger
Can Trigger other signs. Triggers all signs, that have defined this sign as Trigger
| 1 | [Trigger] | |
|---|---|---|
| 2 | ID | The Trigger-ID. All Signs, that have set this Sign as Trigger (through "T id"), will be triggered when this sign is triggered. If you leave this line empty, the next available ID will automatically be found. |
| 3 | ||
| 4 | Trigger |
Redstone
Turns into a Redstone block, that provides redstone power.
In addition it can be delayed and also repeated.
| 1 | [Redstone] | |
|---|---|---|
| 2 | Delay | [Optional] Delay of the Redstone output in Repeatersteps. 1 = like normal repeater, 4 = like full repeater, 10 = 1 sec, 600 = 1 min |
| 3 | Repeating | [Optional] Count of the repeats of the output. The Delay determines the time between the outputs. Empty = No repeats (permanent power), 0 = Infinite repeating |
| 4 | Trigger |
Protipp: With adding ",x" to the Delay, you can also set the power-on time while repeating to x repeatersteps. Otherwise it is as long as the Delay.
Block
Transforms into a Block.
| 1 | [Block] | |
|---|---|---|
| 2 | Off-Blockid/Name,Blockdata | The Blockid or name of the Block, and [optional] blockdata of the Block, that appears before being triggered. |
| 3 | On-Blockid/Name,Blockdata | The Blockid or name of the Block, and [optional] blockdata of the Block, that appears after being triggered. |
| 4 | Trigger |
Tipp: To find out BlockId and Blockdata of a Block, rightclick it with a stick!
Interact
Transforms into a clickable sign:
| 1 | [Interact] | |
|---|---|---|
| 2 | ID | Signs that have this ID marked as their Trigger through "I id", will be triggered upon clicking this sign. |
| 3 | Text | The Text that will appear on Top |
| 4 | Text | The Text that will appear on Bottom |
Wave
This feature is subject to change and not supported!
Marks the beginning of a new mob wave. When a new wave starts, all triggered mob spawn points will spawn their mobs once again.
| 1 | [Wave] | |
| 2 | mob increase rate | A multiplier for the mob count of all signs |
| 3 | teleport | Whether the players will get teleported to the start location; "+" or "true" to enable |
| 4 | Trigger | In most cases, the wave trigger should be used. |
Hologram
Hologram signs now use message IDs like chat message signs.
Config example:
messages:
1: "First line<br>Second Line<br>Item:ItemID<br>&6Color codes are supported!"
DungeonsXL provides support for Holographic Displays by filoghost. Hologram signs work as a wrapper to create and spawn holograms.
| 1 | [Hologram] | |
| 2 | Message ID | "<br>" will create a wordwrap, "Item:[ID]" an item line. The ID may be any custom or vanilla item ID. |
| 3 | 2.0 | The height of the hologram - this option is simply for convenience sothat you don't have to temporarily stack blocks to place the signs somewhere the air. |
Drop
The drop sign will spawn dropped items at its location. The second line may contain any Caliburn item, the third one contains the stack size and the drop rate. If no drop rate is specified, the item will drop only once.
Lives modifier
| 1 | [Lives] | |
| 2 | -3 | The amount of lives. May be positive or negative. |
| 3 | GROUP | The target. Valid targets are: GAME (=all players in the game), GROUP (=all players in the group) and PLAYER (just the player who triggered the sign). |
Open door
The door sign locks and protects its attached door. If the sign is triggered, the door opens.
Script
Script signs represent one or multiple signs at one block location. You can specify what exactly happens in a script. The second line is the name of the script without the .yml extension.
Teleport
Teleport signs teleport the player either to the location in the second line or to the location of the sign itself if the second line is empty.
Resource pack
If a player triggers a resource pack sign, he gets the possibility to download the dungeon resource pack.
Resource pack IDs can be defined in the main configuration file. Use "reset" instead of an ID to reset the player's resource pack to his default one.
ResourcePack signs get enabled before the game starts and generate an interact trigger by default just like for example lobby, ready or leave signs, but you might want to link one sign to set the pack to your ready sign and one to reset to your end sign.
BossShop
The BossShop sign provides basic integration with blackixx' BossShop plugin. BossShop is a powerful, free, open source and user-friendly solution to easily script inventory GUIs and shops.
Bed
A bed sign used for bedwars. The number is the team number just like start signs use them.
Flag
Sound message
Sound message signs use the same sound identifiers as the vanilla command. You can use custom sounds provided by a resourcepack.
The second line contains the sound category, volume & pitch.
Action bar
Action bar signs now use message IDs like chat message signs.
Title
Title signs now use message IDs like chat message signs. Syntax is: [Title] / {title ID},{subtitle ID} / N/A / {trigger}.
Triggers
To trigger most of these signs, they need a Trigger. It is determined in the Bottom line of a sign. This explains all available Triggers:
[D]istance
Sign will be triggered when a player is within the defined radius of Blocks. In this case it would be 5 Blocks.
[R]edstone
Sign will be triggered when the block receives redstone power.
[T]rigger sign
Sign will be triggered upon triggering the Trigger sign with the ID 1.
[I]nteract
The sign will be triggered when the interact sign with the ID ( in this case 1) is clicked.
[U]se item
Sign will be triggered when a player right clicks a stone (ID 1) in his hand. Instead of an ID, you may use the name of an item, of a book or of a renamed item.
[M]ob death
The sign will be triggered when the mob "Boss" is killed. The ID is the same as what was used to spawn this mob.
Only mobs spawned by signs can be used.
[W]ave
This feature is subject to change and not supported!
The sign will be triggered when all mobs in the game world are killed. The amount of mobs to to kill can be lowered through the multiplier: While 100/100 mobs have to be killed if the trigger is "W 1", just 95/100 mobs have to be killed if it is "W 0.95".
[P]rogress
This feature is subject to change and not supported!
The progress trigger triggers signs when a specific game progress is reached. The first value is the amount of floors and the second value is the amount of waves to finish, for example "P 0/5". You can also use the name of a floor instead of the numbers.
[F]ortune
F 69.4
Fortune triggers add a chance for the sign to be triggered. Possible use-cases are for example mob or reward chest signs.
Multiple Triggers
A sign can have multiple triggers, seperated with a comma. Important: Only if all Triggers are triggered, the sign becomes active. In this sample that would mean: Only if a player was within the radius of 15 Blocks, redstone power is received, the mob "Boss" is dead and the Triggersign 2 was triggered, this sign becomes active.
If there is no Trigger declared, the sign becomes active instantly. Exception: The signs Ready, Leave and End become Interact signs, that are triggered through clicking.
Disable signs
Signs with Redstone and/or Triggersign trigger can be disabled, through disabling the redstone power that has triggered it.
Now the sign is inactive until it receives power again.
Player specific triggers
Player specific triggers are those, in that only a single player may be involved. They include Distance, Interact and Use Item triggers. With one of these as only trigger, the sign will only be triggered for the involved player. Only he has reached that Checkpoint or receives that message. Sample: A message, that will be triggered through distance. The message appears only for the players, that ar within the given radius.
Of course the other players can still trigger that sign afterwards.
© 2012-2013 Milan Albrecht, all rights reserved