Atlas Map Documentation

Atlas Map Documentation

A comprehensive guide on creating maps and game modes for Atlas.

Latest Map Specification: 1.0.6

Items & Loadouts<loadouts>

You can use this module to create sets of items and other player attributes that can be given to players at different times.

Root Loadout Element<loadout>

The root loadout element is used to define basic information about the loadout.

<loadouts>
  <loadout id="default">...</loadout>
</loadouts>

Root Loadout Element Attributes
AttributeDescriptionTypeDefault
id

The globally unique ID of this feature.

This can be used to reference this feature from other parts of the XML.

Feature ID
parent

The id of the parent loadout for reference.

Parent Loadout ID
force

If the items should be forced into already occupied item slots.

True/Falsefalse

Compass<compass>

Set the player's compass target to a fixed position. (The compass module will override this)

<loadout>
  ...
  <compass>1, 1, 1</compass>
</loadout>

Element Text

DescriptionType

The target of the compass.

X,Y,Z Vector

Disguises<disguise>

Disguises are used to turn players into different types of entities or blocks.

<loadout>
  ...
  <disguise material="Workbench">falling block</disguise>
  <!-- Become crafty -->
</loadout>

Element Text

DescriptionType

Type of disguise to give to the player.

Disguise Type

armor stand,
arrow,bat,blaze,boat,cave spider,
chicken,cow,creeper,donkey,dropped item,
egg,elder guardian,
ender crystal,
ender dragon,
ender pearl,
ender signal,
enderman,endermite,experience orb,
falling block,
fireball,firework,fishing hook,
ghast,giant,guardian,horse,iron golem,item frame,
leash hitch,
magma cube,minecart,minecart chest,
minecart command,
minecart furnace,
minecart hopper,
minecart mob spawner,
minecart tnt,
mule,mushroom cow,
ocelot,painting,pig,pig zombie,player,primed tnt,
rabbit,sheep,silverfish,skeleton,skeleton horse,
slime,small fireball,
snowball,snowman,spider,splash potion,
squid,thrown exp bottle,
undead horse,
villager,witch,wither,wither skeleton,
wither skull,
wolf,zombie,zombie villager,
unknown
Disguises Attributes
AttributeDescriptionTypeDefault
baby

If the disguise should be a baby. (Only for creatures which support this.)

True/Falsefalse
material

If the diguise is a block, what material the block should be.

A material is defined in the syntax of matname:damage when matname is the name of the material and damage is the damage value of the material.

A damage value is not required.

Singular Material Matcher

Effects<effects>

Use this to apply potion effects directly to the player.

<loadout>
  <effect amplifier="3" duration="5s">invisibility</effect>
  <effect amplifier="3" duration="5s">increase_damage</effect>
  <effect amplifier="3" duration="5s">regeneration</effect>
  <effect amplifier="3" duration="5s">speed</effect>
</loadout>

Element Text

DescriptionType

The type of the effect that the potion will cause.

PotionEffectType
Possible Values
Effects Attributes
AttributeDescriptionTypeDefault
amplifier

The amplifier of the potion effect.

Number (Without Decimal)1
duration

The duration of the effect.

This attribute denotes a period of time and can either be in seconds or in a period format.

Formats are as follows:

d - days

h - hours

m - minutes

s - seconds

These can be combined to create any period. No spaces are allowed.

Duration1

Exhaustion<exhaustion>

Set the player's level of exhaustion (This ranges from 0.0 to 4.0. When the exhaustion level reaches above 4.0 it will get subtracted by 4.0 and subtracts 1 point of hunger or saturation.)

<loadout>
  ...
  <exhaustion action="multiply">2</exhaustion>
</loadout>

Element Text

DescriptionType

The exhaustion modifier that should be used by the action.

Number (Without Decimal)
Exhaustion Attributes
AttributeDescriptionTypeDefault
action

The action which is applied to the player's exhaustion level.

Number Action

none - Perform no action and keep the player's exhaustion level the same.,
set - Set the player's exhaustion level to the supplied number.,
add - Add the supplied number to the player's exhaustion level.,
subtract - Subtract the supplied number from the player's exhaustion level.,
multiply - Multiply the supplied number with the player's exhaustion level.,
divide - Divide the player's exhaustion level by the supplied number.,
power - Raise the player's exhaustion level by the supplied number.
set

Experience Level<exp-level>

Set the player's experience level. (This is the number above the bar)

<loadout>
  ...
  <exp-level action="add">4</exp-level>
</loadout>

Element Text

DescriptionType

The XP modifier that should be used by the action.

Number (Without Decimal)
Experience Level Attributes
AttributeDescriptionTypeDefault
action

