Skip to main content
The metadata.txt file defines metadata for maps, including music, weather, environment settings, and player spawn points. Each map has its own section.

​
File Format

Each map is defined by a section header with its map ID, followed by field definitions: 
[MapID]
FieldName=Value
FieldName2=Value2

​
Example Entries

[000]
WildVictoryME=Victory - Wild Pokemon.ogg
WildBattleBGM=Battle! (Wild Pokemon)
TrainerVictoryME=Victory - Trainer.ogg
TrainerBattleBGM=Battle! (Trainer)
PlayerA=POKEMONTRAINER_Red,boy_run.png,boy_bike,boy_surf_offset
PlayerB=POKEMONTRAINER_Leaf,trchar001,girl_bike,girl_surf_offset
Home=4,22,5,2

[001]
Outdoor=true
ShowArea=true
MapPosition=0,13,11

​
Global Settings (Map 000)

Map ID [000] contains global game settings that apply to all maps.
​
WildBattleBGM
String
Default wild Pokémon battle music.
WildBattleBGM=Battle! (Wild Pokemon)
​
WildVictoryME
String
Victory music effect after wild battles.
WildVictoryME=Victory - Wild Pokemon.ogg
​
TrainerBattleBGM
String
Default trainer battle music.
TrainerBattleBGM=Battle! (Trainer)
​
TrainerVictoryME
String
Victory music effect after trainer battles.
TrainerVictoryME=Victory - Trainer.ogg
​
BicycleBGM
String
Music played when riding a bicycle.
BicycleBGM=Bike
​
SurfBGM
String
Music played when surfing.
SurfBGM=Surf
​
PlayerA
Player Data
Male player character settings. Format:
TrainerType,Charset,Bike,Surf,Run,DiveSurf,FishOffset,MotorBike

PlayerA=POKEMONTRAINER_Red,boy_run.png,boy_bike,boy_surf_offset,boy_run,boy_surf_offset,boy_fish_offset,boy_fish_offset
​
PlayerB
Player Data
Female player character settings. Same format as PlayerA.
PlayerB=POKEMONTRAINER_Leaf,trchar001,girl_bike,girl_surf_offset,girl_run,girl_surf_offset,girl_fish_offset,girl_fish_offset
​
Home
Coordinates
Starting position when starting new game or blacking out. Format: MapID,X,Y,DirectionDirection values: 2=Down, 4=Left, 6=Right, 8=Up
Home=4,22,5,2  # Map 4, X=22, Y=5, facing down

​
Map-Specific Settings

Settings for individual maps (Map ID 1 and above).

​
Environment Settings

​
Outdoor
Boolean
Whether the map is outdoors. Affects day/night cycle.
Outdoor=true   # Outdoor map
Outdoor=false  # Indoor map (or omit)
​
ShowArea
Boolean
Display location name when entering the map.
ShowArea=true   # Show location popup
ShowArea=false  # No popup (or omit)
​
Bicycle
Boolean
Whether the bicycle can be used on this map.
Bicycle=true   # Can use bike
Bicycle=false  # Cannot use bike
​
BicycleAlways
Boolean
Forces bicycle use (Cycling Road).
BicycleAlways=true
​
HealingSpot
Coordinates
Where player respawns after whiteout. Format: MapID,X,Y
HealingSpot=2,8,8  # Respawn at map 2, position (8,8)
​
Weather
Weather,Probability
Weather conditions on the map. Format: WeatherType,ChanceWeather types:
  • Rain - Rain
  • Storm - Heavy rain with thunder
  • Snow - Snowfall
  • Blizzard - Heavy snow
  • Sandstorm - Sandstorm
  • HeavyRain - Intense rain
  • Sun - Harsh sunlight
  • Fog - Foggy
Probability: 0-100 (percentage chance)
Weather=Rain,50      # 50% chance of rain
Weather=Snow,100     # Always snowing
Weather=Sandstorm,30 # 30% sandstorm
​
MapPosition
Region,X,Y
Position on the region map. Format: RegionID,X,Y
MapPosition=0,13,11  # Region 0, position (13,11)
MapPosition=0,13,10
​
DiveMap
MapID
Map ID to warp to when diving underwater.
DiveMap=42  # Dive to map 42
​
DarkMap
Boolean
Map is dark and requires Flash to illuminate.
DarkMap=true
​
SafariMap
Boolean
Map is part of Safari Zone.
SafariMap=true
​
SnapEdges
Boolean
Player snaps to edges when moving near them.
SnapEdges=true
​
Dungeon
Boolean
Map is a dungeon (affects escape behavior).
Dungeon=true
​
BattleBack
String
Battle background graphic name (without extension).Common values:
  • IndoorA, IndoorB, IndoorC
  • Cave, Rocky
  • Forest, Grass
  • Sand, Beach
  • Water, Ocean
  • Elite
