XML Documentation

What is the XML Documentation?

XML is the language in which almost every Transformice map is stored in. XML Editing is a core aspect of Map Making and is necessary to create the advanced mechanics and gameplay features we take for granted in user made maps. However, to date there has not been a comprehensive, up to date guide to every different aspect of XML. This is where this topic, the XML Documentation, comes in.

This thread is a fully fledged guide to aid in understanding and using all the various parameters which make up a map's XML. It is split into different sections, each dealing with it's own section of the Map XML. Usage examples of each tag and explanations of their uses may be found in individual spoilers within these sections to help you to utilize the tags.

How can I learn more about Map Making?

You can refer to these topics.

This topic was written by myself utilising my knowledge of the Map Editor and referencing the EN translation of the FR XML Documentation.

Credits

Reference

IDs

Map XML related IDs, sourced from Module FAQ and Documentation and New Objects Tutorial.

Shaman Object IDs

A complete list of the Shaman Object IDs.
Some of these cannot be placed in the Editor, even through XML editing, so they are crossed out. However, some of these crossed out IDs can be put into the editor if 65536 is added to the ID number.

0 - Arrow
1 - Small Box
2 - Large Box
3 - Small Plank
4 - Large Plank
5 - Heavy Ball
6 - Ball
7 - Trampoline
8 - Small Rough Plank
9 - Large Rough Plank
10 - Anvil
11 - Red Anchor
12 - Red Anchor Rotating Clockwise
13 - Red Anchor Rotating Counter-Clockwise
14 - Green Anchor
15 - Green Anchor Rotating Clockwise
16 - Green Anchor Rotating Counter-Clockwise
17 - Cannon (Up)
18 - Cannon (Down)
19 - Cannon (Right)
20 - Cannon (Left)
21 - Sticky Ball
22 - Yellow Anchor
23 - Bomb
24 - Spirit
25 - Fake Cheese
26 - Blue Portal
27 - Orange Portal
28 - Balloon
29 - Static Red Balloon
30 - Static Green Balloon
31 - Static Yellow Balloon
32 - Rune
33 - Chicken
34 - Snowball
35 - Valentine's Arrow
39 - Apple
40 - Sheep
41 - Demolition Worker Skill
42 - Spring
43 - Speed Boost
44 - Totem
45 - Ice Plank
46 - Choco Plank
48 - Transformed Mouse Small Box
49 - Transformed Mouse Large Box
50 - Transformed Mouse Anvil
51 - Transformed Mouse Small Plank
52 - Transformed Mouse Large Plank
53 - Transformed Mouse
54 - Frozen Mouse
57 - Cloud
58 - Architect Skill
59 - Bubble
60 - Tiny Plank
61 - Companion Crate
62 - Stable Rune
65 - Pufferfish
66 - Balloon Anchor
67 - Very Long Plank
68 - Triangle Box
69 - S-Shaped Plank
70 - Cobweb Skill
71 - Roll Skill
72 - Recycling Skill
73 - Small Mouse Skill
74 - Leaf Skill
75 - Nature's Return Skill
76 - Booster Skill
77 - Handymouse Skill
78 - Restorative Skill
79 - Stop Skill
80 - Mouse in Bubble
81 - Gravitational Anomaly Skill
82 - Antigravity Skill
83 - Meep Skill
84 - Grapnel Skill
85 - Controlled Disintegration Skill
86 - Campfire Skill
87 - Shameow Skill (Broken)
88 - Conjuration Anchor
89 - Pumpkin
90 - Tombstone
91 - Snowman
92 - Renewal Skill
93 - Small Cloud
94 - Shameow Skill
100, 103-199, 20000-29999 - Invisible Small Box
101 - Small Heart Box
102 - Small Mechanical Box
103 - Small Christmas Box
104 - Small Cake Box
200, 204-299, 30000-32767 - Invisible Large Box
201 - Large Heart Box
202 - Large Mechanical Box
203 - Large Bubble Box
204 - large Pumpkin Box
205 - Large Christmas Box
206 - Large Shaman Box
207 - Large Cake Box
300, 303-399 - Invisible Small Plank
301 - Small Heart Plank
302 - Small Mechanical Plank
400, 404-499 - Invisible Large Plank
401 - Large Heart Plank
402 - Large Mechanical Plank
403 - Large Alligator Plank
600, 602-699 - Invisible Ball
601 - Pokéball
602 - Skull Ball
700, 702-799 - Invisible Trampoline
701 - Leafy Trampoline
1000, 1001, 1004-1099 - Invisible Anvil
1002 - Mechanical Anvil
1003 - Rock Anvil
1700, 1702-1799 - Invisible Cannon (Up)
1701 - Bubble Cannon (Up)
1800-1899 - Invisible Cannon (Down)
1900-1999 - Invisible Cannon (Right)
2000-2099 - Invisible Cannon (Left)
2801 - Cat Balloon
2802 - Mechanical Balloon
2803 - Striped Balloon
2804 - Spiky Balloon
2805 - Frog Balloon
2806 - Heart Balloon
2807 - Bubble Balloon
2800, 2808-3199 - Invisible Balloon
3200-3299 - Invisible Rune
3500-3599 - Invisible Valentine's Arrow
3900-3999 - Invisible Apple
4000-4099 - Invisible Sheep
4500-4599 - Invisible Ice Plank
4600-4699 - Invisible Choco Plank
5700-5799 - Invisible Cloud
5900-5999 - Invisible Bubble
6000-6099 - Invisible Tiny Plank
6100-6199 - Invisible Companion Crate
6200-6299 - Invisible Stable Rune
6500-6599 - Invisible Pufferfish
65536 - Arrow (repeats back from 0)

