porymap

User Manual

  • Introduction
    • About Porymap
    • Getting Started
  • Navigation
    • Map List
      • Tabs
      • Buttons
      • Status Icons
    • Main Window
  • Editing Map Tiles
    • Visual Options
    • Selecting Metatiles
    • Pencil Tool
    • Pointer Tool
    • Bucket Fill Tool
    • Move Tool
    • Map Shift Tool
    • Smart Paths
    • Straight Paths
    • Change Dimensions
      • Border Dimensions
    • Change Layout
    • Change Map Tilesets
    • Change Map Border
    • Undo & Redo
    • Prefabs
  • Editing Map Collisions
    • Selecting Collision Types
    • Painting Collisions
    • Collision Types
  • Editing Map Events
    • Adding & Deleting Events
    • Event Positions
    • Object Events
    • Clone Object Events
    • Warp Events
    • Trigger Events
    • Weather Trigger Events
    • Sign Event
    • Hidden Item Event
    • Secret Base Event
    • Heal Locations
    • Custom Attributes
    • Open Map Scripts
    • Tool Buttons
    • Ruler Tool
  • Editing Map Headers
  • Editing Map Connections
    • Dive & Emerge Warps
    • Mirror Connections
  • Editing Wild Encounters
    • Adding New Encounter Groups
    • Configuring the Wild Encounter Fields
    • Summary Chart
    • Species Search
  • Creating New Maps
  • The Region Map Editor
    • Background Image Tab
    • Map Layout Tab
    • Map Entries Tab
  • The Tileset Editor
    • Metatile Properties
      • Layer Type
      • Metatile Behavior
      • Encounter Type
      • Terrain Type
      • Metatile Label
    • Tools Menu
      • Import Tiles Image…
      • Import Metatiles from Advance Map 1.92…
      • Change Number of Metatiles
      • Other Tools
    • Palette Editor
  • Scripting Capabilities
    • Custom Scripts Editor
    • Writing a Custom Script
    • Registering Script Actions
    • Scripting API
      • Callbacks
        • onProjectOpened
        • onProjectClosed
        • onMapOpened
        • onLayoutOpened
        • onBlockChanged
        • onBorderMetatileChanged
        • onBlockHoverChanged
        • onBlockHoverCleared
        • onMapResized
        • onBorderResized
        • onMapShifted
        • onTilesetUpdated
        • onMainTabChanged
        • onMapViewTabChanged
        • onBorderVisibilityToggled
      • Functions
        • Map Editing Functions
        • Map Header Editing Functions
        • Tileset Functions
        • Overlay Functions
        • Settings Functions
        • Utility Functions
      • Constants
        • constants.max_primary_tiles
        • constants.max_secondary_tiles
        • constants.max_primary_metatiles
        • constants.max_secondary_metatiles
        • constants.num_primary_palettes
        • constants.num_secondary_palettes
        • constants.layers_per_metatile
        • constants.tiles_per_metatile
        • constants.metatile_behaviors
        • constants.base_game_version
        • constants.version.major
        • constants.version.minor
        • constants.version.patch
  • Project Files
    • Identifiers
    • Global Constants
  • Breaking Changes
    • Versioning
    • What’s a breaking change?
    • Updating your project
      • From 5.x.x to 6.x.x
        • 1. MAP_NUM/MAP_GROUP
        • 2. Heal Locations
        • 3. Region Map Sections
        • 4. Local IDs
      • From 4.x.x to 5.x.x
        • 1. MAP_NONE renamed
        • 2. dest_warp_id
        • 3. Clone Object events
        • 4. Region Map Editor
        • 5. Additional API changes
      • Prior to 4.x.x
  • Shortcuts
    • Main Window
    • Tileset Editor
    • Region Map Editor
    • Custom Scripts Editor
  • Porymap Settings
    • Global settings
    • Project settings
      • General
      • Maps
      • Tilesets
      • Events
      • Files & Identifiers

Reference

  • Changelog
    • Unreleased
    • 6.0.0 - 2025-05-26
      • Breaking Changes
      • Added
      • Changed
      • Fixed
    • 5.4.1 - 2024-03-21
      • Fixed
    • 5.4.0 - 2024-02-13
      • Added
      • Changed
      • Fixed
    • 5.3.0 - 2024-01-15
      • Added
      • Changed
      • Fixed
    • 5.2.0 - 2024-01-02
      • Added
      • Changed
      • Fixed
    • 5.1.1 - 2023-02-20
      • Added
      • Changed
      • Fixed
    • 5.1.0 - 2023-01-22
      • Added
      • Changed
      • Fixed
    • 5.0.0 - 2022-10-30
      • Breaking Changes
      • Added
      • Changed
      • Fixed
    • 4.5.0 - 2021-12-26
      • Added
      • Changed
      • Fixed
    • 4.4.0 - 2020-12-20
      • Added
      • Changed
      • Fixed
    • 4.3.1 - 2020-07-17
      • Added
      • Changed
      • Fixed
    • 4.3.0 - 2020-06-27
      • Added
      • Changed
      • Fixed
    • 4.2.0 - 2020-06-06
      • Added
      • Changed
      • Fixed
    • 4.1.0 - 2020-05-18
      • Added
      • Changed
      • Fixed
    • 4.0.0 - 2020-04-28
      • Breaking Changes
      • Added
      • Changed
      • Fixed
    • 3.0.1 - 2020-03-04
      • Fixed
    • 3.0.0 - 2020-03-04
      • Breaking Changes
      • Added
      • Changed
      • Fixed
    • 2.0.0 - 2019-10-16
      • Breaking Changes
      • Added
      • Changed
      • Fixed
    • 1.2.2 - 2019-05-16
      • Added
      • Changed
      • Fixed
    • 1.2.1 - 2019-02-16
      • Added
      • Fixed
    • 1.2.0 - 2019-02-04
      • Breaking Changes
      • Added
      • Changed
      • Fixed
    • 1.1.0 - 2018-12-27
      • Breaking Changes
      • Added
      • Changed
      • Fixed
    • 1.0.0 - 2018-10-26
  • Related Projects
porymap
  • Search

© Copyright 2023, huderlem.

Built with Sphinx using a theme provided by Read the Docs.