The action which is applied to the player's XP level.

Number Action

none - Perform no action and keep the player's XP level the same.,
set - Set the player's XP level to the supplied number.,
add - Add the supplied number to the player's XP level.,
subtract - Subtract the supplied number from the player's XP level.,
multiply - Multiply the supplied number with the player's XP level.,
divide - Divide the player's XP level by the supplied number.,
power - Raise the player's XP level by the supplied number.
set

Experience Points<exp-points>

Set the player's experience points. (This is the value on the bar)

<loadout>
  ...
  <exp-points action="subtract">2</exp-points>
</loadout>

Element Text

DescriptionType

The XP modifier that should be used by the action.

Number (Without Decimal)
Experience Points Attributes
AttributeDescriptionTypeDefault
action

The action which is applied to the player's XP points.

Number Action

none - Perform no action and keep the player's XP points the same.,
set - Set the player's XP points to the supplied number.,
add - Add the supplied number to the player's XP points.,
subtract - Subtract the supplied number from the player's XP points.,
multiply - Multiply the supplied number with the player's XP points.,
divide - Divide the player's XP points by the supplied number.,
power - Raise the player's XP points by the supplied number.
set

Fly Speed<fly-speed>

Set the player's fly speed.

<loadout>
  ...
  <fly-speed action="add">4</fly-speed>
</loadout>

Element Text

DescriptionType

The speed modifier that should be used by the action.

Number (Without Decimal)
Fly Speed Attributes
AttributeDescriptionTypeDefault
action

The action which is applied to the player's fly speed.

Number Action

none - Perform no action and keep the player's fly speed the same.,
set - Set the player's fly speed to the supplied number.,
add - Add the supplied number to the player's fly speed.,
subtract - Subtract the supplied number from the player's fly speed.,
multiply - Multiply the supplied number with the player's fly speed.,
divide - Divide the player's fly speed by the supplied number.,
power - Raise the player's fly speed by the supplied number.
set

Food<food-level>

You can use this to set the player's food.

<loadout>
  ...
  <food-level action="add">4</food-level>
</loadout>

Element Text

DescriptionType

The food modifier that should be used by the action.

Number (Without Decimal)
Food Attributes
AttributeDescriptionTypeDefault
action

The action which is applied to the player's food level.

Number Action

none - Perform no action and keep the player's food level the same.,
set - Set the player's food level to the supplied number.,
add - Add the supplied number to the player's food level.,
subtract - Subtract the supplied number from the player's food level.,
multiply - Multiply the supplied number with the player's food level.,
divide - Divide the player's food level by the supplied number.,
power - Raise the player's food level by the supplied number.
set

Generic Items<boots><chestplate><helmet><item><kit-menu><leggings><shop-opener>

Items can have many attributes, and are the main element of loadouts.

<loadout id="default">
  <item slot="0" material="stone sword" />
  <item slot="1" material="bow" />
</loadout>

Generic Items Attributes
AttributeDescriptionTypeDefault
slot

Slot in the inventory where the item should be placed. (If no slot is specified, the item will be put in the first available slot)

Number (Without Decimal)
material

The material of the item.

Material
Possible Values
shop-id

If a shop opener, which shop this item should open on right click.

The id of the shop for reference.

Shop ID
damage

The damage value of the item. (This can be used to color wool or to change the durability of a pickaxe.)

Number (Without Decimal)
amount

The amount of the item to be given to the player. (Use -1 for infinite stacks)

Number (Without Decimal)1
unbreakable

If the item should never run out of durability.

True/Falsefalse
flags

The flags that should be applied to the item. Separate each flag with a ,

Text
color

The color to be applied to the item. (This item must be a colorable item, or a parser error will be thrown)

Colors can be defined in 2 different ways.

If the color starts with a '#', the hex of the color will be parsed (use this for exact colors)

If not, a generic color (red, green, blue, etc) should be used.

Color
team-color

If the player's team color should be used to color the item. This will override the other color attribute.

True/Falsefalse
potion

The type of the potion that will be displayed. (This will not override the effects added by the effects tag)

PotionType
Possible Values
projectile

The id of the projectile for reference.

Projectile ID

Banner Designs<pattern>

Banner designs can also be created via XML, and can be combined to create complex designs. Designs are applied in the order that they are written.

<pattern color="red">stripe center</pattern>

<pattern color="blue">diagonal left</pattern>

Banner Designs Attributes
AttributeDescriptionType
pattern

The name of the type of pattern to be applied.

PatternType
Possible Values
color

The color of the pattern.

Colors can be defined in 2 different ways.

If the color starts with a '#', the hex of the color will be parsed (use this for exact colors)