Ground IDs

Decoration IDs

A complete list of the Decoration IDs.

0 - Bush
1 - Tree
2 - Fern
3 - Blue Flower
4 - Sign
5 - Grass
6 - Coconut Tree
7 - Umbrella
8 - Sand Castle
9 - Shovel
10 - Sand Bucket
11 - Red Flower
12 - Thorns
13 - Fence
14 - Window
15 - Sofa
16 - Chair
17 - Table 1
18 - Vase of Flowers 1
19 - Sofa with 1 Place
20 - Vase of Flowers 2
21 - Roast Chicken
22 - Bookcase
23 - Poster
24 - Bed
25 - Radio
26 - Teddy
27 - Abajour
28 - Refrigerator
29 - Wardrobes
30 - TV with Stand
31 - Soda
32 - Vase of Flowers 3
33 - Nightstand
34 - Fund 1
35 - range of Halloween 1
36 - range of Halloween 2
37 - Broom
38 - Skeleton
39 - Halloween Poster
40 - Balloons Halloween
41 - Web with Spider
42 - Autumn Tree
43 - Bats
44 - Torch
45 - Fund Cemetery
46 - Torch 2
47 - About Grades
48 - Pumpkin 1
49 - Pumpkin 2
50 - Snowmouse
51 - Snowy Tree
52 - Cookies with Milk
53 - Garland
54 - Half Hanging
55 - Candle 1
56 - Band Christmas
57 - Christmas Tree
58 - Ice Stalactites
59 - Mistletoe
60 - Ball Christmas Tree
61 - Lights Natalinas
62 - Present
63 - Gifts
64 - Santa
65 - Loop
66 - Valentine's Umbrella
67 - Valentine's Chair
68 - Valentine's Table
69 - Valentine's Plate
70 - Valentine's Day Gift
71 - Candle 2
72 - Vase of Flowers 4
73 - Flower in Vase
74 - Ribbons with Hearts
75 - Balloon Heart
76 - Valentine's Window
77 - Heart Pendant
78 - Stones with Algae
79 - Algae 1
80 - Chest
81 - Starfish
82 - Shell
83 - Stones
84 - Stones with Algae 2
85 - Coral 1
86 - Coral 2
87 - Algae 2
88 - Broken Vase
89 - Big Screen
90 - Small Screen
91 - Alchemy Pot
92 - Objects of Alchemy 1
93 - Objects of Alchemy 2
94 - Bookshelf 2
95 - Piano
96 - Fireplace
97 - Candelebra
98 - Coffin
99 - Paper Holder
100 - Bottle with Substance 1
101 - Bottle with Substance 2
102 - Buff
103 - Barrel
104 - Table 2
105 - Chair 2
106 - Skull Mouse
107 - Cobweb 1
108 - Cobweb 2
109 - Cobweb 3
110 - Cobweb 4
111 - Cobweb 5
112 - Vampire Portrait
113 - Support with Fruits
114 - Mirror
115 - Tombstone of Elise
116 - Crucifix
117 - Background 2
118 - RIP Tombstone
119 - Toilet
120 - Bath & Curtains
121 - Sink/Faucet
122 - Mirror
123 - Pots & Pans
124 - Oven
125 - Rocking Chair
126 - Pot
127 - Bar Stool
128 - Kitchen Cabinet
129 - Kitchen Drawers
130 - Lava Lamp
131 - Bootcamp Checkpoint