BattleBack=IndoorB
BattleBack=Cave
BattleBack=Forest
​
WildBattleBGM
String
Wild battle music for this specific map (overrides global).
WildBattleBGM=Battle! (Legendary)
​
TrainerBattleBGM
String
Trainer battle music for this specific map (overrides global).
TrainerBattleBGM=Battle! (Gym Leader)
​
BicycleBGM
String
Bicycle music for this specific map (overrides global).
BicycleBGM=Cycling Road

​
Complete Examples

​
Outdoor Route

[005]
# Ruta 1
Outdoor=true
ShowArea=true
MapPosition=0,13,7
  • Outdoor map with day/night
  • Shows location name
  • Position on region map

​
Town/City

[001]
# Perales
Outdoor=true
ShowArea=true
MapPosition=0,13,11
  • Outdoor town
  • Shows location name
  • Specific map position

​
Indoor Building

[003]
# Laboratorio
BattleBack=IndoorB
HealingSpot=2,8,8
MapPosition=0,13,9
  • Indoor (no Outdoor field)
  • Custom battle background
  • Healing spot set
  • Still has map position for Town Map

​
Player’s House

[004]
# CasaPrincipal
MapPosition=0,13,8
  • Simple indoor location
  • Only needs map position

​
Cave Map

[020]
# Mt. Moon
Outdoor=false
DarkMap=true
BattleBack=Cave
Dungeon=true
MapPosition=0,15,5
  • Dark cave (needs Flash)
  • Cave battle background
  • Marked as dungeon
  • Cannot use Escape Rope

​
Water Route

[025]
# Sea Route
Outdoor=true
ShowArea=true
BattleBack=Water
Bicycle=false
MapPosition=0,10,8
  • Outdoor water route
  • Water battle background
  • Cannot use bicycle
  • Shows area name

​
Special Location

[050]
# Victory Road
Outdoor=false
DarkMap=true
Dungeon=true
BattleBack=Rocky
Bicycle=false
WildBattleBGM=Battle! (Victory Road)
MapPosition=0,20,5
  • Dark dungeon
  • Rocky battle background
  • No bicycle
  • Custom wild battle music

​
Global Settings Example

[000]
WildVictoryME=Victory - Wild Pokemon.ogg
WildBattleBGM=Battle! (Wild Pokemon)
BicycleBGM=Bike
SurfBGM=Surf
TrainerVictoryME=Victory - Trainer.ogg
TrainerBattleBGM=Battle! (Trainer)
PlayerB=POKEMONTRAINER_Leaf,trchar001,girl_bike,girl_surf_offset,girl_run,girl_surf_offset,girl_fish_offset,girl_fish_offset
PlayerA=POKEMONTRAINER_Red,boy_run.png,boy_bike,boy_surf_offset,boy_run,boy_surf_offset,boy_fish_offset,boy_fish_offset
Home=4,22,5,2

​
Weather Examples

[030]
Outdoor=true
ShowArea=true
Weather=Rain,70
MapPosition=0,12,6
70% chance of rain when entering the map.
[035]
Outdoor=true
ShowArea=true
Weather=Snow,100
BattleBack=Snow
MapPosition=0,15,3
Always snowing.
[040]
Outdoor=true
ShowArea=true
Weather=Sandstorm,80
BattleBack=Sand
MapPosition=0,8,10
80% sandstorm probability.

​
Map Position Guide

The MapPosition field places your location on the Town Map/Fly screen: 
MapPosition=RegionID,X,Y
  • RegionID: Which region map (usually 0 for main region)
  • X: Horizontal position on map
  • Y: Vertical position on map
Example region layout: 
MapPosition=0,13,11  # Top-left town
MapPosition=0,13,10  # Route below
MapPosition=0,13,9   # Next town
MapPosition=0,13,7   # Further route
Music Files: All music file references (BGM, ME) should match filenames in your Audio/BGM and Audio/ME folders, without the file extension.
Battle Backgrounds: Battle background names must match files in Graphics/Battlebacks/ folder. Use the filename without extension.
Comments: Use # for comments to document your maps. Comments are ignored by the game.

Build docs developers (and LLMs) love

Get started for freeTalk to us