If not, a generic color (red, green, blue, etc) should be used.

Color

Effects<effects>

This is used to apply potion effects to potions.

SpecificationChanges
1.0.4Item effects now must be wrapped in corresponding sub-tags.
<item slot="3" material="potion" damage="16426" amount="4">
  <effect amplifier="2" duration="3m">absorption</effect>
</item>

Effects Attributes
AttributeDescriptionTypeDefault
type

Type of the effect to be applied.

PotionEffectType
Possible Values
amplifier

The amplifier of the potion effect.

Number (Without Decimal)1
duration

The duration of the effect.

This attribute denotes a period of time and can either be in seconds or in a period format.

Formats are as follows:

d - days

h - hours

m - minutes

s - seconds

These can be combined to create any period. No spaces are allowed.

Duration1

Enchantments<enchantments>

This is used to apply enchantments to items.

SpecificationChanges
1.0.4Item enchantments now must be wrapped in corresponding sub-tags.
<item name="The King's Helmet" material="diamond helmet">
  <enchantments>
    <enchantment level="4">protection environmental</enchantment>
    <enchantment level="3">durability</enchantment>
    <enchantment level="3">thorns</enchantment>
  </enchantments>
</item>

Enchantments Attributes
AttributeDescriptionTypeDefault
type

The type of enchantment to apply to the item.

Enchantment
Possible Values
level

The level of the enchantment to be applied to the item.

Number (Without Decimal)1

Stored Enchantments<stored-enchantments>

This is used to store enchantments inside of enchanted books.

SpecificationChanges
1.0.4ADDED
<stored-enchantment level="12">speed</stored-enchantment>

<stored-enchantment level="12">night vision</stored-enchantment>

Element Text

DescriptionType

The enchantment to store.

Enchantment
Possible Values
Stored Enchantments Attributes
AttributeDescriptionTypeDefault
level

The level of the enchantment.

Number (Without Decimal)1

Health<health>

You can use this to set the player's health.

<loadout>
  ...
  <health action="add">4</health>
</loadout>

Element Text

DescriptionType

The health modifier that should be used by the action.

Number (Without Decimal)
Health Attributes
AttributeDescriptionTypeDefault
action

The action which is applied to the player's health.

Number Action

none - Perform no action and keep the player's health the same.,
set - Set the player's health to the supplied number.,
add - Add the supplied number to the player's health.,
subtract - Subtract the supplied number from the player's health.,
multiply - Multiply the supplied number with the player's health.,
divide - Divide the player's health by the supplied number.,
power - Raise the player's health by the supplied number.
set

Health Scale<health-scale>

You can use this to set the player's health scale.

<loadout>
  ...
  <health-scale action="multiply">2</health-scale>
</loadout>

Element Text

DescriptionType

The health modifier that should be used by the action.

Number (Without Decimal)
Health Scale Attributes
AttributeDescriptionTypeDefault
action

The action which is applied to the player's health scale.

Number Action

none - Perform no action and keep the player's health scale the same.,
set - Set the player's health scale to the supplied number.,
add - Add the supplied number to the player's health scale.,
subtract - Subtract the supplied number from the player's health scale.,
multiply - Multiply the supplied number with the player's health scale.,
divide - Divide the player's health scale by the supplied number.,
power - Raise the player's health scale by the supplied number.
set

Max Health<max-health>

You can use this to set the player's max health.

<loadout>
  ...
  <max-health action="subtract">2</max-health>
</loadout>

Element Text

DescriptionType

The health modifier that should be used by the action.

Number (Without Decimal)
Max Health Attributes
AttributeDescriptionTypeDefault
action

The action which is applied to the player's max health.

Number Action

none - Perform no action and keep the player's max health the same.,
set - Set the player's max health to the supplied number.,
add - Add the supplied number to the player's max health.,
subtract - Subtract the supplied number from the player's max health.,
multiply - Multiply the supplied number with the player's max health.,
divide - Divide the player's max health by the supplied number.,
power - Raise the player's max health by the supplied number.
set

Player Heads<player-head>

You can use this tag to give player heads in loadouts.

<player-head slot="1" uuid="069a79f444e94726a5befca90e38aaf5" />

Player Heads Attributes
AttributeDescriptionType
slot

Slot in the inventory where the item should be placed. (If no slot is specified, the item will be put in the first available slot)

Number (Without Decimal)
uuid

UUID of the owner of the head.

Minecraft UUID

Randomizer<randomizer>

Randomizers are used to give random items in loadouts with a chance.

SpecificationChanges
1.0.4ADDED
<loadout id="randomizer">
  <randomizer min="1" max="1">...</randomizer>