Map Settings
 tag

These tags go into tag at the start of the XML and specify various map settings. At the bottom of this tab, the "Reference" spoiler shows where this tag goes.

A=""

aie=""

bh=""

C=""

Ca=""

D="url1,x1,y1,r1;url2,x2,y2,r2"

d="url1,x1,y1,r1;url2,x2,y2,r2"

defilante="vi,a,vm,s"

DS="mode;x,y"

F="id"

G="w,g"

H="value"

L="value"

mc=""

mgoc="value"

N=""

P=""

Reference

Grounds
<S /> tag

These tags go into <S /> tag(s) inside the <S> </S> container tag. They specify ground properties and settings. At the bottom of this tab, the "Reference" spoiler shows where this tag goes.

c="value"

H="value"

i="x,y,url"

L="value"

lua="id"

m=""

N=""

nosync=""

o="color"

P="isdyn,mass,friction,restit,angle,fixrotat,lindamp,angdamp"

T="id"

v="time"

X="x"

Y="y"

Z="id"

Reference

Dernière modification le

Decorations and Mouse Objects

These tags go into the <D> </D> container tag. They specify decorations, mouse spawns, the mouse hole and cheese. At the bottom of this tab, the "Reference" spoiler shows where these tags go.

Decorations
 tag

These tags go into the tag (within the <D></D> tags) and specify the properties of the decoration.

C="c1,c2,c3,c4"

P="fore,invert"

T="id"

X="x"

Y="y"

Z="id"

Shaman Spawn
<DC /> tag

These tags go into the <DC /> tag and specify the properties of the Shaman Spawn. This can only be placed once in the map.

X="x"

Y="y"

Dual Shaman Spawn
<DC2 /> tag

These tags go into the <DC2 /> tag and specify the properties of the Dual Shaman Spawn. This can only be placed once in the map.

X="x"

Y="y"

Mouse Spawn
<DS /> tag

These tags go into the <DS /> tag and specify the properties of the Mouse Spawn. The locations provided in this spawn overrides the coordinates provided in the DS="mode;x,y" tag in . In addition, this can only be placed once on the map.

X="x"

Y="y"

Cheese
<F /> tag

These tags go into the <F /> tag and specify the properties of the cheese.

X="x"

Y="y"

Hole
<T /> tag

These tags go into the <T /> tag and specify the properties of the hole.

X="x"

Y="y"

Reference

Shaman Objects
<O /> tag

These tags go into <O /> tag(s) inside the <O> </O> container tag. They specify shaman objects and properties they may have. At the bottom of this tab, the "Reference" spoiler shows where this tag goes.

C="id"

Mp="power"

Mv="speed"

nosync=""

P="angle,collision"

X="x"

