Leahnaya/porymap
1
0
Fork 0
mirror of https://github.com/huderlem/porymap.git synced 2026-08-19 15:20:41 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Marcus Huderle
2020-03-04 11:48:19 -06:00
parent 456c497d01
commit 4ab8d17c32
40 changed files with 12304 additions and 1055 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/_sources/README.md.txt Normal file
View 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
```

2
docs/_sources/manual/editing-map-connections.rst.txt
View File

@@ -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>`.

54
docs/_sources/manual/editing-map-events.rst.txt
View File

@@ -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.

2
docs/_sources/manual/introduction.rst.txt
View File

@@ -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.**

3
docs/_sources/manual/navigation.rst.txt
View File

@@ -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
--------------

4
docs/_sources/manual/project-files.rst.txt
View File

@@ -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::

45
docs/_sources/reference/CHANGELOG.md.txt
View File

@@ -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
View File

@@ -0,0 +1,3 @@
***********
Changelog
***********