</loadout>

Randomizer Attributes
AttributeDescriptionType
min

The minimum stack size for items.

Number (Without Decimal)
max

The maximum stack size for items.

Number (Without Decimal)

Item Set<items>

Item sets are used to define sets of items that can be given with a weight.

<items max="1" min="1">
  <item name="^e^lThe King's Helmet" material="diamond helmet">
    <enchantments>
      <enchantment level="4">protection environmental</enchantment>
      <enchantment level="3">durability</enchantment>
      <enchantment level="3">thorns</enchantment>
    </enchantments>
    <lore>
      <line>King of the Ladder!</line>
    </lore>
  </item>
</items>

Item Set Attributes
AttributeDescriptionType
min

Minimum item stack size.

Number (Without Decimal)
max

Maximum item stack size.

Number (Without Decimal)
weight

Weight of each item in set.

Number (With Decimal)

Saturation<saturation>

You can use this to set the player's saturation.

<loadout>
  ...
  <saturation action="subtract">2</saturation>
</loadout>

Element Text

DescriptionType

The saturation modifier that should be used by the action.

Number (Without Decimal)
Saturation Attributes
AttributeDescriptionTypeDefault
action

The action which is applied to the player's saturation level.

Number Action

none - Perform no action and keep the player's saturation level the same.,
set - Set the player's saturation level to the supplied number.,
add - Add the supplied number to the player's saturation level.,
subtract - Subtract the supplied number from the player's saturation level.,
multiply - Multiply the supplied number with the player's saturation level.,
divide - Divide the player's saturation level by the supplied number.,
power - Raise the player's saturation level by the supplied number.
set

Time<time>

You can use this to set the player's personal time.

<loadout>
  ...
  <time action="add">10000</time>
</loadout>

Element Text

DescriptionType

The time modifier that should be used by the action.

Number (Without Decimal)
Time Attributes
AttributeDescriptionTypeDefault
action

The action which is applied to the player's local time.

Number Action

none - Perform no action and keep the player's local time the same.,
set - Set the player's local time to the supplied number.,
add - Add the supplied number to the player's local time.,
subtract - Subtract the supplied number from the player's local time.,
multiply - Multiply the supplied number with the player's local time.,
divide - Divide the player's local time by the supplied number.,
power - Raise the player's local time by the supplied number.
set

Total Experience<exp-total>

Set the player's total experience level. (This will override both of the above values)

<loadout>
  ...
  <exp-total action="multiply">2</exp-total>
</loadout>

Element Text

DescriptionType

The XP modifier that should be used by the action.

Number (Without Decimal)
Total Experience Attributes
AttributeDescriptionTypeDefault
action

The action which is applied to the player's total XP.

Number Action

none - Perform no action and keep the player's total XP the same.,
set - Set the player's total XP to the supplied number.,
add - Add the supplied number to the player's total XP.,
subtract - Subtract the supplied number from the player's total XP.,
multiply - Multiply the supplied number with the player's total XP.,
divide - Divide the player's total XP by the supplied number.,
power - Raise the player's total XP by the supplied number.
set

Vehicle<vehicle>

Vehicles are used to mount players on entities when they receive the loadout.

SpecificationChanges
1.0.4ADDED
<vehicle remove="true">boat</vehicle>

Element Text

DescriptionType

The type of vehicle.

EntityType
Possible Values
Vehicle Attributes
AttributeDescriptionTypeDefault
sticky

If the player should be unable to dismount from the entity.

True/Falsefalse
remove

If the entity should be removed when the player dismounts.

True/Falsefalse
velocity

The initial velocity of the entity.

X,Y,Z Vector0, 0, 0

Walk Speed<walk-speed>

Set the player's walk speed.

<loadout>
  ...
  <walk-speed action="subtract">2</walk-speed>
</loadout>

Element Text

DescriptionType

The speed modifier that should be used by the action.

Number (Without Decimal)
Walk Speed Attributes
AttributeDescriptionTypeDefault
action

The action which is applied to the player's walk speed.

Number Action

none - Perform no action and keep the player's walk speed the same.,
set - Set the player's walk speed to the supplied number.,
add - Add the supplied number to the player's walk speed.,
subtract - Subtract the supplied number from the player's walk speed.,
multiply - Multiply the supplied number with the player's walk speed.,
divide - Divide the player's walk speed by the supplied number.,
power - Raise the player's walk speed by the supplied number.
set

Weather<weather>

Use this to set the player's personal weather state.

<loadout>
  ...
  <weather>sunny</weather>
</loadout>

Element Text

DescriptionType

The type of weather the player should see.

Weather Type

downfall,clear