Y="y"

Z="id"

Reference

Joints
<L /> tag

These tags go into the <L> </L> container tag. They specify the various different types of joints and their properties. At the bottom of this tab, the "Reference" spoiler shows where these tags go.

Distance Joint
<JD /> tag

These tags go into the <JD /> tag and specify the properties of the Distance Joint.

AMP="value"

c="color,thickness,alpha",appearance

HZ="value"

M1="z"

M2="z"

P1="x,y"

P2="x,y"

Prismatic Joint
<JP /> tag

These tags go into the <JP /> tag and specify the properties of the Prismatic Joint.

A="angle"

AXIS="isx,isy"

LIM1="value"

LIM2="value"

M1="z"

M2="z"

MV="power,speed"

Pulley Joint
<JPL /> tag

These tags go into the <JPL /> tag and specify the properties of the Pulley Joint.

c="color,thickness,alpha",appearance

M1="z"

M2="z"

P1="x,y"

P2="x,y"

P3="x,y"

P4="x,y"

R="ratio"

Revolute Joint
<JR /> tag

These tags go into the <JR /> tag and specify the properties of the Revolute Joint.

LIM1="value"

LIM2="value"

M1="z"

M2="z"

MV="power,speed"

P1="x,y"

P2="x,y"

Reference

Reserved.

Awesome tutorial!

Nice job ^^

Nice rezanko

This finally went out, good job

Great!

Fantastic!

#10

Drescen a dit :
F="id"

Effect: Sets the background for the map.

Arguments:
id (integer) - The ID of the background selected to display. A list of IDs can be found in the IDs section.

Notes:
The background will stretch to acommodate maps with scroll.

Example: Displays the Christmas background.
<C><Z><S><S X="400" L="400" Y="390" H="20" P="0,0,0.3,0.2,0,0,0,0" T="0" /></S><D><DS X="400" Y="370" /></D><O /></Z></C>

Background IDs aren't listed in the IDs section.

Background IDs

Found out some bugs though:
• ID 6 shows up as some sort of Valentines day background.
• ID 7 shows up as Storm clouds.
• ID 8 shows up as Storm clouds 2.

Dernière modification le

#11

Kimsterjay a dit :
...

I recall making an updated list of the IDs section with some ingame testing, I probably just forgot to add it. I'll add it in later.

#12

If you set F="" as -2 the background will always be random ^^'

#13

Bolodefchoco a dit :
If you set F="" as -2 the background will always be random ^^'

Ah I didn't know that ^^
I guess it should be:

Background IDs

Dernière modification le

#14

Awesome tutorial ^.^

#15

how do you make duplicate mouse spawns?

#16

Overjoy06 a dit :
how do you make duplicate mouse spawns?

Look under "Map settings" tab, under the "DS="mode;x,y"" spoiler

If you are looking for 2 spawn points, example 1 explains it (aka DS="m;x1,y1,x2,y2")
Oh the example is wrong, it says the first point is (400,370) when the xml code shows (250,370) lol

#17

Thank you so much ^^

#18

Tat a dit :
Oh the example is wrong, it says the first point is (400,370) when the xml code shows (250,370) lol

This is now fixed

#19

Alright this will be add my favorite for good tutorial.

However...

Bolodefchoco a dit :
If you set F="" as -2 the background will always be random ^^'

I tried doing on editor map, but not random for reason it still daylight. How does work for this?

#20

Anthonyjones a dit :
I tried doing on editor map, but not random for reason it still daylight. How does work for this?

This setting is a bit odd. I think it only works if you play your map in a room (tribehouse, etc).

English	Français
Português do Brasil	Español
Türkçe	Polski
Magyar	Română
العربية	Skandinavisk
Nederlands	Deutsch
Bahasa Indonesia	Русский
中文	Filipino
Lietuvių kalba	日本語
Suomi	עברית
Italiano	Česky
Hrvatski	Slovensky
Български	Latviešu
Estonian

Langue