Update documentation
This commit is contained in:
Marcus Huderle
parent
456c497d01
commit
4ab8d17c32
40 changed files with 12304 additions and 1055 deletions
|
|
@ -1,4 +1,4 @@
|
|||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: d1e5f860d6b0c1de0d36ead565d7aab0
|
||||
config: 0c9901306ee335472548e17d7ddc5dfb
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
|
|
|||
234
docs/README.html
Normal file
234
docs/README.html
Normal file
|
|
@ -0,0 +1,234 @@
|
|||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
|
||||
<title>Setup — porymap documentation</title>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
|
||||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" style="background: linear-gradient(180deg, #08ACD5 50%, #FF6262 0%);" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> porymap
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="caption"><span class="caption-text">User Manual</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/introduction.html">Introduction</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/introduction.html#about-porymap">About Porymap</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/introduction.html#getting-started">Getting Started</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/navigation.html">Navigation</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#map-list">Map List</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#main-window">Main Window</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#tileset-editor">Tileset Editor</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/navigation.html#region-map-editor">Region Map Editor</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-tiles.html">Editing Map Tiles</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#visual-options">Visual Options</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#selecting-metatiles">Selecting Metatiles</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#pencil-tool">Pencil Tool</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#pointer-tool">Pointer Tool</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#bucket-fill-tool">Bucket Fill Tool</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#map-shift-tool">Map Shift Tool</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#smart-paths">Smart Paths</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#change-map-border">Change Map Border</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#change-map-tilesets">Change Map Tilesets</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-tiles.html#undo-redo">Undo & Redo</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a></li>
|
||||
</ul>
|
||||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/related-projects.html">Related Projects</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||||
<a href="index.html">porymap</a>
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="wy-nav-content">
|
||||
|
||||
<div class="rst-content">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||||
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html">Docs</a> »</li>
|
||||
|
||||
<li>Setup</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/README.md.txt" rel="nofollow"> View page source</a>
|
||||
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<hr/>
|
||||
</div>
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<p>This directory holds the sources that build the porymap documentation website. It uses Sphinx to build a static website, and copy the results to the <code class="docutils literal notranslate"><span class="pre">docs/</span></code> directory for GitHub Pages.</p>
|
||||
<div class="section" id="setup">
|
||||
<h1>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Sphinx uses Python, so you can use <code class="docutils literal notranslate"><span class="pre">pip</span></code> to install the dependencies:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="o">-</span><span class="n">r</span> <span class="n">requirements</span><span class="o">.</span><span class="n">txt</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="build">
|
||||
<h1>Build<a class="headerlink" href="#build" title="Permalink to this headline">¶</a></h1>
|
||||
<p>This will build the static site and copy the files to the root-level <code class="docutils literal notranslate"><span class="pre">docs/</span></code> directory. The GitHub Pages site will automatically update when the commit is merged to porymap’s <code class="docutils literal notranslate"><span class="pre">master</span></code> branch.</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make</span> <span class="n">github</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2019, huderlem
|
||||
|
||||
</p>
|
||||
</div>
|
||||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
</footer>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 2.2 KiB After Width: | Height: | Size: 2.6 KiB |
13
docs/_sources/README.md.txt
Normal file
13
docs/_sources/README.md.txt
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
This directory holds the sources that build the porymap documentation website. It uses Sphinx to build a static website, and copy the results to the `docs/` directory for GitHub Pages.
|
||||
|
||||
## Setup
|
||||
Sphinx uses Python, so you can use `pip` to install the dependencies:
|
||||
```
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Build
|
||||
This will build the static site and copy the files to the root-level `docs/` directory. The GitHub Pages site will automatically update when the commit is merged to porymap's `master` branch.
|
||||
```
|
||||
make github
|
||||
```
|
||||
|
|
@ -33,4 +33,4 @@ An extremely useful feature is the *Mirror to Connecting Maps* checkbox in the t
|
|||
Follow Connections
|
||||
------------------
|
||||
|
||||
Double-clicking on a connection will open the destination map. This is very useful for navigating through your maps, similar to double-clicking on :ref:`Event Warps <event-warps>`.
|
||||
Double-clicking on a connection will open the destination map. This is very useful for navigating through your maps, similar to double-clicking on :ref:`Warp Events <event-warps>`.
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ All of the events are visible on the map. The Event Details window on the right
|
|||
.. warning::
|
||||
There is currently no undo/redo functionality when editing events! Use Git version control!
|
||||
|
||||
Events Positions
|
||||
Event Positions
|
||||
----------------
|
||||
|
||||
All events have X/Y coordinates. To move an Event, click and drag it to a new position on the map. Alternatively, you can use the X and Y spinners in the event properties.
|
||||
|
|
@ -33,18 +33,18 @@ Events also have an elevation, also known as Z coordinates (see image above). E
|
|||
|
||||
Next, we'll cover each type of event in detail.
|
||||
|
||||
Event Objects
|
||||
Object Events
|
||||
-------------
|
||||
|
||||
Event objects are typically used for NPCs (non-player-characters). More technically, it's any event that has a sprite and the ability to move around. Event objects are displayed using their assigned sprite, except for special cases. Any event object that uses a dynamic sprite will be displayed as a blue square with an `N` |dynamic-sprite|. Some examples of dynamic sprites are the player's rival and berry trees.
|
||||
Object events are typically used for NPCs (non-player-characters). More technically, it's any event that has a sprite and the ability to move around. Object events are displayed using their assigned sprite, except for special cases. Any object event that uses a dynamic sprite will be displayed as a blue square with an `N` |dynamic-sprite|. Some examples of dynamic sprites are the player's rival and berry trees.
|
||||
|
||||
.. |dynamic-sprite|
|
||||
image:: images/editing-map-events/dynamic-sprite.png
|
||||
|
||||
.. figure:: images/editing-map-events/event-object.png
|
||||
:alt: Event Object Properties
|
||||
:alt: Object Event Properties
|
||||
|
||||
Event Object Properties
|
||||
Object Event Properties
|
||||
|
||||
Id
|
||||
This is the local id of the object in the map. Some script values use this local id to specify object when using scripting commands such as `applymovement`.
|
||||
|
|
@ -72,15 +72,15 @@ Sight Radius or Berry Tree ID
|
|||
|
||||
.. _event-warps:
|
||||
|
||||
Event Warps
|
||||
Warp Events
|
||||
-----------
|
||||
|
||||
Event warps are how the player is able to warp to other maps, such as entering a building. Double-clicking on a warp will automatically open the destination map and select the destination warp. This makes it very easy to navigate around in Porymap.
|
||||
Warp events are how the player is able to warp to other maps, such as entering a building. Double-clicking on a warp will automatically open the destination map and select the destination warp. This makes it very easy to navigate around in Porymap.
|
||||
|
||||
.. figure:: images/editing-map-events/event-warp.png
|
||||
:alt: Event Warp Properties
|
||||
:alt: Warp Event Properties
|
||||
|
||||
Event Warp Properties
|
||||
Warp Event Properties
|
||||
|
||||
Id
|
||||
This is the local id of the warp in the map. This is used when setting the Destination Warp property for another warp.
|
||||
|
|
@ -91,15 +91,15 @@ Destination Map
|
|||
Destination Warp
|
||||
The Id of the warp in the destination map.
|
||||
|
||||
Event Triggers
|
||||
Trigger Events
|
||||
--------------
|
||||
|
||||
Event triggers are scripts that execute when the player walks over them. However, they only execute when a variable is equal some value. Typically, they execute once, set the variable's value to something else, and then never execute again because the variable's value no longer matches.
|
||||
Trigger events are scripts that execute when the player walks over them. However, they only execute when a variable is equal some value. Typically, they execute once, set the variable's value to something else, and then never execute again because the variable's value no longer matches.
|
||||
|
||||
.. figure:: images/editing-map-events/event-trigger.png
|
||||
:alt: Event Trigger Properties
|
||||
:alt: Trigger Event Properties
|
||||
|
||||
Event Trigger Properties
|
||||
Trigger Event Properties
|
||||
|
||||
Id
|
||||
The local id of the trigger in the map. This value is not used for anything.
|
||||
|
|
@ -113,15 +113,15 @@ Var
|
|||
Var Value
|
||||
The value that the Var must equal for the trigger's Script to execute.
|
||||
|
||||
Event Weather Triggers
|
||||
Weather Trigger Events
|
||||
----------------------
|
||||
|
||||
Event weather triggers are a very specific type of trigger. When the player walks over a weather trigger, the overworld's weather will transition to the specified weather type.
|
||||
Weather trigger events are a very specific type of trigger. When the player walks over a weather trigger, the overworld's weather will transition to the specified weather type.
|
||||
|
||||
.. figure:: images/editing-map-events/event-weather-trigger.png
|
||||
:alt: Event Weather Trigger Properties
|
||||
:alt: Weather Trigger Event Properties
|
||||
|
||||
Event Weather Trigger Properties
|
||||
Weather Trigger Event Properties
|
||||
|
||||
Id
|
||||
The local id of the trigger in the map. This value is not used for anything.
|
||||
|
|
@ -129,15 +129,15 @@ Id
|
|||
Weather
|
||||
The type of weather to transition to.
|
||||
|
||||
Event Signs
|
||||
Sign Event
|
||||
-----------
|
||||
|
||||
Event signs, or signposts, are simple interactable scripts. They are typically used for things like signs in front of buildings. The player's facing direction can be required to be a certain direction in order to interact with the sign. Signs are the first of three "BG" event types.
|
||||
Sign events, or signposts, are simple interactable scripts. They are typically used for things like signs in front of buildings. The player's facing direction can be required to be a certain direction in order to interact with the sign. Signs are the first of three "BG" event types.
|
||||
|
||||
.. figure:: images/editing-map-events/event-sign.png
|
||||
:alt: Event Sign Properties
|
||||
:alt: Sign Event Properties
|
||||
|
||||
Event Sign Properties
|
||||
Sign Event Properties
|
||||
|
||||
Id
|
||||
The local id of the BG event in the map. This value is not used for anything.
|
||||
|
|
@ -148,15 +148,15 @@ Player Facing Direction
|
|||
Script
|
||||
The script that executes when the player interacts with the sign.
|
||||
|
||||
Event Hidden Item
|
||||
Hidden Item Event
|
||||
-----------------
|
||||
|
||||
Hidden items are invisible items that can be picked up by the player. They each use a flag to ensure the item can only be picked up once.
|
||||
|
||||
.. figure:: images/editing-map-events/event-hidden-item.png
|
||||
:alt: Event Hidden Item Properties
|
||||
:alt: Hidden Item Event Properties
|
||||
|
||||
Event Hidden Item Properties
|
||||
Hidden Item Event Properties
|
||||
|
||||
Id
|
||||
The local id of the BG event in the map. This value is not used for anything.
|
||||
|
|
@ -167,15 +167,15 @@ Item
|
|||
Flag
|
||||
This flag is set when the player receives the hidden item.
|
||||
|
||||
Event Secret Base
|
||||
Secret Base Event
|
||||
-----------------
|
||||
|
||||
This is the event used to mark entrances to secret bases. This event will only be functional on certain metatiles. Unfortunately, they are hardcoded into the game's engine (see ``sSecretBaseEntranceMetatiles`` in ``src/secret_base.c``).
|
||||
|
||||
.. figure:: images/editing-map-events/event-secret-base.png
|
||||
:alt: Event Secret Base Properties
|
||||
:alt: Secret Base Event Properties
|
||||
|
||||
Event Secret Base Properties
|
||||
Secret Base Event Properties
|
||||
|
||||
Id
|
||||
The local id of the BG event in the map. This value is not used for anything.
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ About Porymap
|
|||
|
||||
**Porymap is a cross-platform map editor for the Gen 3 pret decompilation projects. Its primary functions are to allow editing map tiles, collision, events, connections, and properties. Porymap provides additional functionality, such as tileset editing and region map editing. Downloadable releases are available for Windows and Mac, and Linux users can build it from source.**
|
||||
|
||||
Those familiar with traditional Gen 3 binary ROM hacking can think of it as the Advance Map equivalent for the decompilation projects. Porymap supports the same features as Advance Map, except for Wild Pokemon editing, so Advance Map users shouldn't have much difficulty learning how to use Porymap. There are many usability improvements in Porymap. The most notable is undo/redo when painting map tiles.
|
||||
Those familiar with traditional Gen 3 binary ROM hacking can think of it as the Advance Map equivalent for the decompilation projects. Porymap supports the same features as Advance Map, so Advance Map users shouldn't have much difficulty learning how to use Porymap. There are many usability improvements in Porymap. The most notable is undo/redo when painting map tiles.
|
||||
|
||||
Porymap reads and writes files in the decompilation projects. It **does not** read or write ROM files. **Therefore, it is highly recommended to use Git for version control when working with Porymap.**
|
||||
|
||||
|
|
|
|||
|
|
@ -65,6 +65,9 @@ Header Tab
|
|||
Connections Tab
|
||||
Change how the map connects with surrounding maps when the player walks from one to another.
|
||||
|
||||
Wild Pokémon Tab
|
||||
Edit the wild Pokémon available in the map.
|
||||
|
||||
Tileset Editor
|
||||
--------------
|
||||
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@ Project Files
|
|||
*************
|
||||
|
||||
Porymap relies on the user maintaining a certain level of integrity with their project files.
|
||||
This is a list of files that porymap reads from and writes to. Generally, if porymap writes to a file, it
|
||||
probably is not a good idea to edit yourself unless otherwise noted.
|
||||
This is a list of files that porymap reads from and writes to. Generally, if porymap writes
|
||||
to a file, it probably is not a good idea to edit yourself unless otherwise noted.
|
||||
|
||||
|
||||
.. csv-table::
|
||||
|
|
|
|||
|
|
@ -6,16 +6,48 @@ and this project somewhat adheres to [Semantic Versioning](https://semver.org/sp
|
|||
|
||||
The **"Breaking Changes"** listed below are changes that have been made in the decompilation projects (e.g. pokeemerald), which porymap requires in order to work properly. If porymap is used on a project that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly.
|
||||
|
||||
## [Unreleased]
|
||||
## Unreleased
|
||||
Nothing, yet.
|
||||
|
||||
## [3.0.1] - 2020-03-04
|
||||
### Fixed
|
||||
- Fix bug on Mac where tileset images were corrupted when saving.
|
||||
|
||||
## [3.0.0] - 2020-03-04
|
||||
### Breaking Changes
|
||||
- Accomodate event object graphics pointer table being explicitly indexed. From changes introduced in commits [cdae0c1444bed98e652c87dc3e3edcecacfef8be](https://github.com/pret/pokeemerald/commit/cdae0c1444bed98e652c87dc3e3edcecacfef8be) and [0e8ccfc4fd3544001f4c25fafd401f7558bdefba](https://github.com/pret/pokeruby/commit/0e8ccfc4fd3544001f4c25fafd401f7558bdefba).
|
||||
- pokeemerald and pokeruby both underwent a naming consistency update with respect to "object events". As such, these naming changes break old versions of Porymap.
|
||||
- pokeemerald object event PR: https://github.com/pret/pokeemerald/pull/910
|
||||
- pokeruby object event PR: https://github.com/pret/pokeruby/pull/768
|
||||
|
||||
### Added
|
||||
- Add warning when closing porymap with unsaved changes.
|
||||
- Support metatile labels file introduced in pokeruby and pokeemerald commits [ad365a35c1536740cbcbc10bee66e5dd908c39e7](https://github.com/pret/pokeruby/commit/ad365a35c1536740cbcbc10bee66e5dd908c39e7) and [c68ba9f4e8e260f2e3389eccd15f6ee5f4bdcd3e](https://github.com/pret/pokeemerald/commit/c68ba9f4e8e260f2e3389eccd15f6ee5f4bdcd3e).
|
||||
- Add optional support for Poryscript script files via the `use_poryscript` config option.
|
||||
- Selecting a group of metatiles from the map area now also copies the collision properties, too.
|
||||
- Add keyboard shortcut `Ctrl + G` for toggling the map grid.
|
||||
|
||||
### Changed
|
||||
- Draw map connections with the current map's tilesets to more accurately mimic their appearance in-game.
|
||||
|
||||
### Fixed
|
||||
- Fix index-out-of-bounds crash when deleting the last event in an event type group.
|
||||
- Fix bug where exporting tileset images could add an extra row of junk at the end.
|
||||
- Fix crashes when encountering an error opening a project or map.
|
||||
- Fix bug where comboboxes and wild pokemon data could grow large when opening projects multiple times during the same porymap session.
|
||||
- Fix bug where dragging the metatile selector would visually extend beyond map boundary.
|
||||
|
||||
|
||||
## [2.0.0] - 2019-10-16
|
||||
### Breaking Changes
|
||||
- Accomodate event object graphics pointer table being explicitly indexed. From changes introduced in commits [cdae0c1444bed98e652c87dc3e3edcecacfef8be](https://github.com/pret/pokeemerald/commit/cdae0c1444bed98e652c87dc3e3edcecacfef8be) and [0e8ccfc4fd3544001f4c25fafd401f7558bdefba](https://github.com/pret/pokeruby/commit/0e8ccfc4fd3544001f4c25fafd401f7558bdefba).
|
||||
- New "field" key in wild encounter JSON data from pokeemerald and pokeruby commits [adb0a444577b59eb02788c782a3d04bc285be0ba](https://github.com/pret/pokeemerald/commit/adb0a444577b59eb02788c782a3d04bc285be0ba) and [https://github.com/pret/pokeruby/commit/c73de8bed752ca538d90cfc93c4a9e8c7965f8c9](c73de8bed752ca538d90cfc93c4a9e8c7965f8c9).
|
||||
|
||||
|
||||
### Added
|
||||
- Add wild encounter table editor.
|
||||
- Add dark themes.
|
||||
- Support metatile labels file introduced in pokeruby and pokeemerald commits [ad365a35c1536740cbcbc10bee66e5dd908c39e7](https://github.com/pret/pokeruby/commit/ad365a35c1536740cbcbc10bee66e5dd908c39e7) and [c68ba9f4e8e260f2e3389eccd15f6ee5f4bdcd3e](https://github.com/pret/pokeemerald/commit/c68ba9f4e8e260f2e3389eccd15f6ee5f4bdcd3e).
|
||||
- Add warning when closing porymap with unsaved changes.
|
||||
|
||||
### Changed
|
||||
- Exporting map images is now more configurable. Events, connections, collision, etc. can be toggled on and off before exporting the image.
|
||||
- The entire Tileset Editor selection is now conveniently flipped when selecting x-flip or y-flip.
|
||||
- Autocomplete for porymap's comboboxes no longer require typing the full string prefix.
|
||||
|
|
@ -118,7 +150,10 @@ The **"Breaking Changes"** listed below are changes that have been made in the d
|
|||
## [1.0.0] - 2018-10-26
|
||||
This was the initial release.
|
||||
|
||||
[Unreleased]: https://github.com/huderlem/porymap/compare/1.2.2...HEAD
|
||||
[Unreleased]: https://github.com/huderlem/porymap/compare/3.0.1...HEAD
|
||||
[3.0.1]: https://github.com/huderlem/porymap/compare/3.0.0...3.0.1
|
||||
[3.0.0]: https://github.com/huderlem/porymap/compare/2.0.0...3.0.0
|
||||
[2.0.0]: https://github.com/huderlem/porymap/compare/1.2.2...2.0.0
|
||||
[1.2.2]: https://github.com/huderlem/porymap/compare/1.2.1...1.2.2
|
||||
[1.2.1]: https://github.com/huderlem/porymap/compare/1.2.0...1.2.1
|
||||
[1.2.0]: https://github.com/huderlem/porymap/compare/1.1.0...1.2.0
|
||||
|
|
|
|||
3
docs/_sources/reference/changelog.rst.txt
Normal file
3
docs/_sources/reference/changelog.rst.txt
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
***********
|
||||
Changelog
|
||||
***********
|
||||
96
docs/_static/basic.css
vendored
96
docs/_static/basic.css
vendored
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -231,6 +231,16 @@ a.headerlink {
|
|||
visibility: hidden;
|
||||
}
|
||||
|
||||
a.brackets:before,
|
||||
span.brackets > a:before{
|
||||
content: "[";
|
||||
}
|
||||
|
||||
a.brackets:after,
|
||||
span.brackets > a:after {
|
||||
content: "]";
|
||||
}
|
||||
|
||||
h1:hover > a.headerlink,
|
||||
h2:hover > a.headerlink,
|
||||
h3:hover > a.headerlink,
|
||||
|
|
@ -279,6 +289,12 @@ img.align-center, .figure.align-center, object.align-center {
|
|||
margin-right: auto;
|
||||
}
|
||||
|
||||
img.align-default, .figure.align-default {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left;
|
||||
}
|
||||
|
|
@ -287,6 +303,10 @@ img.align-center, .figure.align-center, object.align-center {
|
|||
text-align: center;
|
||||
}
|
||||
|
||||
.align-default {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-right {
|
||||
text-align: right;
|
||||
}
|
||||
|
|
@ -358,6 +378,11 @@ table.align-center {
|
|||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-default {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
|
@ -391,6 +416,16 @@ table.citation td {
|
|||
border-bottom: none;
|
||||
}
|
||||
|
||||
th > p:first-child,
|
||||
td > p:first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
th > p:last-child,
|
||||
td > p:last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure {
|
||||
|
|
@ -460,11 +495,58 @@ ol.upperroman {
|
|||
list-style: upper-roman;
|
||||
}
|
||||
|
||||
li > p:first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
li > p:last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
dl.footnote > dt,
|
||||
dl.citation > dt {
|
||||
float: left;
|
||||
}
|
||||
|
||||
dl.footnote > dd,
|
||||
dl.citation > dd {
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
dl.footnote > dd:after,
|
||||
dl.citation > dd:after {
|
||||
content: "";
|
||||
clear: both;
|
||||
}
|
||||
|
||||
dl.field-list {
|
||||
display: grid;
|
||||
grid-template-columns: fit-content(30%) auto;
|
||||
}
|
||||
|
||||
dl.field-list > dt {
|
||||
font-weight: bold;
|
||||
word-break: break-word;
|
||||
padding-left: 0.5em;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
dl.field-list > dt:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
dl.field-list > dd {
|
||||
padding-left: 0.5em;
|
||||
margin-top: 0em;
|
||||
margin-left: 0em;
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
dd p {
|
||||
dd > p:first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
|
|
@ -537,6 +619,12 @@ dl.glossary dt {
|
|||
font-style: oblique;
|
||||
}
|
||||
|
||||
.classifier:before {
|
||||
font-style: normal;
|
||||
margin: 0.5em;
|
||||
content: ":";
|
||||
}
|
||||
|
||||
abbr, acronym {
|
||||
border-bottom: dotted 1px;
|
||||
cursor: help;
|
||||
|
|
@ -584,6 +672,10 @@ div.code-block-caption + div > div.highlight > pre {
|
|||
margin-top: 0;
|
||||
}
|
||||
|
||||
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
|
||||
user-select: none;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-number {
|
||||
padding: 0.1em 0.3em;
|
||||
font-style: italic;
|
||||
|
|
|
|||
12
docs/_static/doctools.js
vendored
12
docs/_static/doctools.js
vendored
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx JavaScript utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -87,14 +87,13 @@ jQuery.fn.highlightText = function(text, className) {
|
|||
node.nextSibling));
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
if (isInSVG) {
|
||||
var bbox = span.getBBox();
|
||||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
var bbox = node.parentElement.getBBox();
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
rect.y.baseVal.value = bbox.y;
|
||||
rect.width.baseVal.value = bbox.width;
|
||||
rect.height.baseVal.value = bbox.height;
|
||||
rect.setAttribute('class', className);
|
||||
var parentOfText = node.parentNode.parentNode;
|
||||
addItems.push({
|
||||
"parent": node.parentNode,
|
||||
"target": rect});
|
||||
|
|
@ -284,10 +283,11 @@ var Documentation = {
|
|||
},
|
||||
|
||||
initOnKeyListeners: function() {
|
||||
$(document).keyup(function(event) {
|
||||
$(document).keydown(function(event) {
|
||||
var activeElementType = document.activeElement.tagName;
|
||||
// don't navigate when in search box or textarea
|
||||
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
|
||||
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
|
||||
&& !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
|
||||
switch (event.keyCode) {
|
||||
case 37: // left
|
||||
var prevHref = $('link[rel="prev"]').prop('href');
|
||||
|
|
|
|||
3
docs/_static/documentation_options.js
vendored
3
docs/_static/documentation_options.js
vendored
|
|
@ -3,8 +3,9 @@ var DOCUMENTATION_OPTIONS = {
|
|||
VERSION: '',
|
||||
LANGUAGE: 'None',
|
||||
COLLAPSE_INDEX: false,
|
||||
BUILDER: 'html',
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt',
|
||||
NAVIGATION_WITH_KEYS: false,
|
||||
NAVIGATION_WITH_KEYS: false
|
||||
};
|
||||
10598
docs/_static/jquery-3.4.1.js
vendored
Normal file
10598
docs/_static/jquery-3.4.1.js
vendored
Normal file
File diff suppressed because it is too large
Load diff
6
docs/_static/jquery.js
vendored
6
docs/_static/jquery.js
vendored
File diff suppressed because one or more lines are too long
2
docs/_static/language_data.js
vendored
2
docs/_static/language_data.js
vendored
|
|
@ -5,7 +5,7 @@
|
|||
* This script contains the language-specific data used by searchtools.js,
|
||||
* namely the list of stopwords, stemmer, scorer and splitter.
|
||||
*
|
||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
|
|||
77
docs/_static/searchtools.js
vendored
77
docs/_static/searchtools.js
vendored
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx JavaScript utilities for the full-text search.
|
||||
*
|
||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -36,8 +36,10 @@ if (!Scorer) {
|
|||
|
||||
// query found in title
|
||||
title: 15,
|
||||
partialTitle: 7,
|
||||
// query found in terms
|
||||
term: 5
|
||||
term: 5,
|
||||
partialTerm: 2
|
||||
};
|
||||
}
|
||||
|
||||
|
|
@ -56,6 +58,19 @@ var Search = {
|
|||
_queued_query : null,
|
||||
_pulse_status : -1,
|
||||
|
||||
htmlToText : function(htmlString) {
|
||||
var htmlElement = document.createElement('span');
|
||||
htmlElement.innerHTML = htmlString;
|
||||
$(htmlElement).find('.headerlink').remove();
|
||||
docContent = $(htmlElement).find('[role=main]')[0];
|
||||
if(docContent === undefined) {
|
||||
console.warn("Content block not found. Sphinx search tries to obtain it " +
|
||||
"via '[role=main]'. Could you check your theme or template.");
|
||||
return "";
|
||||
}
|
||||
return docContent.textContent || docContent.innerText;
|
||||
},
|
||||
|
||||
init : function() {
|
||||
var params = $.getQueryParameters();
|
||||
if (params.q) {
|
||||
|
|
@ -120,7 +135,7 @@ var Search = {
|
|||
this.out = $('#search-results');
|
||||
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
|
||||
this.dots = $('<span></span>').appendTo(this.title);
|
||||
this.status = $('<p style="display: none"></p>').appendTo(this.out);
|
||||
this.status = $('<p class="search-summary"> </p>').appendTo(this.out);
|
||||
this.output = $('<ul class="search"/>').appendTo(this.out);
|
||||
|
||||
$('#search-progress').text(_('Preparing search...'));
|
||||
|
|
@ -235,7 +250,8 @@ var Search = {
|
|||
if (results.length) {
|
||||
var item = results.pop();
|
||||
var listItem = $('<li style="display:none"></li>');
|
||||
if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
|
||||
var requestUrl = "";
|
||||
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
|
||||
// dirhtml builder
|
||||
var dirname = item[0] + '/';
|
||||
if (dirname.match(/\/index\/$/)) {
|
||||
|
|
@ -243,15 +259,15 @@ var Search = {
|
|||
} else if (dirname == 'index/') {
|
||||
dirname = '';
|
||||
}
|
||||
listItem.append($('<a/>').attr('href',
|
||||
DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
|
||||
|
||||
} else {
|
||||
// normal html builders
|
||||
listItem.append($('<a/>').attr('href',
|
||||
item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
|
||||
}
|
||||
listItem.append($('<a/>').attr('href',
|
||||
requestUrl +
|
||||
highlightstring + item[2]).html(item[1]));
|
||||
if (item[3]) {
|
||||
listItem.append($('<span> (' + item[3] + ')</span>'));
|
||||
Search.output.append(listItem);
|
||||
|
|
@ -259,11 +275,7 @@ var Search = {
|
|||
displayNextItem();
|
||||
});
|
||||
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
|
||||
var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
|
||||
if (suffix === undefined) {
|
||||
suffix = '.txt';
|
||||
}
|
||||
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
|
||||
$.ajax({url: requestUrl,
|
||||
dataType: "text",
|
||||
complete: function(jqxhr, textstatus) {
|
||||
var data = jqxhr.responseText;
|
||||
|
|
@ -313,12 +325,13 @@ var Search = {
|
|||
for (var prefix in objects) {
|
||||
for (var name in objects[prefix]) {
|
||||
var fullname = (prefix ? prefix + '.' : '') + name;
|
||||
if (fullname.toLowerCase().indexOf(object) > -1) {
|
||||
var fullnameLower = fullname.toLowerCase()
|
||||
if (fullnameLower.indexOf(object) > -1) {
|
||||
var score = 0;
|
||||
var parts = fullname.split('.');
|
||||
var parts = fullnameLower.split('.');
|
||||
// check for different match types: exact matches of full name or
|
||||
// "last name" (i.e. last dotted part)
|
||||
if (fullname == object || parts[parts.length - 1] == object) {
|
||||
if (fullnameLower == object || parts[parts.length - 1] == object) {
|
||||
score += Scorer.objNameMatch;
|
||||
// matches in last name
|
||||
} else if (parts[parts.length - 1].indexOf(object) > -1) {
|
||||
|
|
@ -385,6 +398,19 @@ var Search = {
|
|||
{files: terms[word], score: Scorer.term},
|
||||
{files: titleterms[word], score: Scorer.title}
|
||||
];
|
||||
// add support for partial matches
|
||||
if (word.length > 2) {
|
||||
for (var w in terms) {
|
||||
if (w.match(word) && !terms[word]) {
|
||||
_o.push({files: terms[w], score: Scorer.partialTerm})
|
||||
}
|
||||
}
|
||||
for (var w in titleterms) {
|
||||
if (w.match(word) && !titleterms[word]) {
|
||||
_o.push({files: titleterms[w], score: Scorer.partialTitle})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// no match but word was a required one
|
||||
if ($u.every(_o, function(o){return o.files === undefined;})) {
|
||||
|
|
@ -404,7 +430,7 @@ var Search = {
|
|||
for (j = 0; j < _files.length; j++) {
|
||||
file = _files[j];
|
||||
if (!(file in scoreMap))
|
||||
scoreMap[file] = {}
|
||||
scoreMap[file] = {};
|
||||
scoreMap[file][word] = o.score;
|
||||
}
|
||||
});
|
||||
|
|
@ -412,7 +438,7 @@ var Search = {
|
|||
// create the mapping
|
||||
for (j = 0; j < files.length; j++) {
|
||||
file = files[j];
|
||||
if (file in fileMap)
|
||||
if (file in fileMap && fileMap[file].indexOf(word) === -1)
|
||||
fileMap[file].push(word);
|
||||
else
|
||||
fileMap[file] = [word];
|
||||
|
|
@ -424,8 +450,12 @@ var Search = {
|
|||
var valid = true;
|
||||
|
||||
// check if all requirements are matched
|
||||
if (fileMap[file].length != searchterms.length)
|
||||
continue;
|
||||
var filteredTermCount = // as search terms with length < 3 are discarded: ignore
|
||||
searchterms.filter(function(term){return term.length > 2}).length
|
||||
if (
|
||||
fileMap[file].length != searchterms.length &&
|
||||
fileMap[file].length != filteredTermCount
|
||||
) continue;
|
||||
|
||||
// ensure that none of the excluded terms is in the search result
|
||||
for (i = 0; i < excluded.length; i++) {
|
||||
|
|
@ -456,7 +486,8 @@ var Search = {
|
|||
* words. the first one is used to find the occurrence, the
|
||||
* latter for highlighting it.
|
||||
*/
|
||||
makeSearchSummary : function(text, keywords, hlwords) {
|
||||
makeSearchSummary : function(htmlText, keywords, hlwords) {
|
||||
var text = Search.htmlToText(htmlText);
|
||||
var textLower = text.toLowerCase();
|
||||
var start = 0;
|
||||
$.each(keywords, function() {
|
||||
|
|
|
|||
|
|
@ -22,10 +22,10 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
|
@ -114,14 +114,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -150,39 +150,51 @@
|
|||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id4">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id8">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id9">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id25">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
|
|||
105
docs/index.html
105
docs/index.html
|
|
@ -21,10 +21,10 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
|
@ -114,14 +114,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -150,39 +150,51 @@
|
|||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id4">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id8">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id9">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id25">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -255,8 +267,8 @@
|
|||
<div class="section" id="porymap-documentation">
|
||||
<h1>Porymap Documentation<a class="headerlink" href="#porymap-documentation" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">If you can’t find what you’re looking for, or you feel something is missing, please reach out on GitHub: <a class="reference external" href="https://github.com/huderlem/porymap">https://github.com/huderlem/porymap</a></p>
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>If you can’t find what you’re looking for, or you feel something is missing, please reach out on GitHub: <a class="reference external" href="https://github.com/huderlem/porymap">https://github.com/huderlem/porymap</a></p>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption"><span class="caption-text">User Manual</span></p>
|
||||
|
|
@ -293,14 +305,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -332,11 +344,14 @@
|
|||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">1.2.2 - 2019-05-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id5">1.2.1 - 2019-02-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id8">1.2.0 - 2019-02-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">1.1.0 - 2018-12-27</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">3.0.1 - 2020-03-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id2">3.0.0 - 2020-03-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">2.0.0 - 2019-10-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id9">1.2.2 - 2019-05-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">1.2.1 - 2019-02-16</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">1.2.0 - 2019-02-04</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id21">1.1.0 - 2018-12-27</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
|
|||
|
|
@ -21,10 +21,10 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||||
|
||||
|
|
@ -115,14 +115,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -151,39 +151,51 @@
|
|||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -260,9 +272,9 @@
|
|||
<h2>Selecting Collision Types<a class="headerlink" href="#selecting-collision-types" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Collision Type Selector is a tab next to the Metatile Selector. It features 32 total different collision types. The left column is for collision types that allow the player to walk through the tiles. These are denoted by white text. The right column is for collision types that are impassable by the player. These are denoted by red text.</p>
|
||||
<p>The transparency slider above the collision types controls the transparency of the collision properties on the map view.</p>
|
||||
<div class="figure" id="id2">
|
||||
<div class="figure align-default" id="id2">
|
||||
<img alt="Map Collisions View" src="../_images/map-collisions.png" />
|
||||
<p class="caption"><span class="caption-text">Map Collisions View</span></p>
|
||||
<p class="caption"><span class="caption-text">Map Collisions View</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>Unlike metatiles, only one collision type can be selected at a time. A collision type can be selected either by clicking in the Collision Type Selector. You can also right-click on a metatile from the map area, just like you would when editing metatiles.</p>
|
||||
</div>
|
||||
|
|
@ -274,30 +286,30 @@
|
|||
<span id="id1"></span><h2>Collision Types<a class="headerlink" href="#collision-types" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Now we’ll go over the different types of collisions, along with some important concepts. Each row in the Collision Type Selector represents a different <em>elevation</em>, which is why most rows have hexadecimal numbers in them (2, 3, 4, …, D, E). Rows 0, 1, and F have special purposes.</p>
|
||||
<p>Elevation is how the game determines whether or not an object is on the same level as something else. For example, it’s commonly used to make sure the player can’t walk off the top side of a mountain. If the player’s current elevation is 4, but the player is trying to walk onto a metatile with elevation 3, then the game won’t let the player walk in that direction. In the example below from Route 114, the player would be unable to walk north from the mountain onto the grass. This is because 3 and 4 are different elevations.</p>
|
||||
<div class="figure" id="id3">
|
||||
<div class="figure align-default" id="id3">
|
||||
<img alt="Different Elevations on a Cliff" src="../_images/collision-cliff.png" />
|
||||
<p class="caption"><span class="caption-text">Different Elevations on a Cliff</span></p>
|
||||
<p class="caption"><span class="caption-text">Different Elevations on a Cliff</span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>Now that you undertand the basics of elevation, let’s explore the special collision types, which have no elevation associated with them.</p>
|
||||
<dl class="docutils">
|
||||
<dt>Transition Collision Type <img alt="transition-collision-type" src="../_images/transition-collision-type.png" /></dt>
|
||||
<dd>The Transition collision type allows the player to move between different elevations. The most common use case is for stairs. The player will always be allowed to walk onto this collision type. Then, the player will be able to walk onto any elevation.</dd>
|
||||
<dl class="simple">
|
||||
<dt>Transition Collision Type <img alt="transition-collision-type" src="../_images/transition-collision-type.png" /></dt><dd><p>The Transition collision type allows the player to move between different elevations. The most common use case is for stairs. The player will always be allowed to walk onto this collision type. Then, the player will be able to walk onto any elevation.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="docutils">
|
||||
<dt>Impassable Collision Type <img alt="impassable-collision-type" src="../_images/impassable-collision-type.png" /></dt>
|
||||
<dd>The Impassable collision type blocks the player from moving. What makes it special is that it doesn’t count as any particular elevation. This means that, for example, a signpost would be interactable from all elevations if it uses this collision type. This is the most common impassable collision type used in the game, and it should generally be used for impassable tiles.</dd>
|
||||
<dl class="simple">
|
||||
<dt>Impassable Collision Type <img alt="impassable-collision-type" src="../_images/impassable-collision-type.png" /></dt><dd><p>The Impassable collision type blocks the player from moving. What makes it special is that it doesn’t count as any particular elevation. This means that, for example, a signpost would be interactable from all elevations if it uses this collision type. This is the most common impassable collision type used in the game, and it should generally be used for impassable tiles.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="docutils">
|
||||
<dt>Surf Collision Type <img alt="surf-collision-type-1" src="../_images/surf-collision-type-1.png" /> <img alt="surf-collision-type-2" src="../_images/surf-collision-type-2.png" /></dt>
|
||||
<dd>The Surf collision type allow the player to surf. The red version is just the impassable version. <strong>The player will only be able to start surfing from elevation 3. The same is true when hopping off onto land.</strong></dd>
|
||||
<dl class="simple">
|
||||
<dt>Surf Collision Type <img alt="surf-collision-type-1" src="../_images/surf-collision-type-1.png" /> <img alt="surf-collision-type-2" src="../_images/surf-collision-type-2.png" /></dt><dd><p>The Surf collision type allow the player to surf. The red version is just the impassable version. <strong>The player will only be able to start surfing from elevation 3. The same is true when hopping off onto land.</strong></p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="docutils">
|
||||
<dt>Multi-Level Collision Type <img alt="multi-level-collision-type-1" src="../_images/multi-level-collision-type-1.png" /> <img alt="multi-level-collision-type-2" src="../_images/multi-level-collision-type-2.png" /></dt>
|
||||
<dd>The Multi-Level collision type is used for bridges. The red version is just the impassable version, and it doesn’t have any special use. Multi-level collision type remembers the player’s previous elevation and maintains that elevation as long as the player continues to walk on multi-level collision. The player will only be able to leave multi-level collision if he walks onto a new tile that has the same elevation as before the multi-level collision was entered. Here is an example of a bridge from Route 119 that illustrates the ability to surf north/south under the bridge, while also being able to walk east/west.</dd>
|
||||
<dl class="simple">
|
||||
<dt>Multi-Level Collision Type <img alt="multi-level-collision-type-1" src="../_images/multi-level-collision-type-1.png" /> <img alt="multi-level-collision-type-2" src="../_images/multi-level-collision-type-2.png" /></dt><dd><p>The Multi-Level collision type is used for bridges. The red version is just the impassable version, and it doesn’t have any special use. Multi-level collision type remembers the player’s previous elevation and maintains that elevation as long as the player continues to walk on multi-level collision. The player will only be able to leave multi-level collision if he walks onto a new tile that has the same elevation as before the multi-level collision was entered. Here is an example of a bridge from Route 119 that illustrates the ability to surf north/south under the bridge, while also being able to walk east/west.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<div class="figure" id="id4">
|
||||
<div class="figure align-default" id="id4">
|
||||
<img alt="Multi-Level Collision Type on a Bridge" src="../_images/multi-level-bridge.png" />
|
||||
<p class="caption"><span class="caption-text">Multi-Level Collision Type on a Bridge</span></p>
|
||||
<p class="caption"><span class="caption-text">Multi-Level Collision Type on a Bridge</span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -21,10 +21,10 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||||
|
||||
|
|
@ -115,14 +115,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -151,39 +151,51 @@
|
|||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -256,9 +268,9 @@
|
|||
<div class="section" id="editing-map-connections">
|
||||
<h1>Editing Map Connections<a class="headerlink" href="#editing-map-connections" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Maps can be connected together so that the player can seamlessly walk between them. These connections can be edited in the Connections tab.</p>
|
||||
<div class="figure" id="id1">
|
||||
<div class="figure align-default" id="id1">
|
||||
<img alt="Map Connections View" src="../_images/map-connections.png" />
|
||||
<p class="caption"><span class="caption-text">Map Connections View</span></p>
|
||||
<p class="caption"><span class="caption-text">Map Connections View</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>A connection has a direction, offset, and destination map. To add new connection, press the plus button <img alt="add-connection-button" src="../_images/add-connection-button.png" />. To delete a connection, select it and press the delete button <img alt="remove-connection-button" src="../_images/remove-connection-button.png" />.</p>
|
||||
<p>To change the connection’s vertical or horizontal offset, it’s easiest to click and drag the connection to the desired offset.</p>
|
||||
|
|
@ -272,7 +284,7 @@
|
|||
</div>
|
||||
<div class="section" id="follow-connections">
|
||||
<h2>Follow Connections<a class="headerlink" href="#follow-connections" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Double-clicking on a connection will open the destination map. This is very useful for navigating through your maps, similar to double-clicking on <a class="reference internal" href="editing-map-events.html#event-warps"><span class="std std-ref">Event Warps</span></a>.</p>
|
||||
<p>Double-clicking on a connection will open the destination map. This is very useful for navigating through your maps, similar to double-clicking on <a class="reference internal" href="editing-map-events.html#event-warps"><span class="std std-ref">Warp Events</span></a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -21,10 +21,10 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||||
|
||||
|
|
@ -115,14 +115,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -151,39 +151,51 @@
|
|||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -256,147 +268,147 @@
|
|||
<div class="section" id="editing-map-events">
|
||||
<h1>Editing Map Events<a class="headerlink" href="#editing-map-events" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Events are what bring your maps to life. They include NPCs, signposts, warps, scripts, and more. Open the <em>Events</em> tab above the map area, and let’s dissect what’s going on.</p>
|
||||
<div class="figure" id="id2">
|
||||
<div class="figure align-default" id="id1">
|
||||
<img alt="Map Events View" src="../_images/map-events.png" />
|
||||
<p class="caption"><span class="caption-text">Map Events View</span></p>
|
||||
<p class="caption"><span class="caption-text">Map Events View</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>All of the events are visible on the map. The Event Details window on the right displays the properties of the currently-selected event. If you look closely, you’ll see that the woman NPC near the Pokémon Center has a pink border around it because it’s selected. To select a different event, simple click on an event in the map area. Alternatively, you can use the spinner at the top of the event properties window. Multiple events can be selected at the same time by holding <code class="docutils literal notranslate"><span class="pre">Ctrl</span></code> and clicking another event.</p>
|
||||
<div class="figure" id="id3">
|
||||
<div class="figure align-default" id="id2">
|
||||
<img alt="Event Id Spinner" src="../_images/event-id-spinner.png" />
|
||||
<p class="caption"><span class="caption-text">Event Id Spinner</span></p>
|
||||
<p class="caption"><span class="caption-text">Event Id Spinner</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<div class="admonition warning">
|
||||
<p class="first admonition-title">Warning</p>
|
||||
<p class="last">There is currently no undo/redo functionality when editing events! Use Git version control!</p>
|
||||
<p class="admonition-title">Warning</p>
|
||||
<p>There is currently no undo/redo functionality when editing events! Use Git version control!</p>
|
||||
</div>
|
||||
<div class="section" id="events-positions">
|
||||
<h2>Events Positions<a class="headerlink" href="#events-positions" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="event-positions">
|
||||
<h2>Event Positions<a class="headerlink" href="#event-positions" title="Permalink to this headline">¶</a></h2>
|
||||
<p>All events have X/Y coordinates. To move an Event, click and drag it to a new position on the map. Alternatively, you can use the X and Y spinners in the event properties.</p>
|
||||
<div class="figure" id="id4">
|
||||
<div class="figure align-default" id="id3">
|
||||
<img alt="Event Coordinates Spinners" src="../_images/event-coords-spinners.png" />
|
||||
<p class="caption"><span class="caption-text">Event Coordinates Spinners</span></p>
|
||||
<p class="caption"><span class="caption-text">Event Coordinates Spinners</span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>Events also have an elevation, also known as Z coordinates (see image above). Elevations are explained in detail in the <a class="reference internal" href="editing-map-collisions.html#collision-types"><span class="std std-ref">Collision Types</span></a> section.</p>
|
||||
<p>Next, we’ll cover each type of event in detail.</p>
|
||||
</div>
|
||||
<div class="section" id="event-objects">
|
||||
<h2>Event Objects<a class="headerlink" href="#event-objects" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Event objects are typically used for NPCs (non-player-characters). More technically, it’s any event that has a sprite and the ability to move around. Event objects are displayed using their assigned sprite, except for special cases. Any event object that uses a dynamic sprite will be displayed as a blue square with an <cite>N</cite> <img alt="dynamic-sprite" src="../_images/dynamic-sprite.png" />. Some examples of dynamic sprites are the player’s rival and berry trees.</p>
|
||||
<div class="figure" id="id5">
|
||||
<img alt="Event Object Properties" src="../_images/event-object.png" />
|
||||
<p class="caption"><span class="caption-text">Event Object Properties</span></p>
|
||||
<div class="section" id="object-events">
|
||||
<h2>Object Events<a class="headerlink" href="#object-events" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Object events are typically used for NPCs (non-player-characters). More technically, it’s any event that has a sprite and the ability to move around. Object events are displayed using their assigned sprite, except for special cases. Any object event that uses a dynamic sprite will be displayed as a blue square with an <cite>N</cite> <img alt="dynamic-sprite" src="../_images/dynamic-sprite.png" />. Some examples of dynamic sprites are the player’s rival and berry trees.</p>
|
||||
<div class="figure align-default" id="id4">
|
||||
<img alt="Object Event Properties" src="../_images/event-object.png" />
|
||||
<p class="caption"><span class="caption-text">Object Event Properties</span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<dl class="docutils">
|
||||
<dt>Id</dt>
|
||||
<dd>This is the local id of the object in the map. Some script values use this local id to specify object when using scripting commands such as <cite>applymovement</cite>.</dd>
|
||||
<dt>Sprite</dt>
|
||||
<dd>The sprite that is used by the object.</dd>
|
||||
<dt>Movement</dt>
|
||||
<dd>The movement type used by the object during normal gameplay.</dd>
|
||||
<dt>Movement Radius X/Y</dt>
|
||||
<dd>Movement types that involves walking or moving around the map can be bounded by a radius. The ensures that the object is always within the specified range from its original position.</dd>
|
||||
<dt>Script</dt>
|
||||
<dd>The script that executes when the player interacts with the object.</dd>
|
||||
<dt>Event Flag</dt>
|
||||
<dd>The flag value that controls if the object is visible. If the flag is set (equal to 1), then the object will be invisible. If the Event Flag is set to <cite>0</cite>, then the object will always be visible because <cite>0</cite> means “no flag”.</dd>
|
||||
<dt>Trainer Type</dt>
|
||||
<dd><cite>NONE</cite>, <cite>NORMAL</cite>, or <cite>SEE ALL DIRECTIONS</cite>. If the object is a trainer, <cite>NORMAL</cite> means that the trainer will spot the player in the object’s line-of-sight.</dd>
|
||||
<dt>Sight Radius or Berry Tree ID</dt>
|
||||
<dd>If the object is a trainer, this property control how many tiles the trainer can see to spot the player for battle. If the object is a berry tree, this specifies the global id of the berry tree. Each berry tree in the game has a unique berry tree id.</dd>
|
||||
<dl class="simple">
|
||||
<dt>Id</dt><dd><p>This is the local id of the object in the map. Some script values use this local id to specify object when using scripting commands such as <cite>applymovement</cite>.</p>
|
||||
</dd>
|
||||
<dt>Sprite</dt><dd><p>The sprite that is used by the object.</p>
|
||||
</dd>
|
||||
<dt>Movement</dt><dd><p>The movement type used by the object during normal gameplay.</p>
|
||||
</dd>
|
||||
<dt>Movement Radius X/Y</dt><dd><p>Movement types that involves walking or moving around the map can be bounded by a radius. The ensures that the object is always within the specified range from its original position.</p>
|
||||
</dd>
|
||||
<dt>Script</dt><dd><p>The script that executes when the player interacts with the object.</p>
|
||||
</dd>
|
||||
<dt>Event Flag</dt><dd><p>The flag value that controls if the object is visible. If the flag is set (equal to 1), then the object will be invisible. If the Event Flag is set to <cite>0</cite>, then the object will always be visible because <cite>0</cite> means “no flag”.</p>
|
||||
</dd>
|
||||
<dt>Trainer Type</dt><dd><p><cite>NONE</cite>, <cite>NORMAL</cite>, or <cite>SEE ALL DIRECTIONS</cite>. If the object is a trainer, <cite>NORMAL</cite> means that the trainer will spot the player in the object’s line-of-sight.</p>
|
||||
</dd>
|
||||
<dt>Sight Radius or Berry Tree ID</dt><dd><p>If the object is a trainer, this property control how many tiles the trainer can see to spot the player for battle. If the object is a berry tree, this specifies the global id of the berry tree. Each berry tree in the game has a unique berry tree id.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="event-warps">
|
||||
<span id="id1"></span><h2>Event Warps<a class="headerlink" href="#event-warps" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Event warps are how the player is able to warp to other maps, such as entering a building. Double-clicking on a warp will automatically open the destination map and select the destination warp. This makes it very easy to navigate around in Porymap.</p>
|
||||
<div class="figure" id="id6">
|
||||
<img alt="Event Warp Properties" src="../_images/event-warp.png" />
|
||||
<p class="caption"><span class="caption-text">Event Warp Properties</span></p>
|
||||
<div class="section" id="warp-events">
|
||||
<span id="event-warps"></span><h2>Warp Events<a class="headerlink" href="#warp-events" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Warp events are how the player is able to warp to other maps, such as entering a building. Double-clicking on a warp will automatically open the destination map and select the destination warp. This makes it very easy to navigate around in Porymap.</p>
|
||||
<div class="figure align-default" id="id5">
|
||||
<img alt="Warp Event Properties" src="../_images/event-warp.png" />
|
||||
<p class="caption"><span class="caption-text">Warp Event Properties</span><a class="headerlink" href="#id5" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<dl class="docutils">
|
||||
<dt>Id</dt>
|
||||
<dd>This is the local id of the warp in the map. This is used when setting the Destination Warp property for another warp.</dd>
|
||||
<dt>Destination Map</dt>
|
||||
<dd>The destination map name.</dd>
|
||||
<dt>Destination Warp</dt>
|
||||
<dd>The Id of the warp in the destination map.</dd>
|
||||
<dl class="simple">
|
||||
<dt>Id</dt><dd><p>This is the local id of the warp in the map. This is used when setting the Destination Warp property for another warp.</p>
|
||||
</dd>
|
||||
<dt>Destination Map</dt><dd><p>The destination map name.</p>
|
||||
</dd>
|
||||
<dt>Destination Warp</dt><dd><p>The Id of the warp in the destination map.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="event-triggers">
|
||||
<h2>Event Triggers<a class="headerlink" href="#event-triggers" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Event triggers are scripts that execute when the player walks over them. However, they only execute when a variable is equal some value. Typically, they execute once, set the variable’s value to something else, and then never execute again because the variable’s value no longer matches.</p>
|
||||
<div class="figure" id="id7">
|
||||
<img alt="Event Trigger Properties" src="../_images/event-trigger.png" />
|
||||
<p class="caption"><span class="caption-text">Event Trigger Properties</span></p>
|
||||
<div class="section" id="trigger-events">
|
||||
<h2>Trigger Events<a class="headerlink" href="#trigger-events" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Trigger events are scripts that execute when the player walks over them. However, they only execute when a variable is equal some value. Typically, they execute once, set the variable’s value to something else, and then never execute again because the variable’s value no longer matches.</p>
|
||||
<div class="figure align-default" id="id6">
|
||||
<img alt="Trigger Event Properties" src="../_images/event-trigger.png" />
|
||||
<p class="caption"><span class="caption-text">Trigger Event Properties</span><a class="headerlink" href="#id6" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<dl class="docutils">
|
||||
<dt>Id</dt>
|
||||
<dd>The local id of the trigger in the map. This value is not used for anything.</dd>
|
||||
<dt>Script</dt>
|
||||
<dd>The script that executes when the player walks over the trigger AND when the <cite>Var</cite> equals the <cite>Var Value</cite>.</dd>
|
||||
<dt>Var</dt>
|
||||
<dd>The variable used to determine if the trigger’s Script should execute.</dd>
|
||||
<dt>Var Value</dt>
|
||||
<dd>The value that the Var must equal for the trigger’s Script to execute.</dd>
|
||||
<dl class="simple">
|
||||
<dt>Id</dt><dd><p>The local id of the trigger in the map. This value is not used for anything.</p>
|
||||
</dd>
|
||||
<dt>Script</dt><dd><p>The script that executes when the player walks over the trigger AND when the <cite>Var</cite> equals the <cite>Var Value</cite>.</p>
|
||||
</dd>
|
||||
<dt>Var</dt><dd><p>The variable used to determine if the trigger’s Script should execute.</p>
|
||||
</dd>
|
||||
<dt>Var Value</dt><dd><p>The value that the Var must equal for the trigger’s Script to execute.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="event-weather-triggers">
|
||||
<h2>Event Weather Triggers<a class="headerlink" href="#event-weather-triggers" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Event weather triggers are a very specific type of trigger. When the player walks over a weather trigger, the overworld’s weather will transition to the specified weather type.</p>
|
||||
<div class="figure" id="id8">
|
||||
<img alt="Event Weather Trigger Properties" src="../_images/event-weather-trigger.png" />
|
||||
<p class="caption"><span class="caption-text">Event Weather Trigger Properties</span></p>
|
||||
<div class="section" id="weather-trigger-events">
|
||||
<h2>Weather Trigger Events<a class="headerlink" href="#weather-trigger-events" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Weather trigger events are a very specific type of trigger. When the player walks over a weather trigger, the overworld’s weather will transition to the specified weather type.</p>
|
||||
<div class="figure align-default" id="id7">
|
||||
<img alt="Weather Trigger Event Properties" src="../_images/event-weather-trigger.png" />
|
||||
<p class="caption"><span class="caption-text">Weather Trigger Event Properties</span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<dl class="docutils">
|
||||
<dt>Id</dt>
|
||||
<dd>The local id of the trigger in the map. This value is not used for anything.</dd>
|
||||
<dt>Weather</dt>
|
||||
<dd>The type of weather to transition to.</dd>
|
||||
<dl class="simple">
|
||||
<dt>Id</dt><dd><p>The local id of the trigger in the map. This value is not used for anything.</p>
|
||||
</dd>
|
||||
<dt>Weather</dt><dd><p>The type of weather to transition to.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="event-signs">
|
||||
<h2>Event Signs<a class="headerlink" href="#event-signs" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Event signs, or signposts, are simple interactable scripts. They are typically used for things like signs in front of buildings. The player’s facing direction can be required to be a certain direction in order to interact with the sign. Signs are the first of three “BG” event types.</p>
|
||||
<div class="figure" id="id9">
|
||||
<img alt="Event Sign Properties" src="../_images/event-sign.png" />
|
||||
<p class="caption"><span class="caption-text">Event Sign Properties</span></p>
|
||||
<div class="section" id="sign-event">
|
||||
<h2>Sign Event<a class="headerlink" href="#sign-event" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Sign events, or signposts, are simple interactable scripts. They are typically used for things like signs in front of buildings. The player’s facing direction can be required to be a certain direction in order to interact with the sign. Signs are the first of three “BG” event types.</p>
|
||||
<div class="figure align-default" id="id8">
|
||||
<img alt="Sign Event Properties" src="../_images/event-sign.png" />
|
||||
<p class="caption"><span class="caption-text">Sign Event Properties</span><a class="headerlink" href="#id8" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<dl class="docutils">
|
||||
<dt>Id</dt>
|
||||
<dd>The local id of the BG event in the map. This value is not used for anything.</dd>
|
||||
<dt>Player Facing Direction</dt>
|
||||
<dd>The direction the player must be facing in order to execute the sign’s script.</dd>
|
||||
<dt>Script</dt>
|
||||
<dd>The script that executes when the player interacts with the sign.</dd>
|
||||
<dl class="simple">
|
||||
<dt>Id</dt><dd><p>The local id of the BG event in the map. This value is not used for anything.</p>
|
||||
</dd>
|
||||
<dt>Player Facing Direction</dt><dd><p>The direction the player must be facing in order to execute the sign’s script.</p>
|
||||
</dd>
|
||||
<dt>Script</dt><dd><p>The script that executes when the player interacts with the sign.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="event-hidden-item">
|
||||
<h2>Event Hidden Item<a class="headerlink" href="#event-hidden-item" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="hidden-item-event">
|
||||
<h2>Hidden Item Event<a class="headerlink" href="#hidden-item-event" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Hidden items are invisible items that can be picked up by the player. They each use a flag to ensure the item can only be picked up once.</p>
|
||||
<div class="figure" id="id10">
|
||||
<img alt="Event Hidden Item Properties" src="../_images/event-hidden-item.png" />
|
||||
<p class="caption"><span class="caption-text">Event Hidden Item Properties</span></p>
|
||||
<div class="figure align-default" id="id9">
|
||||
<img alt="Hidden Item Event Properties" src="../_images/event-hidden-item.png" />
|
||||
<p class="caption"><span class="caption-text">Hidden Item Event Properties</span><a class="headerlink" href="#id9" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<dl class="docutils">
|
||||
<dt>Id</dt>
|
||||
<dd>The local id of the BG event in the map. This value is not used for anything.</dd>
|
||||
<dt>Item</dt>
|
||||
<dd>The item the player will receive when interacting with this hidden item.</dd>
|
||||
<dt>Flag</dt>
|
||||
<dd>This flag is set when the player receives the hidden item.</dd>
|
||||
<dl class="simple">
|
||||
<dt>Id</dt><dd><p>The local id of the BG event in the map. This value is not used for anything.</p>
|
||||
</dd>
|
||||
<dt>Item</dt><dd><p>The item the player will receive when interacting with this hidden item.</p>
|
||||
</dd>
|
||||
<dt>Flag</dt><dd><p>This flag is set when the player receives the hidden item.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="event-secret-base">
|
||||
<h2>Event Secret Base<a class="headerlink" href="#event-secret-base" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="secret-base-event">
|
||||
<h2>Secret Base Event<a class="headerlink" href="#secret-base-event" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This is the event used to mark entrances to secret bases. This event will only be functional on certain metatiles. Unfortunately, they are hardcoded into the game’s engine (see <code class="docutils literal notranslate"><span class="pre">sSecretBaseEntranceMetatiles</span></code> in <code class="docutils literal notranslate"><span class="pre">src/secret_base.c</span></code>).</p>
|
||||
<div class="figure" id="id11">
|
||||
<img alt="Event Secret Base Properties" src="../_images/event-secret-base.png" />
|
||||
<p class="caption"><span class="caption-text">Event Secret Base Properties</span></p>
|
||||
<div class="figure align-default" id="id10">
|
||||
<img alt="Secret Base Event Properties" src="../_images/event-secret-base.png" />
|
||||
<p class="caption"><span class="caption-text">Secret Base Event Properties</span><a class="headerlink" href="#id10" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<dl class="docutils">
|
||||
<dt>Id</dt>
|
||||
<dd>The local id of the BG event in the map. This value is not used for anything.</dd>
|
||||
<dt>Secret Base Id</dt>
|
||||
<dd>The id of the destination secret base.</dd>
|
||||
<dl class="simple">
|
||||
<dt>Id</dt><dd><p>The local id of the BG event in the map. This value is not used for anything.</p>
|
||||
</dd>
|
||||
<dt>Secret Base Id</dt><dd><p>The id of the destination secret base.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="adding-deleting-events">
|
||||
|
|
|
|||
|
|
@ -21,10 +21,10 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||||
|
||||
|
|
@ -115,14 +115,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -151,39 +151,51 @@
|
|||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -256,33 +268,33 @@
|
|||
<div class="section" id="editing-map-headers">
|
||||
<h1>Editing Map Headers<a class="headerlink" href="#editing-map-headers" title="Permalink to this headline">¶</a></h1>
|
||||
<p>The map header is a collection of miscellaneous properties that belong to a map. They are mostly self-explanatory, but we’ll go over each of them.</p>
|
||||
<div class="figure" id="id1">
|
||||
<div class="figure align-default" id="id1">
|
||||
<img alt="Map Header View" src="../_images/map-header.png" />
|
||||
<p class="caption"><span class="caption-text">Map Header View</span></p>
|
||||
<p class="caption"><span class="caption-text">Map Header View</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<dl class="docutils">
|
||||
<dt>Song</dt>
|
||||
<dd>The background music that is automatically played when entering the map.</dd>
|
||||
<dt>Location</dt>
|
||||
<dd>The region map section to which the map belongs.</dd>
|
||||
<dt>Requires Flash</dt>
|
||||
<dd>Whether or not the map has limited vision which the HM move Flash can expand.</dd>
|
||||
<dt>Weather</dt>
|
||||
<dd>The weather that is running when entering the map.</dd>
|
||||
<dt>Type</dt>
|
||||
<dd>The type of map. This value is used by various things in the game engine. For example, in Ruby Version, running shoes can only be used when the map type is <code class="docutils literal notranslate"><span class="pre">MAP_TYPE_INDOOR</span></code>.</dd>
|
||||
<dt>Battle Scene</dt>
|
||||
<dd>Controls what graphics are used in battles.</dd>
|
||||
<dt>Show Location Name</dt>
|
||||
<dd>Shows or hides the map name popup window when entering the map.</dd>
|
||||
<dt>Allow Running</dt>
|
||||
<dd>Controls whether or not running shoes can be used.</dd>
|
||||
<dt>Allow Biking</dt>
|
||||
<dd>Controls whether or not a bike can be used.</dd>
|
||||
<dt>Allow Dig & Escape Rop</dt>
|
||||
<dd>Controls whether the Dig field move or the Escape Rope item can be used.</dd>
|
||||
<dt>Custom Fields</dt>
|
||||
<dd>You can enter custom fields if you need support for additional fields in your project. They can also be useful for keeping notes.</dd>
|
||||
<dl class="simple">
|
||||
<dt>Song</dt><dd><p>The background music that is automatically played when entering the map.</p>
|
||||
</dd>
|
||||
<dt>Location</dt><dd><p>The region map section to which the map belongs.</p>
|
||||
</dd>
|
||||
<dt>Requires Flash</dt><dd><p>Whether or not the map has limited vision which the HM move Flash can expand.</p>
|
||||
</dd>
|
||||
<dt>Weather</dt><dd><p>The weather that is running when entering the map.</p>
|
||||
</dd>
|
||||
<dt>Type</dt><dd><p>The type of map. This value is used by various things in the game engine. For example, in Ruby Version, running shoes can only be used when the map type is <code class="docutils literal notranslate"><span class="pre">MAP_TYPE_INDOOR</span></code>.</p>
|
||||
</dd>
|
||||
<dt>Battle Scene</dt><dd><p>Controls what graphics are used in battles.</p>
|
||||
</dd>
|
||||
<dt>Show Location Name</dt><dd><p>Shows or hides the map name popup window when entering the map.</p>
|
||||
</dd>
|
||||
<dt>Allow Running</dt><dd><p>Controls whether or not running shoes can be used.</p>
|
||||
</dd>
|
||||
<dt>Allow Biking</dt><dd><p>Controls whether or not a bike can be used.</p>
|
||||
</dd>
|
||||
<dt>Allow Dig & Escape Rop</dt><dd><p>Controls whether the Dig field move or the Escape Rope item can be used.</p>
|
||||
</dd>
|
||||
<dt>Custom Fields</dt><dd><p>You can enter custom fields if you need support for additional fields in your project. They can also be useful for keeping notes.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -21,10 +21,10 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||||
|
||||
|
|
@ -115,14 +115,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -151,39 +151,51 @@
|
|||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -260,49 +272,49 @@
|
|||
<h2>Visual Options<a class="headerlink" href="#visual-options" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Before getting into the details of editing map tiles, you should be aware of some settings that make your life easier.</p>
|
||||
<p>A grid can be displayed over the editable map area by using the <code class="docutils literal notranslate"><span class="pre">Grid</span></code> checkbox, which is located in the toolbar above the map area.</p>
|
||||
<div class="figure" id="id1">
|
||||
<div class="figure align-default" id="id1">
|
||||
<img alt="Map Grid" src="../_images/map-grid.png" />
|
||||
<p class="caption"><span class="caption-text">Map Grid</span></p>
|
||||
<p class="caption"><span class="caption-text">Map Grid</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>The border’s visibility, including the surrounding map connections, can be toggled with the <code class="docutils literal notranslate"><span class="pre">Border</span></code> checkbox, which is located in the toolbar above the map area.</p>
|
||||
<div class="figure" id="id2">
|
||||
<div class="figure align-default" id="id2">
|
||||
<img alt="Map Border Toggled Off" src="../_images/map-border-off.png" />
|
||||
<p class="caption"><span class="caption-text">Map Border Toggled Off</span></p>
|
||||
<p class="caption"><span class="caption-text">Map Border Toggled Off</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>You can zoom in and out on the map with <em>View -> Zoom In</em> (<code class="docutils literal notranslate"><span class="pre">Ctrl++</span></code> or <code class="docutils literal notranslate"><span class="pre">Ctrl+Mouse</span> <span class="pre">Wheel</span> <span class="pre">Scroll</span> <span class="pre">Up</span></code>) and <em>View -> Zoom Out</em> (<code class="docutils literal notranslate"><span class="pre">Ctrl+-</span></code> or <code class="docutils literal notranslate"><span class="pre">Ctrl+Mouse</span> <span class="pre">Wheel</span> <span class="pre">Scroll</span> <span class="pre">Down</span></code>).</p>
|
||||
<p>By default, the mouse cursor will show a white indicator outline of the currently-hovered tile(s) of what will be painted. You can disable this outline with <em>View -> Cursor Tile Outline</em>. Additionally, the cursor changes its appearance depending on which tool you currently have selected in the toolbar. You can disable this with <em>View -> Cursor Icons</em>.</p>
|
||||
<p>An indicator outline for the player’s in-game view radius can be toggled with <em>View -> Player View Rectangle</em>.</p>
|
||||
<p>The Metatile Selection Pane can be zoomed in or out using the slider on the bottom.</p>
|
||||
<div class="figure" id="id3">
|
||||
<div class="figure align-default" id="id3">
|
||||
<img alt="Metatile Selection Zoom Slider" src="../_images/metatile-selection-slider.png" />
|
||||
<p class="caption"><span class="caption-text">Metatile Selection Zoom Slider</span></p>
|
||||
<p class="caption"><span class="caption-text">Metatile Selection Zoom Slider</span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="selecting-metatiles">
|
||||
<h2>Selecting Metatiles<a class="headerlink" href="#selecting-metatiles" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Before you paint onto the map, you need to select which metatiles you will be painting. The primary way to do this is to click on a metatile from the Metatile Selection Pane. Whenever you change your selection, the selection preview will update so you can see exactly what you have selected at all times.</p>
|
||||
<div class="figure" id="id4">
|
||||
<div class="figure align-default" id="id4">
|
||||
<img alt="Basic Metatile Selection" src="../_images/single-metatile-selection.gif" />
|
||||
<p class="caption"><span class="caption-text">Basic Metatile Selection</span></p>
|
||||
<p class="caption"><span class="caption-text">Basic Metatile Selection</span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>You can select more than one tile at a time by clicking and dragging the desired region. For example, it’s convenient to select the entire Pokémon Center at once.</p>
|
||||
<div class="figure" id="id5">
|
||||
<div class="figure align-default" id="id5">
|
||||
<img alt="Multiple Metatile Selection" src="../_images/multiple-metatile-selection.gif" />
|
||||
<p class="caption"><span class="caption-text">Multiple Metatile Selection</span></p>
|
||||
<p class="caption"><span class="caption-text">Multiple Metatile Selection</span><a class="headerlink" href="#id5" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>Metatiles can also be selected from existing metatiles on the map area. Use the Eyedropper Tool with <em>Tools -> Eyedropper</em> (<code class="docutils literal notranslate"><span class="pre">E</span></code>), or simply click the Eyedropper button <img alt="eyedropper-tool" src="../_images/eyedropper-tool.png" /> in the toolbar above the map area. A more powerful way to do this is to right-click on the map when using the Pencil Tool or Bucket Fill Tool. You can even right-click and drag to copy a region from the map. In this example GIF, we demonstrate how quick and easy it is to use the right-click method to copy and paint metatiles.</p>
|
||||
<div class="figure" id="id6">
|
||||
<div class="figure align-default" id="id6">
|
||||
<img alt="Right-Click Metatile Selection" src="../_images/right-click-metatile-selection.gif" />
|
||||
<p class="caption"><span class="caption-text">Right-Click Metatile Selection</span></p>
|
||||
<p class="caption"><span class="caption-text">Right-Click Metatile Selection</span><a class="headerlink" href="#id6" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>Now, let’s learn how to use the various tools to paint your metatile selection onto the map.</p>
|
||||
</div>
|
||||
<div class="section" id="pencil-tool">
|
||||
<h2>Pencil Tool<a class="headerlink" href="#pencil-tool" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Pencil Tool <img alt="pencil-tool" src="../_images/pencil-tool.png" /> (<em>Tools -> Pencil</em>, or <code class="docutils literal notranslate"><span class="pre">N</span></code>) is your bread and butter when editing maps. Simply left-click to paint your current metatile selection onto the map. You can click and drag to paint a bigger portion of the map. When clicking and dragging, the metatiles will be painted as if they are snapping to a grid. This simplifies things like painting large areas of trees.</p>
|
||||
<div class="figure" id="id7">
|
||||
<div class="figure align-default" id="id7">
|
||||
<img alt="Painting a Large Metatile Selection" src="../_images/snapping-painting.gif" />
|
||||
<p class="caption"><span class="caption-text">Painting a Large Metatile Selection</span></p>
|
||||
<p class="caption"><span class="caption-text">Painting a Large Metatile Selection</span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="pointer-tool">
|
||||
|
|
@ -312,50 +324,50 @@
|
|||
<div class="section" id="bucket-fill-tool">
|
||||
<h2>Bucket Fill Tool<a class="headerlink" href="#bucket-fill-tool" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Bucket Fill Tool <img alt="bucket-fill-tool" src="../_images/bucket-fill-tool.png" /> (<em>Tools -> Bucket Fill</em>, or <code class="docutils literal notranslate"><span class="pre">B</span></code>) works just like you think it does. It fills a contiguous region of identical metatiles. If you have a large metatile selection, it will fill the region with that pattern. A useful shortcut for the Bucket Fill Tool is to middle-click when using the Pencil Tool.</p>
|
||||
<div class="figure" id="id8">
|
||||
<div class="figure align-default" id="id8">
|
||||
<img alt="Painting with Bucket Fill Tool" src="../_images/bucket-fill-painting.gif" />
|
||||
<p class="caption"><span class="caption-text">Painting with Bucket Fill Tool</span></p>
|
||||
<p class="caption"><span class="caption-text">Painting with Bucket Fill Tool</span><a class="headerlink" href="#id8" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>Holding down the <code class="docutils literal notranslate"><span class="pre">Ctrl</span></code> key while using the Bucket Fill Tool will fill <em>all</em> matching metatiles on the map, rather that just the contiguous region.</p>
|
||||
</div>
|
||||
<div class="section" id="map-shift-tool">
|
||||
<h2>Map Shift Tool<a class="headerlink" href="#map-shift-tool" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Map Shift Tool <img alt="map-shift-tool" src="../_images/map-shift-tool.png" /> (<em>Tools -> Map Shift</em>, or <code class="docutils literal notranslate"><span class="pre">S</span></code>) lets you shift the metatile positions of the entire map at the same time. This is useful after resizing a map. (Though, simply right-click copying the entire map is another way of accomplishing the same thing.) Metatiles are wrapped around to the other side of the map when using the Map Shift Tool. Simply click and drag on the map to perform the map shift.</p>
|
||||
<div class="figure" id="id9">
|
||||
<div class="figure align-default" id="id9">
|
||||
<img alt="Map Shift Tool" src="../_images/map-shift-painting.gif" />
|
||||
<p class="caption"><span class="caption-text">Map Shift Tool</span></p>
|
||||
<p class="caption"><span class="caption-text">Map Shift Tool</span><a class="headerlink" href="#id9" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="smart-paths">
|
||||
<h2>Smart Paths<a class="headerlink" href="#smart-paths" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Smart Paths provide an easy way to paint pathways, ponds, and mountains. If there is any formation of metatiles that have a basic outline and a “middle” tile, then smart paths can help save you time when painting. <strong>Smart Paths can only be used when you have a 3x3 metatile selection.</strong> Smart Paths is only available when using the Pencil Tool or the Bucket Fill Tool. To enable Smart Paths, you must either check the Smart Paths checkbox above the map area, or you can hold down the <code class="docutils literal notranslate"><span class="pre">Shift</span></code> key. Below are a few examples that illustrate the power of Smart Paths.</p>
|
||||
<div class="figure" id="id10">
|
||||
<div class="figure align-default" id="id10">
|
||||
<img alt="Regular vs. Smart Paths" src="../_images/smart-paths-1-painting.gif" />
|
||||
<p class="caption"><span class="caption-text">Regular vs. Smart Paths</span></p>
|
||||
<p class="caption"><span class="caption-text">Regular vs. Smart Paths</span><a class="headerlink" href="#id10" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<div class="figure" id="id11">
|
||||
<div class="figure align-default" id="id11">
|
||||
<img alt="Bucket Fill with Smart Paths" src="../_images/smart-paths-2-painting.gif" />
|
||||
<p class="caption"><span class="caption-text">Bucket Fill with Smart Paths</span></p>
|
||||
<p class="caption"><span class="caption-text">Bucket Fill with Smart Paths</span><a class="headerlink" href="#id11" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<div class="figure" id="id12">
|
||||
<div class="figure align-default" id="id12">
|
||||
<img alt="Smart Paths from Right-Click Selection" src="../_images/smart-paths-3-painting.gif" />
|
||||
<p class="caption"><span class="caption-text">Smart Paths from Right-Click Selection</span></p>
|
||||
<p class="caption"><span class="caption-text">Smart Paths from Right-Click Selection</span><a class="headerlink" href="#id12" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="change-map-border">
|
||||
<h2>Change Map Border<a class="headerlink" href="#change-map-border" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The map’s border can be modified by painting on the Border image, which is located above the metatile selection pane.</p>
|
||||
<div class="figure" id="id13">
|
||||
<div class="figure align-default" id="id13">
|
||||
<img alt="Change Map Border" src="../_images/map-border.png" />
|
||||
<p class="caption"><span class="caption-text">Change Map Border</span></p>
|
||||
<p class="caption"><span class="caption-text">Change Map Border</span><a class="headerlink" href="#id13" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="change-map-tilesets">
|
||||
<h2>Change Map Tilesets<a class="headerlink" href="#change-map-tilesets" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Every map uses exactly two Tilesets–primary and secondary. These can be changed by choosing a different value from the two Tileset dropdowns.</p>
|
||||
<div class="figure" id="id14">
|
||||
<div class="figure align-default" id="id14">
|
||||
<img alt="Tileset Pickers" src="../_images/tileset-pickers.png" />
|
||||
<p class="caption"><span class="caption-text">Tileset Pickers</span></p>
|
||||
<p class="caption"><span class="caption-text">Tileset Pickers</span><a class="headerlink" href="#id14" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="undo-redo">
|
||||
|
|
|
|||
|
|
@ -21,10 +21,10 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||||
|
||||
|
|
@ -115,14 +115,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -151,39 +151,51 @@
|
|||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -260,22 +272,22 @@ Navigate to the “Wild Pokemon” tab in porymap’s main window.</p>
|
|||
<p>If you open the tab and there are no wild encounters for the current map, you
|
||||
will see an empty screen (pictured below). Adding wild pokemon data is as
|
||||
simple as <a class="reference internal" href="#add-encounter-groups"><span class="std std-ref">adding new encounter groups</span></a>.</p>
|
||||
<div class="figure" id="id1">
|
||||
<div class="figure align-default" id="id1">
|
||||
<img alt="Empty Encounter Tab" src="../_images/no-encounters.png" />
|
||||
<p class="caption"><span class="caption-text">Empty Encounter Tab</span></p>
|
||||
<p class="caption"><span class="caption-text">Empty Encounter Tab</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>Otherwise, you should see something similar to this:</p>
|
||||
<div class="figure" id="id2">
|
||||
<div class="figure align-default" id="id2">
|
||||
<img alt="Populated Encounter Tab" src="../_images/populated-encounter-tab.png" />
|
||||
<p class="caption"><span class="caption-text">Populated Encounter Tab</span></p>
|
||||
<p class="caption"><span class="caption-text">Populated Encounter Tab</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>The tab for each field is active or disabled based on the encounter data for a
|
||||
given map. If a tab is disabled, you can activate it, and therefore activate
|
||||
a new encounter field for the map. To activate a field, right-click on the
|
||||
tab name for the field you want to add.</p>
|
||||
<div class="figure" id="id3">
|
||||
<div class="figure align-default" id="id3">
|
||||
<img alt="Activate Encounter Field" src="../_images/activate-tab.png" />
|
||||
<p class="caption"><span class="caption-text">Activate Encounter Field</span></p>
|
||||
<p class="caption"><span class="caption-text">Activate Encounter Field</span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>Editing the wild encounters is otherwise pretty straightforward. You can
|
||||
adjust the minimum and maximum levels, the encounter rate, and species with the
|
||||
|
|
@ -287,9 +299,9 @@ for a single map. In the vanilla games, only Altering Cave uses multiple
|
|||
encounter groups, but there are several reasons you might want them.</p>
|
||||
<p>In order to create a new encounter group, click the green (+) button next to
|
||||
the Group drop-down. It will bring up this menu:</p>
|
||||
<div class="figure" id="id4">
|
||||
<div class="figure align-default" id="id4">
|
||||
<img alt="New Encounter Group Window" src="../_images/new-group-window.png" />
|
||||
<p class="caption"><span class="caption-text">New Encounter Group Window</span></p>
|
||||
<p class="caption"><span class="caption-text">New Encounter Group Window</span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>You can give your new encounter group a name (this must be uniqe, which is
|
||||
enforced), and you can choose which fields to activate for the group. Checking
|
||||
|
|
@ -297,9 +309,9 @@ the “copy from current group” box will copy not only the active fields but a
|
|||
the wild pokemon data for each field from the currently displayed group.</p>
|
||||
<p>One possible use for having multiple encounter groups for a single map is to
|
||||
implement time of day encounters.</p>
|
||||
<div class="figure" id="id5">
|
||||
<div class="figure align-default" id="id5">
|
||||
<img alt="Time of Day Encounter Groups" src="../_images/time-of-day-encounter-group.gif" />
|
||||
<p class="caption"><span class="caption-text">Time of Day Encounter Groups</span></p>
|
||||
<p class="caption"><span class="caption-text">Time of Day Encounter Groups</span><a class="headerlink" href="#id5" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="configuring-the-wild-encounter-fields">
|
||||
|
|
@ -308,9 +320,9 @@ implement time of day encounters.</p>
|
|||
of the field, a default number of pokemon in that field, and the encounter
|
||||
ratio for each index in that field. These are all things you may want to
|
||||
change. Click on the <em>Configure JSON…</em> button to bring up this window:</p>
|
||||
<div class="figure" id="id6">
|
||||
<div class="figure align-default" id="id6">
|
||||
<img alt="Configure JSON Window" src="../_images/configure-json.png" />
|
||||
<p class="caption"><span class="caption-text">Configure JSON Window</span></p>
|
||||
<p class="caption"><span class="caption-text">Configure JSON Window</span><a class="headerlink" href="#id6" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>The Field drop-down will allow you select which field you want to manipulate.
|
||||
You can add a new one with the <em>Add New Field…</em> button. The green (+) and
|
||||
|
|
@ -319,18 +331,18 @@ you will see an adjustible number. This represents the encounter chance for a
|
|||
pokemon at this index out of the total.</p>
|
||||
<p>Let’s add a <code class="docutils literal notranslate"><span class="pre">headbutt_mons</span></code> field to our wild encounters…</p>
|
||||
<p>First, we’ll add a new field and name it <code class="docutils literal notranslate"><span class="pre">headbutt_mons</span></code>.</p>
|
||||
<div class="figure" id="id7">
|
||||
<div class="figure align-default" id="id7">
|
||||
<img alt="New Field Name" src="../_images/configure-json-new-field.png" />
|
||||
<p class="caption"><span class="caption-text">New Field Name</span></p>
|
||||
<p class="caption"><span class="caption-text">New Field Name</span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>Then, we want four slots in this field, and we set encounter ratios for each
|
||||
slot.</p>
|
||||
<div class="figure">
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/headbutt-mon-field.png" src="../_images/headbutt-mon-field.png" />
|
||||
</div>
|
||||
<p>If we accept the changes, we can now assign pokemon to each slots, and adjust
|
||||
the levels.</p>
|
||||
<div class="figure">
|
||||
<div class="figure align-default">
|
||||
<img alt="../_images/headbutt-mons.png" src="../_images/headbutt-mons.png" />
|
||||
</div>
|
||||
<p>Changes made to the wild encounters are not saved to disk until you save the map.</p>
|
||||
|
|
|
|||
|
|
@ -21,10 +21,10 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||||
|
||||
|
|
@ -115,14 +115,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -151,39 +151,51 @@
|
|||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -258,50 +270,50 @@
|
|||
<div class="section" id="about-porymap">
|
||||
<h2>About Porymap<a class="headerlink" href="#about-porymap" title="Permalink to this headline">¶</a></h2>
|
||||
<p><strong>Porymap is a cross-platform map editor for the Gen 3 pret decompilation projects. Its primary functions are to allow editing map tiles, collision, events, connections, and properties. Porymap provides additional functionality, such as tileset editing and region map editing. Downloadable releases are available for Windows and Mac, and Linux users can build it from source.</strong></p>
|
||||
<p>Those familiar with traditional Gen 3 binary ROM hacking can think of it as the Advance Map equivalent for the decompilation projects. Porymap supports the same features as Advance Map, except for Wild Pokemon editing, so Advance Map users shouldn’t have much difficulty learning how to use Porymap. There are many usability improvements in Porymap. The most notable is undo/redo when painting map tiles.</p>
|
||||
<p>Those familiar with traditional Gen 3 binary ROM hacking can think of it as the Advance Map equivalent for the decompilation projects. Porymap supports the same features as Advance Map, so Advance Map users shouldn’t have much difficulty learning how to use Porymap. There are many usability improvements in Porymap. The most notable is undo/redo when painting map tiles.</p>
|
||||
<p>Porymap reads and writes files in the decompilation projects. It <strong>does not</strong> read or write ROM files. <strong>Therefore, it is highly recommended to use Git for version control when working with Porymap.</strong></p>
|
||||
</div>
|
||||
<div class="section" id="getting-started">
|
||||
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Before using Porymap, you must have your decompilation project setup. Porymap currently supports <a class="reference external" href="https://github.com/pret/pokeemerald">pokeemerald</a> and <a class="reference external" href="https://github.com/pret/pokeruby">pokeruby</a>. See their respective <code class="docutils literal notranslate"><span class="pre">INSTALL.md</span></code> files to get setup, and make sure you can successfully compile the ROM.</p>
|
||||
<p>When launching Porymap for the first time, you will be greeted with the following empty window:</p>
|
||||
<div class="figure" id="id1">
|
||||
<div class="figure align-default" id="id1">
|
||||
<img alt="Porymap Empty Window" src="../_images/porymap-empty-window.png" />
|
||||
<p class="caption"><span class="caption-text">Porymap Empty Window</span></p>
|
||||
<p class="caption"><span class="caption-text">Porymap Empty Window</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>The first thing we’ll do is open a Gen 3 decompilation project with <em>File -> Open Project…</em> (<code class="docutils literal notranslate"><span class="pre">Ctrl+O</span></code>). A folder selection dialog will pop up. Choose the location of your existing decompilation project. After doing so, Porymap will take a few seconds to load the project, and the main window should now be displaying the first map. (In <code class="docutils literal notranslate"><span class="pre">pokeemerald</span></code>, it’s Petalburg City.)</p>
|
||||
<div class="figure" id="id2">
|
||||
<div class="figure align-default" id="id2">
|
||||
<img alt="Porymap Main Window" src="../_images/porymap-loaded-project.png" />
|
||||
<p class="caption"><span class="caption-text">Porymap Main Window</span></p>
|
||||
<p class="caption"><span class="caption-text">Porymap Main Window</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>Now, let’s make our first basic edit using Porymap. We’ll use the Pencil Tool to draw some more flowers on the grass in Petalburg City. First, make sure the Pencil Tool is selected. You can click the Pencil Tool button, press the <code class="docutils literal notranslate"><span class="pre">N</span></code> shortcut, or select <em>Tools -> Pencil</em>. The various painting Tool buttons are found on the left side of the toolbar above the map area.</p>
|
||||
<div class="figure" id="id3">
|
||||
<div class="figure align-default" id="id3">
|
||||
<img alt="Tool Buttons" src="../_images/tool-buttons.png" />
|
||||
<p class="caption"><span class="caption-text">Tool Buttons</span></p>
|
||||
<p class="caption"><span class="caption-text">Tool Buttons</span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>Next, select the flower metatile from the Metatile Selection panel by left-clicking on it. The flower is metatile 0x4 in the General tileset.</p>
|
||||
<div class="figure" id="id4">
|
||||
<div class="figure align-default" id="id4">
|
||||
<img alt="Metatile Selection Panel" src="../_images/metatile-selection-panel.png" />
|
||||
<p class="caption"><span class="caption-text">Metatile Selection Panel</span></p>
|
||||
<p class="caption"><span class="caption-text">Metatile Selection Panel</span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>Porymap shows the current metatile selection in the Selection panel.</p>
|
||||
<div class="figure" id="id5">
|
||||
<div class="figure align-default" id="id5">
|
||||
<img alt="Current Metatile Selection" src="../_images/metatile-current-selection.png" />
|
||||
<p class="caption"><span class="caption-text">Current Metatile Selection</span></p>
|
||||
<p class="caption"><span class="caption-text">Current Metatile Selection</span><a class="headerlink" href="#id5" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>Place some flowers in Petalburg City by left-clicking to paint on the map area.</p>
|
||||
<div class="figure" id="id6">
|
||||
<div class="figure align-default" id="id6">
|
||||
<img alt="Flowery Petalburg City" src="../_images/flowers-painted.png" />
|
||||
<p class="caption"><span class="caption-text">Flowery Petalburg City</span></p>
|
||||
<p class="caption"><span class="caption-text">Flowery Petalburg City</span><a class="headerlink" href="#id6" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>That looks great! Save your changes with <em>File -> Save</em> (<code class="docutils literal notranslate"><span class="pre">Ctrl+S</span></code>). Finally, compile the ROM and see the results in-game.</p>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last">When re-compiling your ROM, it is not recommended to use <code class="docutils literal notranslate"><span class="pre">NODEP=1</span></code>, since that can result in data changes being ignored.</p>
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>When re-compiling your ROM, it is not recommended to use <code class="docutils literal notranslate"><span class="pre">NODEP=1</span></code>, since that can result in data changes being ignored.</p>
|
||||
</div>
|
||||
<div class="figure" id="id7">
|
||||
<div class="figure align-default" id="id7">
|
||||
<img alt="Petalburg City In-Game Changes" src="../_images/flower-petalburg-ingame.png" />
|
||||
<p class="caption"><span class="caption-text">Petalburg City In-Game Changes</span></p>
|
||||
<p class="caption"><span class="caption-text">Petalburg City In-Game Changes</span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>Now that you have the basic workflow down, it’s time to learn how to navigate the various windows and screens of Porymap.</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -21,10 +21,10 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||||
|
||||
|
|
@ -115,14 +115,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -151,39 +151,51 @@
|
|||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -259,58 +271,60 @@
|
|||
<div class="section" id="map-list">
|
||||
<h2>Map List<a class="headerlink" href="#map-list" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The map list contains a hierarchical view of all of the maps in your project. It is situated on the left side of Porymap’s main window. To switch to a different map, simply double-click or press <code class="docutils literal notranslate"><span class="pre">Enter</span></code> on the desired map’s name. Larger maps can take a few seconds to load the first time, so be patient.</p>
|
||||
<div class="figure" id="id1">
|
||||
<div class="figure align-default" id="id1">
|
||||
<img alt="Map List Pane" src="../_images/map-list-pane.png" />
|
||||
<p class="caption"><span class="caption-text">Map List Pane</span></p>
|
||||
<p class="caption"><span class="caption-text">Map List Pane</span><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>By default, the maps are organized by their map groups. The <em>Sort Map List</em> <img alt="sort-map-list-button" src="../_images/sort-map-list-button.png" /> button gives you some other options to organize the maps:</p>
|
||||
<dl class="docutils">
|
||||
<dt>Sort by Group</dt>
|
||||
<dd>Organizes by map groups.</dd>
|
||||
<dt>Sort by Area</dt>
|
||||
<dd>Organizes by region map section.</dd>
|
||||
<dt>Sort by Layout</dt>
|
||||
<dd>Organizes by map layouts. Most layouts are only used by a single map, but layouts like the Pokemon Center are used by many maps.</dd>
|
||||
<dl class="simple">
|
||||
<dt>Sort by Group</dt><dd><p>Organizes by map groups.</p>
|
||||
</dd>
|
||||
<dt>Sort by Area</dt><dd><p>Organizes by region map section.</p>
|
||||
</dd>
|
||||
<dt>Sort by Layout</dt><dd><p>Organizes by map layouts. Most layouts are only used by a single map, but layouts like the Pokemon Center are used by many maps.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p>The <em>Expand All</em> <img alt="expand-all-button" src="../_images/expand-all-button.png" /> and <em>Collapse All</em> <img alt="collapse-all-button" src="../_images/collapse-all-button.png" /> buttons will expand or collapse all of the map folders.</p>
|
||||
<p>Type in the filter to show maps that contain the filter text.</p>
|
||||
<div class="figure" id="id2">
|
||||
<div class="figure align-default" id="id2">
|
||||
<img alt="Filter Map List" src="../_images/filter-map-list.png" />
|
||||
<p class="caption"><span class="caption-text">Filter Map List</span></p>
|
||||
<p class="caption"><span class="caption-text">Filter Map List</span><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="main-window">
|
||||
<h2>Main Window<a class="headerlink" href="#main-window" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Most of the work you do in Porymap is in the center Main Window. It features 4 tabbed views which each have different purposes, but they all operate within the context of the currently-opened map in the Map List. Let’s quickly summarize what each of these tabs is used for.</p>
|
||||
<div class="figure" id="id3">
|
||||
<div class="figure align-default" id="id3">
|
||||
<img alt="Main Window Tabs" src="../_images/main-window-tabs.png" />
|
||||
<p class="caption"><span class="caption-text">Main Window Tabs</span></p>
|
||||
<p class="caption"><span class="caption-text">Main Window Tabs</span><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<dl class="docutils">
|
||||
<dt>Map Tab</dt>
|
||||
<dd>Paint metatiles and their collision properties to change the appearance of the map and how the player can walk around the map. When the Map Tab is selected, the pane on the right side of the map will have two tabs: Metatiles and Collision. You can switch between these to paint either metatiles or collision properties onto the map.</dd>
|
||||
<dt>Events Tab</dt>
|
||||
<dd>Edit the interactable events on the map. This includes things like objects, warps, script triggers, and more.</dd>
|
||||
<dt>Header Tab</dt>
|
||||
<dd>Choose various gameplay properties to set for the map. This includes things like background music and weather.</dd>
|
||||
<dt>Connections Tab</dt>
|
||||
<dd>Change how the map connects with surrounding maps when the player walks from one to another.</dd>
|
||||
<dl class="simple">
|
||||
<dt>Map Tab</dt><dd><p>Paint metatiles and their collision properties to change the appearance of the map and how the player can walk around the map. When the Map Tab is selected, the pane on the right side of the map will have two tabs: Metatiles and Collision. You can switch between these to paint either metatiles or collision properties onto the map.</p>
|
||||
</dd>
|
||||
<dt>Events Tab</dt><dd><p>Edit the interactable events on the map. This includes things like objects, warps, script triggers, and more.</p>
|
||||
</dd>
|
||||
<dt>Header Tab</dt><dd><p>Choose various gameplay properties to set for the map. This includes things like background music and weather.</p>
|
||||
</dd>
|
||||
<dt>Connections Tab</dt><dd><p>Change how the map connects with surrounding maps when the player walks from one to another.</p>
|
||||
</dd>
|
||||
<dt>Wild Pokémon Tab</dt><dd><p>Edit the wild Pokémon available in the map.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="section" id="tileset-editor">
|
||||
<h2>Tileset Editor<a class="headerlink" href="#tileset-editor" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Tileset Editor can be opened with <em>File -> Tileset Editor</em>. When the Tileset Editor is opened, it is opened in the context of the currently-opened map. Every map has a primary and secondary tileset, so you will work with a combination of the two whenever you use the Tileset Editor. The left-side pane shows the primary and secondary tilesets’ metatiles. The right-side panes allow you to modify the currently-selected metatile.</p>
|
||||
<div class="figure" id="id4">
|
||||
<div class="figure align-default" id="id4">
|
||||
<img alt="Tileset Editor" src="../_images/tileset-editor.png" />
|
||||
<p class="caption"><span class="caption-text">Tileset Editor</span></p>
|
||||
<p class="caption"><span class="caption-text">Tileset Editor</span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="region-map-editor">
|
||||
<h2>Region Map Editor<a class="headerlink" href="#region-map-editor" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The Region Map Editor can be opened with <em>File -> Region Map Editor</em>. This window will allow you to modify the look and layout of maps on the game’s region map. You can also modify the city map images using the bottom two panes.</p>
|
||||
<div class="figure" id="id5">
|
||||
<div class="figure align-default" id="id5">
|
||||
<img alt="Region Map Editor" src="../_images/region-map-editor.png" />
|
||||
<p class="caption"><span class="caption-text">Region Map Editor</span></p>
|
||||
<p class="caption"><span class="caption-text">Region Map Editor</span><a class="headerlink" href="#id5" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>We covered all of the basic views and windows of Porymap above. Next, let’s learn how to use Porymap’s features to the fullest when editing map tiles.</p>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -21,10 +21,10 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||||
|
||||
|
|
@ -115,14 +115,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -151,39 +151,51 @@
|
|||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -256,177 +268,177 @@
|
|||
<div class="section" id="project-files">
|
||||
<h1>Project Files<a class="headerlink" href="#project-files" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Porymap relies on the user maintaining a certain level of integrity with their project files.
|
||||
This is a list of files that porymap reads from and writes to. Generally, if porymap writes to a file, it
|
||||
probably is not a good idea to edit yourself unless otherwise noted.</p>
|
||||
<table border="1" class="colwidths-given docutils">
|
||||
This is a list of files that porymap reads from and writes to. Generally, if porymap writes
|
||||
to a file, it probably is not a good idea to edit yourself unless otherwise noted.</p>
|
||||
<table class="colwidths-given docutils align-default">
|
||||
<colgroup>
|
||||
<col width="33%" />
|
||||
<col width="8%" />
|
||||
<col width="8%" />
|
||||
<col width="50%" />
|
||||
<col style="width: 33%" />
|
||||
<col style="width: 8%" />
|
||||
<col style="width: 8%" />
|
||||
<col style="width: 50%" />
|
||||
</colgroup>
|
||||
<thead valign="bottom">
|
||||
<tr class="row-odd"><th class="head">File Name</th>
|
||||
<th class="head">Read</th>
|
||||
<th class="head">Write</th>
|
||||
<th class="head">Notes</th>
|
||||
<thead>
|
||||
<tr class="row-odd"><th class="head"><p>File Name</p></th>
|
||||
<th class="head"><p>Read</p></th>
|
||||
<th class="head"><p>Write</p></th>
|
||||
<th class="head"><p>Notes</p></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody valign="top">
|
||||
<tr class="row-even"><td>data/maps/*/map.json</td>
|
||||
<td>yes</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<tbody>
|
||||
<tr class="row-even"><td><p>data/maps/*/map.json</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>data/event_scripts.s</td>
|
||||
<td>no</td>
|
||||
<td>yes</td>
|
||||
<td>only appends new script files to end of file</td>
|
||||
<tr class="row-odd"><td><p>data/event_scripts.s</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>only appends new script files to end of file</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>data/maps/map_groups.json</td>
|
||||
<td>yes</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<tr class="row-even"><td><p>data/maps/map_groups.json</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>data/layouts/layouts.json</td>
|
||||
<td>yes</td>
|
||||
<td>yes</td>
|
||||
<td>also reads border and blockdata files listed in this file</td>
|
||||
<tr class="row-odd"><td><p>data/layouts/layouts.json</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>also reads border and blockdata files listed in this file</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>data/tilesets/headers.inc</td>
|
||||
<td>yes</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<tr class="row-even"><td><p>data/tilesets/headers.inc</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>data/tilesets/graphics.inc</td>
|
||||
<td>yes</td>
|
||||
<td>yes</td>
|
||||
<td>also edits palette and tile image files listed in this file</td>
|
||||
<tr class="row-odd"><td><p>data/tilesets/graphics.inc</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>also edits palette and tile image files listed in this file</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>data/tilesets/metatiles.inc</td>
|
||||
<td>yes</td>
|
||||
<td>yes</td>
|
||||
<td>also edits metatile files listed in this file</td>
|
||||
<tr class="row-even"><td><p>data/tilesets/metatiles.inc</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>also edits metatile files listed in this file</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>src/data/wild_encounters.json</td>
|
||||
<td>yes</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<tr class="row-odd"><td><p>src/data/wild_encounters.json</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>src/data/field_event_obj/event_object_graphics_info_pointers.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<tr class="row-even"><td><p>src/data/field_event_obj/event_object_graphics_info_pointers.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>src/data/field_event_obj/event_object_graphics_info.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<tr class="row-odd"><td><p>src/data/field_event_obj/event_object_graphics_info.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>src/data/field_event_obj/event_object_pic_tables.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<tr class="row-even"><td><p>src/data/field_event_obj/event_object_pic_tables.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>src/data/field_event_obj/event_object_graphics.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<tr class="row-odd"><td><p>src/data/field_event_obj/event_object_graphics.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>src/data/graphics/pokemon.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td>for pokemon sprite icons</td>
|
||||
<tr class="row-even"><td><p>src/data/graphics/pokemon.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td><p>for pokemon sprite icons</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>src/data/heal_locations.h</td>
|
||||
<td>yes</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<tr class="row-odd"><td><p>src/data/heal_locations.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>src/data/region_map/region_map_entries.h</td>
|
||||
<td>yes</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<tr class="row-even"><td><p>src/data/region_map/region_map_entries.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>include/constants/map_groups.h</td>
|
||||
<td>no</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<tr class="row-odd"><td><p>include/constants/map_groups.h</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>include/constants/items.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<tr class="row-even"><td><p>include/constants/items.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>include/constants/flags.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<tr class="row-odd"><td><p>include/constants/flags.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>include/constants/vars.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<tr class="row-even"><td><p>include/constants/vars.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>include/constants/weather.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<tr class="row-odd"><td><p>include/constants/weather.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>include/constants/heal_locations.h</td>
|
||||
<td>no</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<tr class="row-even"><td><p>include/constants/heal_locations.h</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>include/constants/pokemon.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td>reads min and max level constants</td>
|
||||
<tr class="row-odd"><td><p>include/constants/pokemon.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td><p>reads min and max level constants</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>include/constants/map_types.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<tr class="row-even"><td><p>include/constants/map_types.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>include/constants/secret_bases.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<tr class="row-odd"><td><p>include/constants/secret_bases.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>include/constants/event_object_movement_constants.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<tr class="row-even"><td><p>include/constants/event_object_movement_constants.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>include/constants/bg_event_constants.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<tr class="row-odd"><td><p>include/constants/bg_event_constants.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>include/constants/region_map_sections.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<tr class="row-even"><td><p>include/constants/region_map_sections.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>include/constants/metatile_labels.h</td>
|
||||
<td>yes</td>
|
||||
<td>yes</td>
|
||||
<td> </td>
|
||||
<tr class="row-odd"><td><p>include/constants/metatile_labels.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>include/constants/metatile_behaviors.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<tr class="row-even"><td><p>include/constants/metatile_behaviors.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td>include/constants/bg_event_constants.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td> </td>
|
||||
<tr class="row-odd"><td><p>include/constants/bg_event_constants.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td>include/fieldmap.h</td>
|
||||
<td>yes</td>
|
||||
<td>no</td>
|
||||
<td>reads tileset related constants</td>
|
||||
<tr class="row-even"><td><p>include/fieldmap.h</p></td>
|
||||
<td><p>yes</p></td>
|
||||
<td><p>no</p></td>
|
||||
<td><p>reads tileset related constants</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -21,10 +21,10 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||||
|
||||
|
|
@ -115,14 +115,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="editing-map-events.html">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -151,39 +151,51 @@
|
|||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id4">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id8">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id9">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../reference/changelog.html#id25">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -260,7 +272,7 @@ editor, navigate to <em>Tools -> Region Map Editor</em> from porymap’s main
|
|||
<p>When you first open the region map editor, your window will look like this:</p>
|
||||
<div class="figure align-center" id="id4">
|
||||
<a class="reference internal image-reference" href="../_images/rme-new-window.png"><img alt="RME Window" src="../_images/rme-new-window.png" style="width: 621.75px; height: 499.5px;" /></a>
|
||||
<p class="caption"><span class="caption-text">Region Map Editor Window</span></p>
|
||||
<p class="caption"><span class="caption-text">Region Map Editor Window</span><a class="headerlink" href="#id4" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>This window is split vertically–the region map editing is done at the top,
|
||||
while the zoomed-in city maps are edited at the bottom. You can use the
|
||||
|
|
@ -282,7 +294,7 @@ image will select the tile under your mouse from the tile selector.</p>
|
|||
will set all tiles to the first tile in the tile selector.</p>
|
||||
<div class="figure align-center" id="id5">
|
||||
<a class="reference internal image-reference" href="../_images/rme-painting-image.gif"><img alt="RME Paint" src="../_images/rme-painting-image.gif" style="width: 730.5px; height: 424.5px;" /></a>
|
||||
<p class="caption"><span class="caption-text">Drawing on the Region Map Image</span></p>
|
||||
<p class="caption"><span class="caption-text">Drawing on the Region Map Image</span><a class="headerlink" href="#id5" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>It is likely that you will want to use your own tiles for your region map. You
|
||||
can import a tile image by navigating to <em>Tools -> Import Region Map Image Tiles</em>.
|
||||
|
|
@ -299,7 +311,7 @@ player looks at the region map in-game, the layout determines the map under the
|
|||
cursor.</p>
|
||||
<div class="figure align-center" id="id6">
|
||||
<a class="reference internal image-reference" href="../_images/rme-layout-tab.png"><img alt="RME Layout" src="../_images/rme-layout-tab.png" style="width: 734.25px; height: 429.75px;" /></a>
|
||||
<p class="caption"><span class="caption-text">RME Layout Tab</span></p>
|
||||
<p class="caption"><span class="caption-text">RME Layout Tab</span><a class="headerlink" href="#id6" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>To modify the region map layout, select a position by clicking on the map image
|
||||
and higlighting a single square. The “Map Section” combobox will be populated
|
||||
|
|
@ -320,7 +332,7 @@ map section <code class="docutils literal notranslate"><span class="pre">MAPSEC_
|
|||
with <code class="docutils literal notranslate"><span class="pre">MAPSEC_NONE</span></code>.</p>
|
||||
<div class="figure align-center" id="id7">
|
||||
<a class="reference internal image-reference" href="../_images/rme-layout-swap.gif"><img alt="RME Swap" src="../_images/rme-layout-swap.gif" style="width: 559.5px; height: 495.0px;" /></a>
|
||||
<p class="caption"><span class="caption-text">Swapping Map Sections</span></p>
|
||||
<p class="caption"><span class="caption-text">Swapping Map Sections</span><a class="headerlink" href="#id7" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>The “Delete Square” button simply resets a single layout square to <code class="docutils literal notranslate"><span class="pre">MAPSEC_NONE</span></code>.</p>
|
||||
</div>
|
||||
|
|
@ -331,7 +343,7 @@ This determines, for example, where the player’s head appears on the region ma
|
|||
in-game. Entries are stored at <code class="docutils literal notranslate"><span class="pre">src/data/region_map/region_map_entries.h</span></code>.</p>
|
||||
<div class="figure align-center" id="id8">
|
||||
<a class="reference internal image-reference" href="../_images/rme-entries-tab.png"><img alt="RME Entries" src="../_images/rme-entries-tab.png" style="width: 734.25px; height: 429.75px;" /></a>
|
||||
<p class="caption"><span class="caption-text">RME Entries Tab</span></p>
|
||||
<p class="caption"><span class="caption-text">RME Entries Tab</span><a class="headerlink" href="#id8" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>To edit an entry, select a map section from the “Map Section” combobox. You can
|
||||
use the “Location” “x” and “y” spinboxes to change the coordinates of the entry.
|
||||
|
|
@ -345,7 +357,7 @@ the position of the entry’s top-left square on the region map. The “Dimensi
|
|||
You paint on this the same way you paint on the region map background image.</p>
|
||||
<div class="figure align-center" id="id9">
|
||||
<a class="reference internal image-reference" href="../_images/rme-painting-city.gif"><img alt="City Paint" src="../_images/rme-painting-city.gif" style="width: 482.4px; height: 408.0px;" /></a>
|
||||
<p class="caption"><span class="caption-text">Drawing on the City Map</span></p>
|
||||
<p class="caption"><span class="caption-text">Drawing on the City Map</span><a class="headerlink" href="#id9" title="Permalink to this image">¶</a></p>
|
||||
</div>
|
||||
<p>To use custom tiles, there is a tile image importer under
|
||||
<em>Tools -> Import City Map Image Tiles</em>. These images must (1) be indexed with a
|
||||
|
|
|
|||
BIN
docs/objects.inv
BIN
docs/objects.inv
Binary file not shown.
|
|
@ -21,10 +21,10 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||||
|
||||
|
|
@ -115,14 +115,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-events.html">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -151,39 +151,51 @@
|
|||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#changed">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id1">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id4">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id5">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id7">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id8">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id9">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id13">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id14">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#id25">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="related-projects.html">Related Projects</a></li>
|
||||
|
|
@ -260,175 +272,228 @@
|
|||
and this project somewhat adheres to <a class="reference external" href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>. The MINOR version number is bumped when there are breaking changes in the pret projects.</p>
|
||||
<p>The <strong>“Breaking Changes”</strong> listed below are changes that have been made in the decompilation projects (e.g. pokeemerald), which porymap requires in order to work properly. If porymap is used on a project that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly.</p>
|
||||
<div class="section" id="unreleased">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.2...HEAD">Unreleased</a><a class="headerlink" href="#unreleased" title="Permalink to this headline">¶</a></h2>
|
||||
<h2>Unreleased<a class="headerlink" href="#unreleased" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Nothing, yet.</p>
|
||||
</div>
|
||||
<div class="section" id="id1">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/3.0.0...3.0.1">3.0.1</a> - 2020-03-04<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="fixed">
|
||||
<h3>Fixed<a class="headerlink" href="#fixed" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix bug on Mac where tileset images were corrupted when saving.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id2">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/2.0.0...3.0.0">3.0.0</a> - 2020-03-04<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="breaking-changes">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#breaking-changes" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Accomodate event object graphics pointer table being explicitly indexed. From changes introduced in commits <a class="reference external" href="https://github.com/pret/pokeemerald/commit/cdae0c1444bed98e652c87dc3e3edcecacfef8be">cdae0c1444bed98e652c87dc3e3edcecacfef8be</a> and <a class="reference external" href="https://github.com/pret/pokeruby/commit/0e8ccfc4fd3544001f4c25fafd401f7558bdefba">0e8ccfc4fd3544001f4c25fafd401f7558bdefba</a>.</li>
|
||||
<li><p>pokeemerald and pokeruby both underwent a naming consistency update with respect to “object events”. As such, these naming changes break old versions of Porymap.</p>
|
||||
<ul>
|
||||
<li><p>pokeemerald object event PR: https://github.com/pret/pokeemerald/pull/910</p></li>
|
||||
<li><p>pokeruby object event PR: https://github.com/pret/pokeruby/pull/768</p></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="added">
|
||||
<h3>Added<a class="headerlink" href="#added" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Add warning when closing porymap with unsaved changes.</li>
|
||||
<li>Support metatile labels file introduced in pokeruby and pokeemerald commits <a class="reference external" href="https://github.com/pret/pokeruby/commit/ad365a35c1536740cbcbc10bee66e5dd908c39e7">ad365a35c1536740cbcbc10bee66e5dd908c39e7</a> and <a class="reference external" href="https://github.com/pret/pokeemerald/commit/c68ba9f4e8e260f2e3389eccd15f6ee5f4bdcd3e">c68ba9f4e8e260f2e3389eccd15f6ee5f4bdcd3e</a>.</li>
|
||||
<li><p>Add optional support for Poryscript script files via the <code class="docutils literal notranslate"><span class="pre">use_poryscript</span></code> config option.</p></li>
|
||||
<li><p>Selecting a group of metatiles from the map area now also copies the collision properties, too.</p></li>
|
||||
<li><p>Add keyboard shortcut <code class="docutils literal notranslate"><span class="pre">Ctrl</span> <span class="pre">+</span> <span class="pre">G</span></code> for toggling the map grid.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="changed">
|
||||
<h3>Changed<a class="headerlink" href="#changed" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Add wild encounter table editor.</li>
|
||||
<li>Exporting map images is now more configurable. Events, connections, collision, etc. can be toggled on and off before exporting the image.</li>
|
||||
<li>The entire Tileset Editor selection is now conveniently flipped when selecting x-flip or y-flip.</li>
|
||||
<li>Autocomplete for porymap’s comboboxes no longer require typing the full string prefix.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="fixed">
|
||||
<h3>Fixed<a class="headerlink" href="#fixed" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Fix bug where map group names were hardcoded when creating a new map.</li>
|
||||
<li>Fix bug in Tileset Editor where multi-tile selections weren’t properly painted when clicking on the bottom row of the metatile layers.</li>
|
||||
<li>Fix bug where line breaks in C headers were not parsed properly.</li>
|
||||
<li>Fix bug when exporting tileset images using palettes with duplicate colors.</li>
|
||||
<li>Fix bug where creating new maps from existing layouts created an empty layout folder.</li>
|
||||
<li>Fix bug where exported tile images did not contain the last row of tiles.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id1">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.1...1.2.2">1.2.2</a> - 2019-05-16<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id2">
|
||||
<h3>Added<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Add region map editor</li>
|
||||
<li>Add ability to add new tilesets</li>
|
||||
<li>Add official Porymap documentation website: https://huderlem.github.io/porymap/</li>
|
||||
<li><p>Draw map connections with the current map’s tilesets to more accurately mimic their appearance in-game.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id3">
|
||||
<h3>Changed<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
|
||||
<h3>Fixed<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Event sprites now display as facing the direction of their movement type.</li>
|
||||
<li>Default values for newly-created events now use valid values from the project, rather than hardcoded values.</li>
|
||||
<li>Deleting events will stay in the same events tab for easier bulk deletions.</li>
|
||||
<li>Double-clicking on a secret base event will open the corresponding secret base map.</li>
|
||||
<li>Selected events are now rendered above other events.</li>
|
||||
<li>Default values for new events are now more sensible and guaranteed to be valid.</li>
|
||||
<li><p>Fix index-out-of-bounds crash when deleting the last event in an event type group.</p></li>
|
||||
<li><p>Fix bug where exporting tileset images could add an extra row of junk at the end.</p></li>
|
||||
<li><p>Fix crashes when encountering an error opening a project or map.</p></li>
|
||||
<li><p>Fix bug where comboboxes and wild pokemon data could grow large when opening projects multiple times during the same porymap session.</p></li>
|
||||
<li><p>Fix bug where dragging the metatile selector would visually extend beyond map boundary.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id4">
|
||||
<h3>Fixed<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3>
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.2...2.0.0">2.0.0</a> - 2019-10-16<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id5">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Fix bug in zoomed metatile selector where a large selection rectangle was being rendered.</li>
|
||||
<li>Fix bug where edited map icons were not rendered properly.</li>
|
||||
<li>Fix bug where right-click copying a tile from the tileset editor’s metatile layers wouldn’t copy the x/y flip status.</li>
|
||||
<li>Parsing project data is now more resilient to crashing, and it reports more informative errors.</li>
|
||||
<li><p>Accomodate event object graphics pointer table being explicitly indexed. From changes introduced in commits <a class="reference external" href="https://github.com/pret/pokeemerald/commit/cdae0c1444bed98e652c87dc3e3edcecacfef8be">cdae0c1444bed98e652c87dc3e3edcecacfef8be</a> and <a class="reference external" href="https://github.com/pret/pokeruby/commit/0e8ccfc4fd3544001f4c25fafd401f7558bdefba">0e8ccfc4fd3544001f4c25fafd401f7558bdefba</a>.</p></li>
|
||||
<li><p>New “field” key in wild encounter JSON data from pokeemerald and pokeruby commits <a class="reference external" href="https://github.com/pret/pokeemerald/commit/adb0a444577b59eb02788c782a3d04bc285be0ba">adb0a444577b59eb02788c782a3d04bc285be0ba</a> and <a class="reference external" href="c73de8bed752ca538d90cfc93c4a9e8c7965f8c9">https://github.com/pret/pokeruby/commit/c73de8bed752ca538d90cfc93c4a9e8c7965f8c9</a>.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id5">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.0...1.2.1">1.2.1</a> - 2019-02-16<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id6">
|
||||
<h3>Added<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Add ability to zoom in and out the map metatile selector via a slider at the bottom of the metatile selector window.</li>
|
||||
<li><p>Add wild encounter table editor.</p></li>
|
||||
<li><p>Add dark themes.</p></li>
|
||||
<li><p>Support metatile labels file introduced in pokeruby and pokeemerald commits <a class="reference external" href="https://github.com/pret/pokeruby/commit/ad365a35c1536740cbcbc10bee66e5dd908c39e7">ad365a35c1536740cbcbc10bee66e5dd908c39e7</a> and <a class="reference external" href="https://github.com/pret/pokeemerald/commit/c68ba9f4e8e260f2e3389eccd15f6ee5f4bdcd3e">c68ba9f4e8e260f2e3389eccd15f6ee5f4bdcd3e</a>.</p></li>
|
||||
<li><p>Add warning when closing porymap with unsaved changes.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id7">
|
||||
<h3>Fixed<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
|
||||
<h3>Changed<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Fix crash when creating a new map from a layout that has no pre-existing maps that use it.</li>
|
||||
<li>Fix bug where <code class="docutils literal notranslate"><span class="pre">var_value</span></code>, <code class="docutils literal notranslate"><span class="pre">trainer_type</span></code> and <code class="docutils literal notranslate"><span class="pre">trainer_sight_or_berry_tree_id</span></code> JSON fields were being interpreted as integers.</li>
|
||||
<li><p>Exporting map images is now more configurable. Events, connections, collision, etc. can be toggled on and off before exporting the image.</p></li>
|
||||
<li><p>The entire Tileset Editor selection is now conveniently flipped when selecting x-flip or y-flip.</p></li>
|
||||
<li><p>Autocomplete for porymap’s comboboxes no longer require typing the full string prefix.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id8">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.1.0...1.2.0">1.2.0</a> - 2019-02-04<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id9">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3>
|
||||
<h3>Fixed<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>New JSON map data format in pokeemerald and pokeruby from commits <a class="reference external" href="https://github.com/pret/pokeemerald/commit/82abc164dc9f6a74fdf0c535cc1621b7ed05318b">82abc164dc9f6a74fdf0c535cc1621b7ed05318b</a> and <a class="reference external" href="https://github.com/pret/pokeruby/commit/a0ba1b7c6353f7e4f3066025514c05b323a0123d">a0ba1b7c6353f7e4f3066025514c05b323a0123d</a>.</li>
|
||||
<li><p>Fix bug where map group names were hardcoded when creating a new map.</p></li>
|
||||
<li><p>Fix bug in Tileset Editor where multi-tile selections weren’t properly painted when clicking on the bottom row of the metatile layers.</p></li>
|
||||
<li><p>Fix bug where line breaks in C headers were not parsed properly.</p></li>
|
||||
<li><p>Fix bug when exporting tileset images using palettes with duplicate colors.</p></li>
|
||||
<li><p>Fix bug where creating new maps from existing layouts created an empty layout folder.</p></li>
|
||||
<li><p>Fix bug where exported tile images did not contain the last row of tiles.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id9">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.1...1.2.2">1.2.2</a> - 2019-05-16<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id10">
|
||||
<h3>Added<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Add “magic fill” mode to fill tool (hold down CTRL key). This fills all matching metatiles on the map, rather than only the contiguous region.</li>
|
||||
<li>Add ability to import tileset palettes (JASC, .pal, .tpl, .gpl, .act).</li>
|
||||
<li>Add ability to export tileset tiles as indexed .png images. The currently-selected palette is used.</li>
|
||||
<li>Restore window sizes the next time the application is opened.</li>
|
||||
<li>Add ability to import metatiles from Advance Map 1.92 (.bvd files).</li>
|
||||
<li>Add About window that contains porymap information and changelog. (Found in file menu <code class="docutils literal notranslate"><span class="pre">Help</span> <span class="pre">></span> <span class="pre">About</span> <span class="pre">Porymap</span></code>)</li>
|
||||
<li>Add option to show player’s in-game view when hovering the mouse on the map.</li>
|
||||
<li>Add option to show an outline around the currently-hovered map tile. Its size depends on the size of the current metatile selection.</li>
|
||||
<li>Add ability to define custom fields for map header and all events.</li>
|
||||
<li><p>Add region map editor</p></li>
|
||||
<li><p>Add ability to add new tilesets</p></li>
|
||||
<li><p>Add official Porymap documentation website: https://huderlem.github.io/porymap/</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id11">
|
||||
<h3>Changed<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Collapse the map list by default.</li>
|
||||
<li>Collision view now has a transparency slider to help make it easier to view the underlying metatiles.</li>
|
||||
<li>When importing tileset tiles from an image that is not indexed, the user can also provide a palette for the image. This is for the scenario where the user exports tiles and a palette from Advance Map.</li>
|
||||
<li>When creating a new map, the user specifies all of the map properties in a new window prompt.</li>
|
||||
<li>New maps can be created using existing layouts by right-clicking on an existing layout folder in the map list panel when sorted by “Layout”.</li>
|
||||
<li>The map list panel now has “expand-all” and “collapse-all” buttons.</li>
|
||||
<li>Events without sprites are now partially transparent so the underlying metatile can be seen. (Warps, signs, etc.)</li>
|
||||
<li>Changed the Trainer checkbox to a combobox, since there are actually 3 valid values for the trainer type.</li>
|
||||
<li>Multiline comments are now respected when parsing C defines.</li>
|
||||
<li>The tiles image in the tileset editor will no longer flip according to the x/y flip checkboxes. The individual tile selection still flips, though.</li>
|
||||
<li><p>Event sprites now display as facing the direction of their movement type.</p></li>
|
||||
<li><p>Default values for newly-created events now use valid values from the project, rather than hardcoded values.</p></li>
|
||||
<li><p>Deleting events will stay in the same events tab for easier bulk deletions.</p></li>
|
||||
<li><p>Double-clicking on a secret base event will open the corresponding secret base map.</p></li>
|
||||
<li><p>Selected events are now rendered above other events.</p></li>
|
||||
<li><p>Default values for new events are now more sensible and guaranteed to be valid.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id12">
|
||||
<h3>Fixed<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Fix bug where smart paths could be auto-enabled, despite the checkbox being disabled.</li>
|
||||
<li>Fix crash that could occur when changing the palette id in the tileset palette editor.</li>
|
||||
<li>Fix crash that could occur when shrinking the number of metatiles in a tileset.</li>
|
||||
<li>Fix bug where exported tile images from Advance Map were not handled correctly due to Advance Map using incorrect file extensions.</li>
|
||||
<li><p>Fix bug in zoomed metatile selector where a large selection rectangle was being rendered.</p></li>
|
||||
<li><p>Fix bug where edited map icons were not rendered properly.</p></li>
|
||||
<li><p>Fix bug where right-click copying a tile from the tileset editor’s metatile layers wouldn’t copy the x/y flip status.</p></li>
|
||||
<li><p>Parsing project data is now more resilient to crashing, and it reports more informative errors.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id13">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.0.0...1.1.0">1.1.0</a> - 2018-12-27<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.2.0...1.2.1">1.2.1</a> - 2019-02-16<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id14">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3>
|
||||
<h3>Added<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>New map header format in pokeemerald from commit <a class="reference external" href="https://github.com/pret/pokeemerald/commit/a1ea3b5e394bc115ba9b86348c161094a00dcca7">a1ea3b5e394bc115ba9b86348c161094a00dcca7</a>.</li>
|
||||
<li><p>Add ability to zoom in and out the map metatile selector via a slider at the bottom of the metatile selector window.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id15">
|
||||
<h3>Added<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
|
||||
<h3>Fixed<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Add <code class="docutils literal notranslate"><span class="pre">porymap.project.cfg</span></code> config file to project repos, in order to house project-specific settings, such as <code class="docutils literal notranslate"><span class="pre">base_game_version=pokeemerald</span></code>.</li>
|
||||
<li>Write all logs to <code class="docutils literal notranslate"><span class="pre">porymap.log</span></code> file, so users can view any errors that porymap hits.</li>
|
||||
<li>Changelog</li>
|
||||
<li><p>Fix crash when creating a new map from a layout that has no pre-existing maps that use it.</p></li>
|
||||
<li><p>Fix bug where <code class="docutils literal notranslate"><span class="pre">var_value</span></code>, <code class="docutils literal notranslate"><span class="pre">trainer_type</span></code> and <code class="docutils literal notranslate"><span class="pre">trainer_sight_or_berry_tree_id</span></code> JSON fields were being interpreted as integers.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id16">
|
||||
<h3>Changed<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Add <code class="docutils literal notranslate"><span class="pre">porymap.cfg</span></code> base config file, rather than using built-in system settings (e.g. registry on Windows).</li>
|
||||
<li>Properly read/write map headers for <code class="docutils literal notranslate"><span class="pre">pokeemerald</span></code>.</li>
|
||||
<li>Overhauled event editing pane, which now contains tabs for each different event. Events of the same type can be iterated through using the spinner at the top of the tab. This makes it possible to edit events that are outside the viewing window.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.1.0...1.2.0">1.2.0</a> - 2019-02-04<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id17">
|
||||
<h3>Fixed<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3>
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li>Creating new hidden-item events now uses a valid default flag value.</li>
|
||||
<li>Fix bug where tilesets were sometimes not displaying their bottom row of metatiles.</li>
|
||||
<li>Fix bug where porymap crashes on startup due to missing map headers.</li>
|
||||
<li>Fix tileset editor crash that only happened on macOS.</li>
|
||||
<li>Fix minor bug when parsing C defines.</li>
|
||||
<li>Write <code class="docutils literal notranslate"><span class="pre">MAP_GROUPS_COUNT</span></code> define to <code class="docutils literal notranslate"><span class="pre">maps.h</span></code>.</li>
|
||||
<li>Fix bug where opening multiple projects and saving would cause junk to be written to <code class="docutils literal notranslate"><span class="pre">layouts_table.inc</span></code>.</li>
|
||||
<li>Fix porymap icon on macOS.</li>
|
||||
<li><p>New JSON map data format in pokeemerald and pokeruby from commits <a class="reference external" href="https://github.com/pret/pokeemerald/commit/82abc164dc9f6a74fdf0c535cc1621b7ed05318b">82abc164dc9f6a74fdf0c535cc1621b7ed05318b</a> and <a class="reference external" href="https://github.com/pret/pokeruby/commit/a0ba1b7c6353f7e4f3066025514c05b323a0123d">a0ba1b7c6353f7e4f3066025514c05b323a0123d</a>.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id18">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/tree/1.0.0">1.0.0</a> - 2018-10-26<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h2>
|
||||
<h3>Added<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add “magic fill” mode to fill tool (hold down CTRL key). This fills all matching metatiles on the map, rather than only the contiguous region.</p></li>
|
||||
<li><p>Add ability to import tileset palettes (JASC, .pal, .tpl, .gpl, .act).</p></li>
|
||||
<li><p>Add ability to export tileset tiles as indexed .png images. The currently-selected palette is used.</p></li>
|
||||
<li><p>Restore window sizes the next time the application is opened.</p></li>
|
||||
<li><p>Add ability to import metatiles from Advance Map 1.92 (.bvd files).</p></li>
|
||||
<li><p>Add About window that contains porymap information and changelog. (Found in file menu <code class="docutils literal notranslate"><span class="pre">Help</span> <span class="pre">></span> <span class="pre">About</span> <span class="pre">Porymap</span></code>)</p></li>
|
||||
<li><p>Add option to show player’s in-game view when hovering the mouse on the map.</p></li>
|
||||
<li><p>Add option to show an outline around the currently-hovered map tile. Its size depends on the size of the current metatile selection.</p></li>
|
||||
<li><p>Add ability to define custom fields for map header and all events.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id19">
|
||||
<h3>Changed<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Collapse the map list by default.</p></li>
|
||||
<li><p>Collision view now has a transparency slider to help make it easier to view the underlying metatiles.</p></li>
|
||||
<li><p>When importing tileset tiles from an image that is not indexed, the user can also provide a palette for the image. This is for the scenario where the user exports tiles and a palette from Advance Map.</p></li>
|
||||
<li><p>When creating a new map, the user specifies all of the map properties in a new window prompt.</p></li>
|
||||
<li><p>New maps can be created using existing layouts by right-clicking on an existing layout folder in the map list panel when sorted by “Layout”.</p></li>
|
||||
<li><p>The map list panel now has “expand-all” and “collapse-all” buttons.</p></li>
|
||||
<li><p>Events without sprites are now partially transparent so the underlying metatile can be seen. (Warps, signs, etc.)</p></li>
|
||||
<li><p>Changed the Trainer checkbox to a combobox, since there are actually 3 valid values for the trainer type.</p></li>
|
||||
<li><p>Multiline comments are now respected when parsing C defines.</p></li>
|
||||
<li><p>The tiles image in the tileset editor will no longer flip according to the x/y flip checkboxes. The individual tile selection still flips, though.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id20">
|
||||
<h3>Fixed<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Fix bug where smart paths could be auto-enabled, despite the checkbox being disabled.</p></li>
|
||||
<li><p>Fix crash that could occur when changing the palette id in the tileset palette editor.</p></li>
|
||||
<li><p>Fix crash that could occur when shrinking the number of metatiles in a tileset.</p></li>
|
||||
<li><p>Fix bug where exported tile images from Advance Map were not handled correctly due to Advance Map using incorrect file extensions.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id21">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/compare/1.0.0...1.1.0">1.1.0</a> - 2018-12-27<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="id22">
|
||||
<h3>Breaking Changes<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>New map header format in pokeemerald from commit <a class="reference external" href="https://github.com/pret/pokeemerald/commit/a1ea3b5e394bc115ba9b86348c161094a00dcca7">a1ea3b5e394bc115ba9b86348c161094a00dcca7</a>.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id23">
|
||||
<h3>Added<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add <code class="docutils literal notranslate"><span class="pre">porymap.project.cfg</span></code> config file to project repos, in order to house project-specific settings, such as <code class="docutils literal notranslate"><span class="pre">base_game_version=pokeemerald</span></code>.</p></li>
|
||||
<li><p>Write all logs to <code class="docutils literal notranslate"><span class="pre">porymap.log</span></code> file, so users can view any errors that porymap hits.</p></li>
|
||||
<li><p>Changelog</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id24">
|
||||
<h3>Changed<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Add <code class="docutils literal notranslate"><span class="pre">porymap.cfg</span></code> base config file, rather than using built-in system settings (e.g. registry on Windows).</p></li>
|
||||
<li><p>Properly read/write map headers for <code class="docutils literal notranslate"><span class="pre">pokeemerald</span></code>.</p></li>
|
||||
<li><p>Overhauled event editing pane, which now contains tabs for each different event. Events of the same type can be iterated through using the spinner at the top of the tab. This makes it possible to edit events that are outside the viewing window.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="id25">
|
||||
<h3>Fixed<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h3>
|
||||
<ul class="simple">
|
||||
<li><p>Creating new hidden-item events now uses a valid default flag value.</p></li>
|
||||
<li><p>Fix bug where tilesets were sometimes not displaying their bottom row of metatiles.</p></li>
|
||||
<li><p>Fix bug where porymap crashes on startup due to missing map headers.</p></li>
|
||||
<li><p>Fix tileset editor crash that only happened on macOS.</p></li>
|
||||
<li><p>Fix minor bug when parsing C defines.</p></li>
|
||||
<li><p>Write <code class="docutils literal notranslate"><span class="pre">MAP_GROUPS_COUNT</span></code> define to <code class="docutils literal notranslate"><span class="pre">maps.h</span></code>.</p></li>
|
||||
<li><p>Fix bug where opening multiple projects and saving would cause junk to be written to <code class="docutils literal notranslate"><span class="pre">layouts_table.inc</span></code>.</p></li>
|
||||
<li><p>Fix porymap icon on macOS.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="id26">
|
||||
<h2><a class="reference external" href="https://github.com/huderlem/porymap/tree/1.0.0">1.0.0</a> - 2018-10-26<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h2>
|
||||
<p>This was the initial release.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -21,10 +21,10 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="../_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="../_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="../_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="../_static/language_data.js"></script>
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/underscore.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/language_data.js"></script>
|
||||
|
||||
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
||||
|
||||
|
|
@ -114,14 +114,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../manual/editing-map-events.html">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -150,39 +150,51 @@
|
|||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id4">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id7">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id8">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id9">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id13">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id14">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="changelog.html#id25">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Related Projects</a></li>
|
||||
|
|
|
|||
|
|
@ -21,11 +21,11 @@
|
|||
|
||||
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
<script type="text/javascript" src="_static/searchtools.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/language_data.js"></script>
|
||||
<script src="_static/searchtools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
|
@ -114,14 +114,14 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="manual/editing-map-events.html">Editing Map Events</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#events-positions">Events Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-objects">Event Objects</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-warps">Event Warps</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-triggers">Event Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-weather-triggers">Event Weather Triggers</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-signs">Event Signs</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-hidden-item">Event Hidden Item</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-secret-base">Event Secret Base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#event-positions">Event Positions</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#object-events">Object Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#warp-events">Warp Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#trigger-events">Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#weather-trigger-events">Weather Trigger Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#sign-event">Sign Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#hidden-item-event">Hidden Item Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#secret-base-event">Secret Base Event</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#adding-deleting-events">Adding & Deleting Events</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="manual/editing-map-events.html#open-map-scripts">Open Map Scripts</a></li>
|
||||
</ul>
|
||||
|
|
@ -150,39 +150,51 @@
|
|||
<p class="caption"><span class="caption-text">Reference</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/changelog.html">Changelog</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#unreleased">Unreleased</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">3.0.1 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#fixed">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id1">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id2">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id4">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id2">3.0.0 - 2020-03-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#breaking-changes">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#added">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#changed">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id3">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id5">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id4">2.0.0 - 2019-10-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id5">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id6">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Fixed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id7">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id8">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id8">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id9">Breaking Changes</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id9">1.2.2 - 2019-05-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id10">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id11">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id12">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id15">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id16">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Fixed</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id13">1.2.1 - 2019-02-16</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id14">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id15">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id18">1.0.0 - 2018-10-26</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id16">1.2.0 - 2019-02-04</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id17">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id18">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id19">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id20">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id21">1.1.0 - 2018-12-27</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id22">Breaking Changes</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id23">Added</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id24">Changed</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="reference/changelog.html#id25">Fixed</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/changelog.html#id26">1.0.0 - 2018-10-26</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/related-projects.html">Related Projects</a></li>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -33,4 +33,4 @@ An extremely useful feature is the *Mirror to Connecting Maps* checkbox in the t
|
|||
Follow Connections
|
||||
------------------
|
||||
|
||||
Double-clicking on a connection will open the destination map. This is very useful for navigating through your maps, similar to double-clicking on :ref:`Event Warps <event-warps>`.
|
||||
Double-clicking on a connection will open the destination map. This is very useful for navigating through your maps, similar to double-clicking on :ref:`Warp Events <event-warps>`.
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@ All of the events are visible on the map. The Event Details window on the right
|
|||
.. warning::
|
||||
There is currently no undo/redo functionality when editing events! Use Git version control!
|
||||
|
||||
Events Positions
|
||||
Event Positions
|
||||
----------------
|
||||
|
||||
All events have X/Y coordinates. To move an Event, click and drag it to a new position on the map. Alternatively, you can use the X and Y spinners in the event properties.
|
||||
|
|
@ -33,18 +33,18 @@ Events also have an elevation, also known as Z coordinates (see image above). E
|
|||
|
||||
Next, we'll cover each type of event in detail.
|
||||
|
||||
Event Objects
|
||||
Object Events
|
||||
-------------
|
||||
|
||||
Event objects are typically used for NPCs (non-player-characters). More technically, it's any event that has a sprite and the ability to move around. Event objects are displayed using their assigned sprite, except for special cases. Any event object that uses a dynamic sprite will be displayed as a blue square with an `N` |dynamic-sprite|. Some examples of dynamic sprites are the player's rival and berry trees.
|
||||
Object events are typically used for NPCs (non-player-characters). More technically, it's any event that has a sprite and the ability to move around. Object events are displayed using their assigned sprite, except for special cases. Any object event that uses a dynamic sprite will be displayed as a blue square with an `N` |dynamic-sprite|. Some examples of dynamic sprites are the player's rival and berry trees.
|
||||
|
||||
.. |dynamic-sprite|
|
||||
image:: images/editing-map-events/dynamic-sprite.png
|
||||
|
||||
.. figure:: images/editing-map-events/event-object.png
|
||||
:alt: Event Object Properties
|
||||
:alt: Object Event Properties
|
||||
|
||||
Event Object Properties
|
||||
Object Event Properties
|
||||
|
||||
Id
|
||||
This is the local id of the object in the map. Some script values use this local id to specify object when using scripting commands such as `applymovement`.
|
||||
|
|
@ -72,15 +72,15 @@ Sight Radius or Berry Tree ID
|
|||
|
||||
.. _event-warps:
|
||||
|
||||
Event Warps
|
||||
Warp Events
|
||||
-----------
|
||||
|
||||
Event warps are how the player is able to warp to other maps, such as entering a building. Double-clicking on a warp will automatically open the destination map and select the destination warp. This makes it very easy to navigate around in Porymap.
|
||||
Warp events are how the player is able to warp to other maps, such as entering a building. Double-clicking on a warp will automatically open the destination map and select the destination warp. This makes it very easy to navigate around in Porymap.
|
||||
|
||||
.. figure:: images/editing-map-events/event-warp.png
|
||||
:alt: Event Warp Properties
|
||||
:alt: Warp Event Properties
|
||||
|
||||
Event Warp Properties
|
||||
Warp Event Properties
|
||||
|
||||
Id
|
||||
This is the local id of the warp in the map. This is used when setting the Destination Warp property for another warp.
|
||||
|
|
@ -91,15 +91,15 @@ Destination Map
|
|||
Destination Warp
|
||||
The Id of the warp in the destination map.
|
||||
|
||||
Event Triggers
|
||||
Trigger Events
|
||||
--------------
|
||||
|
||||
Event triggers are scripts that execute when the player walks over them. However, they only execute when a variable is equal some value. Typically, they execute once, set the variable's value to something else, and then never execute again because the variable's value no longer matches.
|
||||
Trigger events are scripts that execute when the player walks over them. However, they only execute when a variable is equal some value. Typically, they execute once, set the variable's value to something else, and then never execute again because the variable's value no longer matches.
|
||||
|
||||
.. figure:: images/editing-map-events/event-trigger.png
|
||||
:alt: Event Trigger Properties
|
||||
:alt: Trigger Event Properties
|
||||
|
||||
Event Trigger Properties
|
||||
Trigger Event Properties
|
||||
|
||||
Id
|
||||
The local id of the trigger in the map. This value is not used for anything.
|
||||
|
|
@ -113,15 +113,15 @@ Var
|
|||
Var Value
|
||||
The value that the Var must equal for the trigger's Script to execute.
|
||||
|
||||
Event Weather Triggers
|
||||
Weather Trigger Events
|
||||
----------------------
|
||||
|
||||
Event weather triggers are a very specific type of trigger. When the player walks over a weather trigger, the overworld's weather will transition to the specified weather type.
|
||||
Weather trigger events are a very specific type of trigger. When the player walks over a weather trigger, the overworld's weather will transition to the specified weather type.
|
||||
|
||||
.. figure:: images/editing-map-events/event-weather-trigger.png
|
||||
:alt: Event Weather Trigger Properties
|
||||
:alt: Weather Trigger Event Properties
|
||||
|
||||
Event Weather Trigger Properties
|
||||
Weather Trigger Event Properties
|
||||
|
||||
Id
|
||||
The local id of the trigger in the map. This value is not used for anything.
|
||||
|
|
@ -129,15 +129,15 @@ Id
|
|||
Weather
|
||||
The type of weather to transition to.
|
||||
|
||||
Event Signs
|
||||
Sign Event
|
||||
-----------
|
||||
|
||||
Event signs, or signposts, are simple interactable scripts. They are typically used for things like signs in front of buildings. The player's facing direction can be required to be a certain direction in order to interact with the sign. Signs are the first of three "BG" event types.
|
||||
Sign events, or signposts, are simple interactable scripts. They are typically used for things like signs in front of buildings. The player's facing direction can be required to be a certain direction in order to interact with the sign. Signs are the first of three "BG" event types.
|
||||
|
||||
.. figure:: images/editing-map-events/event-sign.png
|
||||
:alt: Event Sign Properties
|
||||
:alt: Sign Event Properties
|
||||
|
||||
Event Sign Properties
|
||||
Sign Event Properties
|
||||
|
||||
Id
|
||||
The local id of the BG event in the map. This value is not used for anything.
|
||||
|
|
@ -148,15 +148,15 @@ Player Facing Direction
|
|||
Script
|
||||
The script that executes when the player interacts with the sign.
|
||||
|
||||
Event Hidden Item
|
||||
Hidden Item Event
|
||||
-----------------
|
||||
|
||||
Hidden items are invisible items that can be picked up by the player. They each use a flag to ensure the item can only be picked up once.
|
||||
|
||||
.. figure:: images/editing-map-events/event-hidden-item.png
|
||||
:alt: Event Hidden Item Properties
|
||||
:alt: Hidden Item Event Properties
|
||||
|
||||
Event Hidden Item Properties
|
||||
Hidden Item Event Properties
|
||||
|
||||
Id
|
||||
The local id of the BG event in the map. This value is not used for anything.
|
||||
|
|
@ -167,15 +167,15 @@ Item
|
|||
Flag
|
||||
This flag is set when the player receives the hidden item.
|
||||
|
||||
Event Secret Base
|
||||
Secret Base Event
|
||||
-----------------
|
||||
|
||||
This is the event used to mark entrances to secret bases. This event will only be functional on certain metatiles. Unfortunately, they are hardcoded into the game's engine (see ``sSecretBaseEntranceMetatiles`` in ``src/secret_base.c``).
|
||||
|
||||
.. figure:: images/editing-map-events/event-secret-base.png
|
||||
:alt: Event Secret Base Properties
|
||||
:alt: Secret Base Event Properties
|
||||
|
||||
Event Secret Base Properties
|
||||
Secret Base Event Properties
|
||||
|
||||
Id
|
||||
The local id of the BG event in the map. This value is not used for anything.
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 2.2 KiB After Width: | Height: | Size: 2.6 KiB |
|
|
@ -7,7 +7,7 @@ About Porymap
|
|||
|
||||
**Porymap is a cross-platform map editor for the Gen 3 pret decompilation projects. Its primary functions are to allow editing map tiles, collision, events, connections, and properties. Porymap provides additional functionality, such as tileset editing and region map editing. Downloadable releases are available for Windows and Mac, and Linux users can build it from source.**
|
||||
|
||||
Those familiar with traditional Gen 3 binary ROM hacking can think of it as the Advance Map equivalent for the decompilation projects. Porymap supports the same features as Advance Map, except for Wild Pokemon editing, so Advance Map users shouldn't have much difficulty learning how to use Porymap. There are many usability improvements in Porymap. The most notable is undo/redo when painting map tiles.
|
||||
Those familiar with traditional Gen 3 binary ROM hacking can think of it as the Advance Map equivalent for the decompilation projects. Porymap supports the same features as Advance Map, so Advance Map users shouldn't have much difficulty learning how to use Porymap. There are many usability improvements in Porymap. The most notable is undo/redo when painting map tiles.
|
||||
|
||||
Porymap reads and writes files in the decompilation projects. It **does not** read or write ROM files. **Therefore, it is highly recommended to use Git for version control when working with Porymap.**
|
||||
|
||||
|
|
|
|||
|
|
@ -65,6 +65,9 @@ Header Tab
|
|||
Connections Tab
|
||||
Change how the map connects with surrounding maps when the player walks from one to another.
|
||||
|
||||
Wild Pokémon Tab
|
||||
Edit the wild Pokémon available in the map.
|
||||
|
||||
Tileset Editor
|
||||
--------------
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue