From d6dfab180592288289b2ba7cf76d5cfcfca825a3 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Sat, 20 Jan 2024 22:07:52 -0500 Subject: [PATCH 01/26] Add update promoter network functions --- forms/mainwindow.ui | 19 +++++++++++---- include/mainwindow.h | 5 ++++ porymap.pro | 2 +- src/mainwindow.cpp | 57 ++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 77 insertions(+), 6 deletions(-) diff --git a/forms/mainwindow.ui b/forms/mainwindow.ui index d70180d4..ea7d340a 100644 --- a/forms/mainwindow.ui +++ b/forms/mainwindow.ui @@ -1715,7 +1715,7 @@ 0 0 100 - 30 + 16 @@ -1809,7 +1809,7 @@ 0 0 100 - 30 + 16 @@ -1903,7 +1903,7 @@ 0 0 100 - 30 + 16 @@ -2003,7 +2003,7 @@ 0 0 100 - 30 + 16 @@ -2097,7 +2097,7 @@ 0 0 100 - 30 + 16 @@ -3112,6 +3112,7 @@ + @@ -3406,6 +3407,14 @@ Custom Scripts... + + + Check for Updates... + + + QAction::ApplicationSpecificRole + + diff --git a/include/mainwindow.h b/include/mainwindow.h index e95db003..7d512ef5 100644 --- a/include/mainwindow.h +++ b/include/mainwindow.h @@ -12,6 +12,7 @@ #include #include #include +#include #include "project.h" #include "orderedjson.h" #include "config.h" @@ -288,6 +289,7 @@ private slots: void on_spinBox_SelectedCollision_valueChanged(int collision); void on_actionRegion_Map_Editor_triggered(); void on_actionPreferences_triggered(); + void on_actionCheck_for_Updates_triggered(); void togglePreferenceSpecificUi(); void on_actionProject_Settings_triggered(); void on_actionCustom_Scripts_triggered(); @@ -296,6 +298,7 @@ private slots: public: Ui::MainWindow *ui; Editor *editor = nullptr; + QPointer networkAccessManager = nullptr; private: QLabel *label_MapRulerStatus = nullptr; @@ -396,6 +399,8 @@ private: QObjectList shortcutableObjects() const; void addCustomHeaderValue(QString key, QJsonValue value, bool isNew = false); int insertTilesetLabel(QStringList * list, QString label); + + void checkForUpdates(); }; enum MapListUserRoles { diff --git a/porymap.pro b/porymap.pro index ddb3f621..90072830 100644 --- a/porymap.pro +++ b/porymap.pro @@ -4,7 +4,7 @@ # #------------------------------------------------- -QT += core gui qml +QT += core gui qml network greaterThan(QT_MAJOR_VERSION, 4): QT += widgets diff --git a/src/mainwindow.cpp b/src/mainwindow.cpp index 3a649062..7027ebca 100644 --- a/src/mainwindow.cpp +++ b/src/mainwindow.cpp @@ -242,6 +242,63 @@ void MainWindow::initExtraSignals() { label_MapRulerStatus->setAlignment(Qt::AlignCenter); label_MapRulerStatus->setTextFormat(Qt::PlainText); label_MapRulerStatus->setTextInteractionFlags(Qt::TextSelectableByMouse); + + // TODO: (if enabled) queue an automatic "Check for Updates" +} + +// TODO: Relocate +#include +#include +void MainWindow::on_actionCheck_for_Updates_triggered() { + checkForUpdates(); +} + +void MainWindow::checkForUpdates() { + if (!this->networkAccessManager) + this->networkAccessManager = new QNetworkAccessManager(this); + + // We could get ".../releases/latest" to retrieve less data, but this would run into problems if the + // most recent item on the releases page is not actually a new release (like the static windows build). + QNetworkRequest request(QUrl("https://api.github.com/repos/huderlem/porymap/releases")); + request.setHeader(QNetworkRequest::ContentTypeHeader, "application/json"); + + QNetworkReply * reply = this->networkAccessManager->get(request); + + connect(reply, &QNetworkReply::finished, [this, reply] { + QJsonDocument data = QJsonDocument::fromJson(reply->readAll()); + QJsonArray releases = data.array(); + + // Read all the items on the releases page, stopping when we find a tag that parses as a version identifier. + // Objects in the releases page data are sorted newest to oldest. Although I can't find a guarantee of this in + // GitHub's API documentation, this seems unlikely to change. + for (int i = 0; i < releases.size(); i++) { + auto release = releases.at(i).toObject(); + + const QStringList tag = release.value("tag_name").toString().split("."); + if (tag.length() != 3) continue; + + bool ok; + int major = tag.at(0).toInt(&ok); + if (!ok) continue; + int minor = tag.at(1).toInt(&ok); + if (!ok) continue; + int patch = tag.at(2).toInt(&ok); + if (!ok) continue; + + const QString downloadLink = release.value("html_url").toString(); + if (downloadLink.isEmpty()) continue; + + // We've found a valid release tag, we can stop reading. + logInfo(QString("Newest release is %1.%2.%3\n%4").arg(major).arg(minor).arg(patch).arg(downloadLink)); + + // If the release was published very recently it won't have a description yet, in which case don't tell the user. + const QString changelog = release.value("body").toString(); + if (changelog.isEmpty()) break; + + // TODO: Compare version to host version, then show appropriate dialog + break; + } + }); } void MainWindow::initEditor() { From 09c2ed6b3098591dbb09c9ef169b1be799f97d52 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Sat, 20 Jan 2024 23:02:43 -0500 Subject: [PATCH 02/26] Add check for updates setting --- forms/preferenceeditor.ui | 16 ++++++++++++++++ include/config.h | 4 ++++ include/mainwindow.h | 2 +- src/config.cpp | 12 ++++++++++++ src/mainwindow.cpp | 16 +++++++++++----- src/ui/preferenceeditor.cpp | 5 +++++ 6 files changed, 49 insertions(+), 6 deletions(-) diff --git a/forms/preferenceeditor.ui b/forms/preferenceeditor.ui index 974d6322..a7009e6e 100644 --- a/forms/preferenceeditor.ui +++ b/forms/preferenceeditor.ui @@ -26,6 +26,9 @@ + + If checked, a prompt to reload your project will appear if relevant project files are edited + Monitor project files @@ -33,11 +36,24 @@ + + If checked, Porymap will automatically open your most recently opened project on startup + Open recent project on launch + + + + If checked, Porymap will automatically alert you on startup if a new release is available + + + Automatically check for updates + + + diff --git a/include/config.h b/include/config.h index 17a19dec..17cc20d0 100644 --- a/include/config.h +++ b/include/config.h @@ -74,6 +74,7 @@ public: this->paletteEditorBitDepth = 24; this->projectSettingsTab = 0; this->warpBehaviorWarningDisabled = false; + this->checkForUpdates = true; } void addRecentProject(QString project); void setRecentProjects(QStringList projects); @@ -105,6 +106,7 @@ public: void setPaletteEditorBitDepth(int bitDepth); void setProjectSettingsTab(int tab); void setWarpBehaviorWarningDisabled(bool disabled); + void setCheckForUpdates(bool enabled); QString getRecentProject(); QStringList getRecentProjects(); bool getReopenOnLaunch(); @@ -135,6 +137,7 @@ public: int getPaletteEditorBitDepth(); int getProjectSettingsTab(); bool getWarpBehaviorWarningDisabled(); + bool getCheckForUpdates(); protected: virtual QString getConfigFilepath() override; virtual void parseConfigKeyValue(QString key, QString value) override; @@ -183,6 +186,7 @@ private: int paletteEditorBitDepth; int projectSettingsTab; bool warpBehaviorWarningDisabled; + bool checkForUpdates; }; extern PorymapConfig porymapConfig; diff --git a/include/mainwindow.h b/include/mainwindow.h index 7d512ef5..75c38fc9 100644 --- a/include/mainwindow.h +++ b/include/mainwindow.h @@ -400,7 +400,7 @@ private: void addCustomHeaderValue(QString key, QJsonValue value, bool isNew = false); int insertTilesetLabel(QStringList * list, QString label); - void checkForUpdates(); + void checkForUpdates(bool requestedByUser); }; enum MapListUserRoles { diff --git a/src/config.cpp b/src/config.cpp index 0c49605c..9cf0c54c 100644 --- a/src/config.cpp +++ b/src/config.cpp @@ -407,6 +407,8 @@ void PorymapConfig::parseConfigKeyValue(QString key, QString value) { this->projectSettingsTab = getConfigInteger(key, value, 0); } else if (key == "warp_behavior_warning_disabled") { this->warpBehaviorWarningDisabled = getConfigBool(key, value); + } else if (key == "check_for_updates") { + this->checkForUpdates = getConfigBool(key, value); } else { logWarn(QString("Invalid config key found in config file %1: '%2'").arg(this->getConfigFilepath()).arg(key)); } @@ -453,6 +455,7 @@ QMap PorymapConfig::getKeyValueMap() { map.insert("palette_editor_bit_depth", QString::number(this->paletteEditorBitDepth)); map.insert("project_settings_tab", QString::number(this->projectSettingsTab)); map.insert("warp_behavior_warning_disabled", QString::number(this->warpBehaviorWarningDisabled)); + map.insert("check_for_updates", QString::number(this->checkForUpdates)); return map; } @@ -790,6 +793,15 @@ bool PorymapConfig::getWarpBehaviorWarningDisabled() { return this->warpBehaviorWarningDisabled; } +void PorymapConfig::setCheckForUpdates(bool enabled) { + this->checkForUpdates = enabled; + this->save(); +} + +bool PorymapConfig::getCheckForUpdates() { + return this->checkForUpdates; +} + const QStringList ProjectConfig::versionStrings = { "pokeruby", "pokefirered", diff --git a/src/mainwindow.cpp b/src/mainwindow.cpp index 7027ebca..6e2ca509 100644 --- a/src/mainwindow.cpp +++ b/src/mainwindow.cpp @@ -66,6 +66,9 @@ MainWindow::MainWindow(QWidget *parent) : // there is a bug affecting macOS users, where the trackpad deilveres a bad touch-release gesture // the warning is a bit annoying, so it is disabled here QLoggingCategory::setFilterRules(QStringLiteral("qt.pointer.dispatch=false")); + + if (porymapConfig.getCheckForUpdates()) + this->checkForUpdates(false); } MainWindow::~MainWindow() @@ -242,28 +245,31 @@ void MainWindow::initExtraSignals() { label_MapRulerStatus->setAlignment(Qt::AlignCenter); label_MapRulerStatus->setTextFormat(Qt::PlainText); label_MapRulerStatus->setTextInteractionFlags(Qt::TextSelectableByMouse); - - // TODO: (if enabled) queue an automatic "Check for Updates" } // TODO: Relocate #include #include void MainWindow::on_actionCheck_for_Updates_triggered() { - checkForUpdates(); + checkForUpdates(true); } -void MainWindow::checkForUpdates() { +void MainWindow::checkForUpdates(bool requestedByUser) { if (!this->networkAccessManager) this->networkAccessManager = new QNetworkAccessManager(this); // We could get ".../releases/latest" to retrieve less data, but this would run into problems if the // most recent item on the releases page is not actually a new release (like the static windows build). - QNetworkRequest request(QUrl("https://api.github.com/repos/huderlem/porymap/releases")); + static const QUrl url("https://api.github.com/repos/huderlem/porymap/releases"); + QNetworkRequest request(url); request.setHeader(QNetworkRequest::ContentTypeHeader, "application/json"); QNetworkReply * reply = this->networkAccessManager->get(request); + if (requestedByUser) { + // TODO: Show dialog + } + connect(reply, &QNetworkReply::finished, [this, reply] { QJsonDocument data = QJsonDocument::fromJson(reply->readAll()); QJsonArray releases = data.array(); diff --git a/src/ui/preferenceeditor.cpp b/src/ui/preferenceeditor.cpp index f94c07da..eacc3f3d 100644 --- a/src/ui/preferenceeditor.cpp +++ b/src/ui/preferenceeditor.cpp @@ -49,6 +49,7 @@ void PreferenceEditor::updateFields() { ui->lineEdit_TextEditorGotoLine->setText(porymapConfig.getTextEditorGotoLine()); ui->checkBox_MonitorProjectFiles->setChecked(porymapConfig.getMonitorFiles()); ui->checkBox_OpenRecentProject->setChecked(porymapConfig.getReopenOnLaunch()); + ui->checkBox_CheckForUpdates->setChecked(porymapConfig.getCheckForUpdates()); } void PreferenceEditor::saveFields() { @@ -58,10 +59,14 @@ void PreferenceEditor::saveFields() { emit themeChanged(theme); } + porymapConfig.setSaveDisabled(true); porymapConfig.setTextEditorOpenFolder(ui->lineEdit_TextEditorOpenFolder->text()); porymapConfig.setTextEditorGotoLine(ui->lineEdit_TextEditorGotoLine->text()); porymapConfig.setMonitorFiles(ui->checkBox_MonitorProjectFiles->isChecked()); porymapConfig.setReopenOnLaunch(ui->checkBox_OpenRecentProject->isChecked()); + porymapConfig.setCheckForUpdates(ui->checkBox_CheckForUpdates->isChecked()); + porymapConfig.setSaveDisabled(false); + porymapConfig.save(); emit preferencesSaved(); } From 97b485284e49e893e3cc7dae177268305f92d234 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Sun, 21 Jan 2024 00:14:40 -0500 Subject: [PATCH 03/26] Move version info to porymap.pro --- forms/aboutporymap.ui | 3 --- include/scripting.h | 1 - include/ui/aboutporymap.h | 1 - porymap.pro | 8 ++++++++ src/mainwindow.cpp | 13 ++++++++++++- src/scriptapi/scripting.cpp | 24 ++++++------------------ src/ui/aboutporymap.cpp | 14 +------------- 7 files changed, 27 insertions(+), 37 deletions(-) diff --git a/forms/aboutporymap.ui b/forms/aboutporymap.ui index cfe22bf5..f823396c 100644 --- a/forms/aboutporymap.ui +++ b/forms/aboutporymap.ui @@ -52,9 +52,6 @@ 12 - - Version 5.3.0 - January 15th, 2024 - Qt::AlignCenter diff --git a/include/scripting.h b/include/scripting.h index 7fd2a170..fb96e7ae 100644 --- a/include/scripting.h +++ b/include/scripting.h @@ -52,7 +52,6 @@ public: static QJSValue fromBlock(Block block); static QJSValue fromTile(Tile tile); static Tile toTile(QJSValue obj); - static QJSValue version(QList versionNums); static QJSValue dimensions(int width, int height); static QJSValue position(int x, int y); static const QImage * getImage(const QString &filepath, bool useCache); diff --git a/include/ui/aboutporymap.h b/include/ui/aboutporymap.h index cc6cb6e8..28b06249 100644 --- a/include/ui/aboutporymap.h +++ b/include/ui/aboutporymap.h @@ -14,7 +14,6 @@ class AboutPorymap : public QMainWindow public: explicit AboutPorymap(QWidget *parent = nullptr); ~AboutPorymap(); - QList getVersionNumbers(); private: Ui::AboutPorymap *ui; }; diff --git a/porymap.pro b/porymap.pro index 90072830..f5cb0452 100644 --- a/porymap.pro +++ b/porymap.pro @@ -14,6 +14,14 @@ RC_ICONS = resources/icons/porymap-icon-2.ico ICON = resources/icons/porymap.icns QMAKE_CXXFLAGS += -std=c++17 -Wall QMAKE_TARGET_BUNDLE_PREFIX = com.pret +VERSION_MAJOR = 5 +VERSION_MINOR = 3 +VERSION_PATCH = 0 +VERSION = $${VERSION_MAJOR}.$${VERSION_MINOR}.$${VERSION_PATCH} +DEFINES += PORYMAP_VERSION_MAJOR=$$VERSION_MAJOR \ + PORYMAP_VERSION_MINOR=$$VERSION_MINOR \ + PORYMAP_VERSION_PATCH=$$VERSION_PATCH \ + PORYMAP_VERSION=\\\"$$VERSION\\\" SOURCES += src/core/block.cpp \ src/core/bitpacker.cpp \ diff --git a/src/mainwindow.cpp b/src/mainwindow.cpp index 6e2ca509..f98b3a30 100644 --- a/src/mainwindow.cpp +++ b/src/mainwindow.cpp @@ -53,6 +53,7 @@ MainWindow::MainWindow(QWidget *parent) : { QCoreApplication::setOrganizationName("pret"); QCoreApplication::setApplicationName("porymap"); + QCoreApplication::setApplicationVersion(PORYMAP_VERSION); QApplication::setApplicationDisplayName("porymap"); QApplication::setWindowIcon(QIcon(":/icons/porymap-icon-2.ico")); ui->setupUi(this); @@ -301,7 +302,17 @@ void MainWindow::checkForUpdates(bool requestedByUser) { const QString changelog = release.value("body").toString(); if (changelog.isEmpty()) break; - // TODO: Compare version to host version, then show appropriate dialog + bool newVersionAvailable; + if (major != PORYMAP_VERSION_MAJOR) { + newVersionAvailable = major > PORYMAP_VERSION_MAJOR; + } else if (minor != PORYMAP_VERSION_MINOR) { + newVersionAvailable = minor > PORYMAP_VERSION_MINOR; + } else { + newVersionAvailable = patch > PORYMAP_VERSION_PATCH; + } + logInfo(QString("Host version is %1").arg(newVersionAvailable ? "old" : "up to date")); + + // TODO: Show appropriate dialog break; } }); diff --git a/src/scriptapi/scripting.cpp b/src/scriptapi/scripting.cpp index 626f820b..aa547724 100644 --- a/src/scriptapi/scripting.cpp +++ b/src/scriptapi/scripting.cpp @@ -1,7 +1,6 @@ #include "scripting.h" #include "log.h" #include "config.h" -#include "aboutporymap.h" QMap callbackFunctions = { {OnProjectOpened, "onProjectOpened"}, @@ -77,15 +76,12 @@ void Scripting::populateGlobalObject(MainWindow *mainWindow) { QJSValue constants = instance->engine->newObject(); - // Invisibly create an "About" window to read Porymap version - AboutPorymap *about = new AboutPorymap(mainWindow); - if (about) { - QJSValue version = Scripting::version(about->getVersionNumbers()); - constants.setProperty("version", version); - delete about; - } else { - logError("Failed to read Porymap version for API"); - } + // Get version numbers + QJSValue version = instance->engine->newObject(); + version.setProperty("major", PORYMAP_VERSION_MAJOR); + version.setProperty("minor", PORYMAP_VERSION_MINOR); + version.setProperty("patch", PORYMAP_VERSION_PATCH); + constants.setProperty("version", version); // Get basic tileset information int numTilesPrimary = Project::getNumTilesPrimary(); @@ -343,14 +339,6 @@ QJSValue Scripting::position(int x, int y) { return obj; } -QJSValue Scripting::version(QList versionNums) { - QJSValue obj = instance->engine->newObject(); - obj.setProperty("major", versionNums.at(0)); - obj.setProperty("minor", versionNums.at(1)); - obj.setProperty("patch", versionNums.at(2)); - return obj; -} - Tile Scripting::toTile(QJSValue obj) { Tile tile = Tile(); diff --git a/src/ui/aboutporymap.cpp b/src/ui/aboutporymap.cpp index ce0a1fe4..96f20ee8 100644 --- a/src/ui/aboutporymap.cpp +++ b/src/ui/aboutporymap.cpp @@ -8,6 +8,7 @@ AboutPorymap::AboutPorymap(QWidget *parent) : { ui->setupUi(this); + this->ui->label_Version->setText(QString("Version %1 - %2").arg(PORYMAP_VERSION).arg(QStringLiteral(__DATE__))); this->ui->textBrowser->setSource(QUrl("qrc:/CHANGELOG.md")); } @@ -15,16 +16,3 @@ AboutPorymap::~AboutPorymap() { delete ui; } - -// Returns the Porymap version number as a list of ints with the order {major, minor, patch} -QList AboutPorymap::getVersionNumbers() -{ - // Get the version string "#.#.#" - static const QRegularExpression regex("Version (\\d+)\\.(\\d+)\\.(\\d+)"); - QRegularExpressionMatch match = regex.match(ui->label_Version->text()); - if (!match.hasMatch()) { - logError("Failed to locate Porymap version text"); - return QList({0, 0, 0}); - } - return QList({match.captured(1).toInt(), match.captured(2).toInt(), match.captured(3).toInt()}); -} From c04a89396c139d1cadf1e13cc96458b61e2363d2 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Sun, 21 Jan 2024 02:00:28 -0500 Subject: [PATCH 04/26] Add update promoter dialog --- forms/updatepromoter.ui | 104 +++++++++++++++++++++ include/mainwindow.h | 4 +- include/ui/updatepromoter.h | 44 +++++++++ porymap.pro | 9 +- src/mainwindow.cpp | 70 +++----------- src/ui/updatepromoter.cpp | 177 ++++++++++++++++++++++++++++++++++++ 6 files changed, 346 insertions(+), 62 deletions(-) create mode 100644 forms/updatepromoter.ui create mode 100644 include/ui/updatepromoter.h create mode 100644 src/ui/updatepromoter.cpp diff --git a/forms/updatepromoter.ui b/forms/updatepromoter.ui new file mode 100644 index 00000000..cbb4e8be --- /dev/null +++ b/forms/updatepromoter.ui @@ -0,0 +1,104 @@ + + + UpdatePromoter + + + + 0 + 0 + 592 + 484 + + + + Porymap Version Update + + + + + + QFrame::StyledPanel + + + QFrame::Raised + + + + + + + + + true + + + + + + + <html><head/><body><p><span style=" font-size:13pt; color:#d7000c;">WARNING: </span><span style=" font-weight:400;">Updating Porymap may require you to update your projects. See "Breaking Changes" in the Changelog for details.</span></p></body></html> + + + true + + + + + + + + 0 + 0 + + + + QFrame::NoFrame + + + QFrame::Plain + + + + 0 + + + 0 + + + 0 + + + 0 + + + + + true + + + + + + + + + + Do not alert me about new updates + + + + + + + + + + QDialogButtonBox::Close|QDialogButtonBox::Retry + + + + + + + + diff --git a/include/mainwindow.h b/include/mainwindow.h index 75c38fc9..c499a5ba 100644 --- a/include/mainwindow.h +++ b/include/mainwindow.h @@ -28,6 +28,7 @@ #include "preferenceeditor.h" #include "projectsettingseditor.h" #include "customscriptseditor.h" +#include "updatepromoter.h" @@ -298,7 +299,6 @@ private slots: public: Ui::MainWindow *ui; Editor *editor = nullptr; - QPointer networkAccessManager = nullptr; private: QLabel *label_MapRulerStatus = nullptr; @@ -310,6 +310,8 @@ private: QPointer preferenceEditor = nullptr; QPointer projectSettingsEditor = nullptr; QPointer customScriptsEditor = nullptr; + QPointer updatePromoter = nullptr; + QPointer networkAccessManager = nullptr; FilterChildrenProxyModel *mapListProxyModel; QStandardItemModel *mapListModel; QList *mapGroupItemsList; diff --git a/include/ui/updatepromoter.h b/include/ui/updatepromoter.h new file mode 100644 index 00000000..4b0f209d --- /dev/null +++ b/include/ui/updatepromoter.h @@ -0,0 +1,44 @@ +#ifndef UPDATEPROMOTER_H +#define UPDATEPROMOTER_H + +#include +#include +#include +#include + +namespace Ui { +class UpdatePromoter; +} + +class UpdatePromoter : public QDialog +{ + Q_OBJECT + +public: + explicit UpdatePromoter(QWidget *parent, QNetworkAccessManager *manager); + ~UpdatePromoter() {}; + + void checkForUpdates(); + void requestDialog(); + void updatePreferences(); + +private: + Ui::UpdatePromoter *ui; + QNetworkAccessManager *const manager; + QNetworkReply * reply = nullptr; + QPushButton * button_Downloads; + QString downloadLink; + QString changelog; + + void resetDialog(); + void processWebpage(const QJsonDocument &data); + void processError(const QString &err); + +private slots: + void dialogButtonClicked(QAbstractButton *button); + +signals: + void changedPreferences(); +}; + +#endif // UPDATEPROMOTER_H diff --git a/porymap.pro b/porymap.pro index f5cb0452..4e883b39 100644 --- a/porymap.pro +++ b/porymap.pro @@ -110,7 +110,8 @@ SOURCES += src/core/block.cpp \ src/project.cpp \ src/settings.cpp \ src/log.cpp \ - src/ui/uintspinbox.cpp + src/ui/uintspinbox.cpp \ + src/ui/updatepromoter.cpp HEADERS += include/core/block.h \ include/core/bitpacker.h \ @@ -204,7 +205,8 @@ HEADERS += include/core/block.h \ include/scriptutility.h \ include/settings.h \ include/log.h \ - include/ui/uintspinbox.h + include/ui/uintspinbox.h \ + include/ui/updatepromoter.h FORMS += forms/mainwindow.ui \ forms/prefabcreationdialog.ui \ @@ -222,7 +224,8 @@ FORMS += forms/mainwindow.ui \ forms/colorpicker.ui \ forms/projectsettingseditor.ui \ forms/customscriptseditor.ui \ - forms/customscriptslistitem.ui + forms/customscriptslistitem.ui \ + forms/updatepromoter.ui RESOURCES += \ resources/images.qrc \ diff --git a/src/mainwindow.cpp b/src/mainwindow.cpp index f98b3a30..9fd45720 100644 --- a/src/mainwindow.cpp +++ b/src/mainwindow.cpp @@ -248,9 +248,6 @@ void MainWindow::initExtraSignals() { label_MapRulerStatus->setTextInteractionFlags(Qt::TextSelectableByMouse); } -// TODO: Relocate -#include -#include void MainWindow::on_actionCheck_for_Updates_triggered() { checkForUpdates(true); } @@ -259,63 +256,17 @@ void MainWindow::checkForUpdates(bool requestedByUser) { if (!this->networkAccessManager) this->networkAccessManager = new QNetworkAccessManager(this); - // We could get ".../releases/latest" to retrieve less data, but this would run into problems if the - // most recent item on the releases page is not actually a new release (like the static windows build). - static const QUrl url("https://api.github.com/repos/huderlem/porymap/releases"); - QNetworkRequest request(url); - request.setHeader(QNetworkRequest::ContentTypeHeader, "application/json"); - - QNetworkReply * reply = this->networkAccessManager->get(request); - - if (requestedByUser) { - // TODO: Show dialog + if (!this->updatePromoter) { + this->updatePromoter = new UpdatePromoter(this, this->networkAccessManager); + connect(this->updatePromoter, &UpdatePromoter::changedPreferences, [this] { + if (this->preferenceEditor) + this->preferenceEditor->updateFields(); + }); } - connect(reply, &QNetworkReply::finished, [this, reply] { - QJsonDocument data = QJsonDocument::fromJson(reply->readAll()); - QJsonArray releases = data.array(); - - // Read all the items on the releases page, stopping when we find a tag that parses as a version identifier. - // Objects in the releases page data are sorted newest to oldest. Although I can't find a guarantee of this in - // GitHub's API documentation, this seems unlikely to change. - for (int i = 0; i < releases.size(); i++) { - auto release = releases.at(i).toObject(); - - const QStringList tag = release.value("tag_name").toString().split("."); - if (tag.length() != 3) continue; - - bool ok; - int major = tag.at(0).toInt(&ok); - if (!ok) continue; - int minor = tag.at(1).toInt(&ok); - if (!ok) continue; - int patch = tag.at(2).toInt(&ok); - if (!ok) continue; - - const QString downloadLink = release.value("html_url").toString(); - if (downloadLink.isEmpty()) continue; - - // We've found a valid release tag, we can stop reading. - logInfo(QString("Newest release is %1.%2.%3\n%4").arg(major).arg(minor).arg(patch).arg(downloadLink)); - - // If the release was published very recently it won't have a description yet, in which case don't tell the user. - const QString changelog = release.value("body").toString(); - if (changelog.isEmpty()) break; - - bool newVersionAvailable; - if (major != PORYMAP_VERSION_MAJOR) { - newVersionAvailable = major > PORYMAP_VERSION_MAJOR; - } else if (minor != PORYMAP_VERSION_MINOR) { - newVersionAvailable = minor > PORYMAP_VERSION_MINOR; - } else { - newVersionAvailable = patch > PORYMAP_VERSION_PATCH; - } - logInfo(QString("Host version is %1").arg(newVersionAvailable ? "old" : "up to date")); - - // TODO: Show appropriate dialog - break; - } - }); + if (requestedByUser) + this->updatePromoter->requestDialog(); + this->updatePromoter->checkForUpdates(); } void MainWindow::initEditor() { @@ -2812,6 +2763,9 @@ void MainWindow::togglePreferenceSpecificUi() { ui->actionOpen_Project_in_Text_Editor->setEnabled(false); else ui->actionOpen_Project_in_Text_Editor->setEnabled(true); + + if (this->updatePromoter) + this->updatePromoter->updatePreferences(); } void MainWindow::openProjectSettingsEditor(int tab) { diff --git a/src/ui/updatepromoter.cpp b/src/ui/updatepromoter.cpp new file mode 100644 index 00000000..c7dc9de7 --- /dev/null +++ b/src/ui/updatepromoter.cpp @@ -0,0 +1,177 @@ +#include "updatepromoter.h" +#include "ui_updatepromoter.h" +#include "log.h" +#include "config.h" + +#include +#include +#include +#include +#include + +UpdatePromoter::UpdatePromoter(QWidget *parent, QNetworkAccessManager *manager) + : QDialog(parent), + ui(new Ui::UpdatePromoter), + manager(manager) +{ + ui->setupUi(this); + + // Set up "Do not alert me" check box + this->updatePreferences(); + connect(ui->checkBox_StopAlerts, &QCheckBox::stateChanged, [this](int state) { + bool enable = (state != Qt::Checked); + porymapConfig.setCheckForUpdates(enable); + emit this->changedPreferences(); + }); + + // Set up button box + this->button_Downloads = ui->buttonBox->addButton("Go to Downloads...", QDialogButtonBox::ActionRole); + connect(ui->buttonBox, &QDialogButtonBox::clicked, this, &UpdatePromoter::dialogButtonClicked); + + this->resetDialog(); +} + +void UpdatePromoter::resetDialog() { + this->button_Downloads->setEnabled(false); + ui->text_Changelog->setVisible(false); + ui->label_Warning->setVisible(false); + ui->label_Status->setText("Checking for updates..."); + + this->changelog = QString(); + this->downloadLink = QString(); +} + +void UpdatePromoter::checkForUpdates() { + // Ignore request if one is still active. + if (this->reply && !this->reply->isFinished()) + return; + this->resetDialog(); + ui->buttonBox->button(QDialogButtonBox::Retry)->setEnabled(false); + + // We could get ".../releases/latest" to retrieve less data, but this would run into problems if the + // most recent item on the releases page is not actually a new release (like the static windows build). + // By getting all releases we can also present a multi-version changelog of all changes since the host release. + static const QNetworkRequest request(QUrl("https://api.github.com/repos/huderlem/porymap/releases")); + this->reply = this->manager->get(request); + + connect(this->reply, &QNetworkReply::finished, [this] { + ui->buttonBox->button(QDialogButtonBox::Retry)->setEnabled(true); + auto error = this->reply->error(); + if (error == QNetworkReply::NoError) { + this->processWebpage(QJsonDocument::fromJson(this->reply->readAll())); + } else { + this->processError(this->reply->errorString()); + } + }); +} + +// Read all the items on the releases page, ignoring entries without a version identifier tag. +// Objects in the releases page data are sorted newest to oldest. +void UpdatePromoter::processWebpage(const QJsonDocument &data) { + bool updateAvailable = false; + bool breakingChanges = false; + bool foundRelease = false; + + const QJsonArray releases = data.array(); + for (int i = 0; i < releases.size(); i++) { + auto release = releases.at(i).toObject(); + + // Convert tag string to version numbers + const QString tagName = release.value("tag_name").toString(); + const QStringList tag = tagName.split("."); + if (tag.length() != 3) continue; + bool ok; + int major = tag.at(0).toInt(&ok); + if (!ok) continue; + int minor = tag.at(1).toInt(&ok); + if (!ok) continue; + int patch = tag.at(2).toInt(&ok); + if (!ok) continue; + + // We've found a valid release tag. If the version number is not newer than the host version then we can stop looking at releases. + foundRelease = true; + logInfo(QString("Found release %1.%2.%3").arg(major).arg(minor).arg(patch)); // TODO: Remove + if (major <= PORYMAP_VERSION_MAJOR && minor <= PORYMAP_VERSION_MINOR && patch <= PORYMAP_VERSION_PATCH) + break; + + const QString description = release.value("body").toString(); + const QString url = release.value("html_url").toString(); + if (description.isEmpty() || url.isEmpty()) { + // If the release was published very recently it won't have a description yet, in which case don't tell the user about it yet. + // If there's no URL, something has gone wrong and we should skip this release. + continue; + } + + if (this->downloadLink.isEmpty()) { + // This is the first (newest) release we've found. Record its URL for download. + this->downloadLink = url; + breakingChanges = (major > PORYMAP_VERSION_MAJOR); + } + + // Record the changelog of this release so we can show all changes since the host release. + this->changelog.append(QString("## %1\n%2\n\n").arg(tagName).arg(description)); + updateAvailable = true; + } + + if (!foundRelease) { + // We retrieved the webpage but didn't successfully parse any releases. + this->processError("Error parsing releases webpage"); + return; + } + + // If there's a new update available the dialog will always be opened. + // Otherwise the dialog is only open if the user requested it. + if (updateAvailable) { + this->button_Downloads->setEnabled(!this->downloadLink.isEmpty()); + ui->text_Changelog->setMarkdown(this->changelog); + ui->text_Changelog->setVisible(true); + ui->label_Warning->setVisible(breakingChanges); + ui->label_Status->setText("A new version of Porymap is available!"); + this->show(); + } else { + // The rest of the UI remains in the state set by resetDialog + ui->label_Status->setText("Your version of Porymap is up to date!"); + } +} + +void UpdatePromoter::processError(const QString &err) { + const QString message = QString("Failed to check for version update: %1").arg(err); + if (this->isVisible()) { + ui->label_Status->setText(message); + } else { + logWarn(message); + } +} + +// The dialog can either be shown programmatically when an update is available +// or if the user manually selects "Check for Updates" in the menu. +// When the dialog is shown programmatically there is a check box to disable automatic alerts. +// If the user requested the dialog (and it wasn't already open) this check box should be hidden. +void UpdatePromoter::requestDialog() { + if (!this->isVisible()){ + ui->checkBox_StopAlerts->setVisible(false); + this->show(); + } else if (this->isMinimized()) { + this->showNormal(); + } else { + this->raise(); + this->activateWindow(); + } +} + +void UpdatePromoter::updatePreferences() { + const QSignalBlocker blocker(ui->checkBox_StopAlerts); + ui->checkBox_StopAlerts->setChecked(porymapConfig.getCheckForUpdates()); +} + +void UpdatePromoter::dialogButtonClicked(QAbstractButton *button) { + auto buttonRole = ui->buttonBox->buttonRole(button); + if (buttonRole == QDialogButtonBox::RejectRole) { + this->close(); + } else if (buttonRole == QDialogButtonBox::AcceptRole) { + // "Retry" button + this->checkForUpdates(); + } else if (button == this->button_Downloads && !this->downloadLink.isEmpty()) { + QDesktopServices::openUrl(QUrl(this->downloadLink)); + } +} From fec1d1fdd4c544ccb965263ea64e6b294ae421bf Mon Sep 17 00:00:00 2001 From: GriffinR Date: Sun, 21 Jan 2024 12:09:23 -0500 Subject: [PATCH 05/26] Remove debug log --- src/ui/updatepromoter.cpp | 1 - 1 file changed, 1 deletion(-) diff --git a/src/ui/updatepromoter.cpp b/src/ui/updatepromoter.cpp index c7dc9de7..5d91d271 100644 --- a/src/ui/updatepromoter.cpp +++ b/src/ui/updatepromoter.cpp @@ -90,7 +90,6 @@ void UpdatePromoter::processWebpage(const QJsonDocument &data) { // We've found a valid release tag. If the version number is not newer than the host version then we can stop looking at releases. foundRelease = true; - logInfo(QString("Found release %1.%2.%3").arg(major).arg(minor).arg(patch)); // TODO: Remove if (major <= PORYMAP_VERSION_MAJOR && minor <= PORYMAP_VERSION_MINOR && patch <= PORYMAP_VERSION_PATCH) break; From 58e4a21aa6fe68b49438812a5a1df0dd02616850 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Sun, 21 Jan 2024 18:41:23 -0500 Subject: [PATCH 06/26] Revert oversimplified version check --- include/ui/updatepromoter.h | 1 + src/ui/updatepromoter.cpp | 10 +++++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/include/ui/updatepromoter.h b/include/ui/updatepromoter.h index 4b0f209d..b9129156 100644 --- a/include/ui/updatepromoter.h +++ b/include/ui/updatepromoter.h @@ -33,6 +33,7 @@ private: void resetDialog(); void processWebpage(const QJsonDocument &data); void processError(const QString &err); + bool isNewerVersion(int major, int minor, int patch); private slots: void dialogButtonClicked(QAbstractButton *button); diff --git a/src/ui/updatepromoter.cpp b/src/ui/updatepromoter.cpp index 5d91d271..f8270b4e 100644 --- a/src/ui/updatepromoter.cpp +++ b/src/ui/updatepromoter.cpp @@ -90,7 +90,7 @@ void UpdatePromoter::processWebpage(const QJsonDocument &data) { // We've found a valid release tag. If the version number is not newer than the host version then we can stop looking at releases. foundRelease = true; - if (major <= PORYMAP_VERSION_MAJOR && minor <= PORYMAP_VERSION_MINOR && patch <= PORYMAP_VERSION_PATCH) + if (!this->isNewerVersion(major, minor, patch)) break; const QString description = release.value("body").toString(); @@ -142,6 +142,14 @@ void UpdatePromoter::processError(const QString &err) { } } +bool UpdatePromoter::isNewerVersion(int major, int minor, int patch) { + if (major != PORYMAP_VERSION_MAJOR) + return major > PORYMAP_VERSION_MAJOR; + if (minor != PORYMAP_VERSION_MINOR) + return minor > PORYMAP_VERSION_MINOR; + return patch > PORYMAP_VERSION_PATCH; +} + // The dialog can either be shown programmatically when an update is available // or if the user manually selects "Check for Updates" in the menu. // When the dialog is shown programmatically there is a check box to disable automatic alerts. From 34b2f9d881b0f1a5ed5a7e6d3111d4c79b48ffba Mon Sep 17 00:00:00 2001 From: GriffinR Date: Sun, 21 Jan 2024 19:18:26 -0500 Subject: [PATCH 07/26] Allow update checking with no project --- src/mainwindow.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/src/mainwindow.cpp b/src/mainwindow.cpp index 9fd45720..84c7fd43 100644 --- a/src/mainwindow.cpp +++ b/src/mainwindow.cpp @@ -95,6 +95,7 @@ void MainWindow::setWindowDisabled(bool disabled) { ui->actionAbout_Porymap->setDisabled(false); ui->actionOpen_Log_File->setDisabled(false); ui->actionOpen_Config_Folder->setDisabled(false); + ui->actionCheck_for_Updates->setDisabled(false); if (!disabled) togglePreferenceSpecificUi(); } From a5ed554c686029dc706de3767ec2541e0cf821e0 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Wed, 24 Jan 2024 11:56:04 -0500 Subject: [PATCH 08/26] Better client etiquette --- include/config.h | 10 +++ include/core/network.h | 87 +++++++++++++++++++ include/mainwindow.h | 3 +- include/ui/updatepromoter.h | 24 ++++-- porymap.pro | 2 + src/config.cpp | 53 +++++++++--- src/core/network.cpp | 146 ++++++++++++++++++++++++++++++++ src/mainwindow.cpp | 15 +++- src/ui/updatepromoter.cpp | 161 +++++++++++++++++++----------------- 9 files changed, 403 insertions(+), 98 deletions(-) create mode 100644 include/core/network.h create mode 100644 src/core/network.cpp diff --git a/include/config.h b/include/config.h index 17cc20d0..485e97eb 100644 --- a/include/config.h +++ b/include/config.h @@ -8,6 +8,8 @@ #include #include #include +#include +#include #include "events.h" @@ -75,6 +77,8 @@ public: this->projectSettingsTab = 0; this->warpBehaviorWarningDisabled = false; this->checkForUpdates = true; + this->lastUpdateCheckTime = QDateTime(); + this->rateLimitTimes.clear(); } void addRecentProject(QString project); void setRecentProjects(QStringList projects); @@ -107,6 +111,8 @@ public: void setProjectSettingsTab(int tab); void setWarpBehaviorWarningDisabled(bool disabled); void setCheckForUpdates(bool enabled); + void setLastUpdateCheckTime(QDateTime time); + void setRateLimitTimes(QMap map); QString getRecentProject(); QStringList getRecentProjects(); bool getReopenOnLaunch(); @@ -138,6 +144,8 @@ public: int getProjectSettingsTab(); bool getWarpBehaviorWarningDisabled(); bool getCheckForUpdates(); + QDateTime getLastUpdateCheckTime(); + QMap getRateLimitTimes(); protected: virtual QString getConfigFilepath() override; virtual void parseConfigKeyValue(QString key, QString value) override; @@ -187,6 +195,8 @@ private: int projectSettingsTab; bool warpBehaviorWarningDisabled; bool checkForUpdates; + QDateTime lastUpdateCheckTime; + QMap rateLimitTimes; }; extern PorymapConfig porymapConfig; diff --git a/include/core/network.h b/include/core/network.h new file mode 100644 index 00000000..321b3e99 --- /dev/null +++ b/include/core/network.h @@ -0,0 +1,87 @@ +#ifndef NETWORK_H +#define NETWORK_H + +/* + The two classes defined here provide a simplified interface for Qt's network classes QNetworkAccessManager and QNetworkReply. + + With the Qt classes, the workflow for a GET is roughly: generate a QNetworkRequest, give this request to QNetworkAccessManager::get, + connect the returned object to QNetworkReply::finished, and in the slot of that connection handle the various HTTP headers and attributes, + then manage errors or process the webpage's body. + + These classes handle generating the QNetworkRequest with a given URL and manage the HTTP headers in the reply. They will automatically + respect rate limits and return cached data if the webpage hasn't changed since previous requests. Instead of interacting with a QNetworkReply, + callers interact with a simplified NetworkReplyData. + Example that logs Porymap's description on GitHub: + + NetworkAccessManager * manager = new NetworkAccessManager(this); + NetworkReplyData * reply = manager->get("https://api.github.com/repos/huderlem/porymap"); + connect(reply, &NetworkReplyData::finished, [reply] () { + if (!reply->errorString().isEmpty()) { + logError(QString("Failed to read description: %1").arg(reply->errorString())); + } else { + auto webpage = QJsonDocument::fromJson(reply->body()); + logInfo(QString("Porymap: %1").arg(webpage["description"].toString())); + } + reply->deleteLater(); + }); +*/ + +#include +#include +#include +#include + +class NetworkReplyData : public QObject +{ + Q_OBJECT + +public: + QUrl url() const { return m_url; } + QUrl nextUrl() const { return m_nextUrl; } + QByteArray body() const { return m_body; } + QString errorString() const { return m_error; } + QDateTime retryAfter() const { return m_retryAfter; } + bool isFinished() const { return m_finished; } + + friend class NetworkAccessManager; + +private: + QUrl m_url; + QUrl m_nextUrl; + QByteArray m_body; + QString m_error; + QDateTime m_retryAfter; + bool m_finished; + + void finish() { + m_finished = true; + emit finished(); + }; + +signals: + void finished(); +}; + +class NetworkAccessManager : public QNetworkAccessManager +{ + Q_OBJECT + +public: + NetworkAccessManager(QObject * parent = nullptr); + ~NetworkAccessManager(); + NetworkReplyData * get(const QString &url); + NetworkReplyData * get(const QUrl &url); + +private: + // For a more complex cache we could implement a QAbstractCache for the manager + struct CacheEntry { + QString eTag; + QByteArray data; + }; + QMap cache; + QMap rateLimitTimes; + void processReply(QNetworkReply * reply, NetworkReplyData * data); + const QNetworkRequest getRequest(const QUrl &url); +}; + +#endif // NETWORK_H diff --git a/include/mainwindow.h b/include/mainwindow.h index c499a5ba..29052fd3 100644 --- a/include/mainwindow.h +++ b/include/mainwindow.h @@ -12,7 +12,6 @@ #include #include #include -#include #include "project.h" #include "orderedjson.h" #include "config.h" @@ -311,7 +310,7 @@ private: QPointer projectSettingsEditor = nullptr; QPointer customScriptsEditor = nullptr; QPointer updatePromoter = nullptr; - QPointer networkAccessManager = nullptr; + QPointer networkAccessManager = nullptr; FilterChildrenProxyModel *mapListProxyModel; QStandardItemModel *mapListModel; QList *mapGroupItemsList; diff --git a/include/ui/updatepromoter.h b/include/ui/updatepromoter.h index b9129156..4465e0dc 100644 --- a/include/ui/updatepromoter.h +++ b/include/ui/updatepromoter.h @@ -1,10 +1,10 @@ #ifndef UPDATEPROMOTER_H #define UPDATEPROMOTER_H +#include "network.h" + #include #include -#include -#include namespace Ui { class UpdatePromoter; @@ -15,24 +15,30 @@ class UpdatePromoter : public QDialog Q_OBJECT public: - explicit UpdatePromoter(QWidget *parent, QNetworkAccessManager *manager); + explicit UpdatePromoter(QWidget *parent, NetworkAccessManager *manager); ~UpdatePromoter() {}; void checkForUpdates(); - void requestDialog(); void updatePreferences(); private: Ui::UpdatePromoter *ui; - QNetworkAccessManager *const manager; - QNetworkReply * reply = nullptr; + NetworkAccessManager *const manager; QPushButton * button_Downloads; - QString downloadLink; + QPushButton * button_Retry; + QString changelog; + QUrl downloadUrl; + bool breakingChanges; + bool foundReleases; + + QSet visitedUrls; // Prevent infinite redirection void resetDialog(); - void processWebpage(const QJsonDocument &data); - void processError(const QString &err); + void get(const QUrl &url); + void processWebpage(const QJsonDocument &data, const QUrl &nextUrl); + void disableRequestsUntil(const QDateTime time); + void error(const QString &err); bool isNewerVersion(int major, int minor, int patch); private slots: diff --git a/porymap.pro b/porymap.pro index 4e883b39..cf4cc451 100644 --- a/porymap.pro +++ b/porymap.pro @@ -34,6 +34,7 @@ SOURCES += src/core/block.cpp \ src/core/mapparser.cpp \ src/core/metatile.cpp \ src/core/metatileparser.cpp \ + src/core/network.cpp \ src/core/paletteutil.cpp \ src/core/parseutil.cpp \ src/core/tile.cpp \ @@ -126,6 +127,7 @@ HEADERS += include/core/block.h \ include/core/mapparser.h \ include/core/metatile.h \ include/core/metatileparser.h \ + include/core/network.h \ include/core/paletteutil.h \ include/core/parseutil.h \ include/core/tile.h \ diff --git a/src/config.cpp b/src/config.cpp index 9cf0c54c..967c21c8 100644 --- a/src/config.cpp +++ b/src/config.cpp @@ -409,6 +409,14 @@ void PorymapConfig::parseConfigKeyValue(QString key, QString value) { this->warpBehaviorWarningDisabled = getConfigBool(key, value); } else if (key == "check_for_updates") { this->checkForUpdates = getConfigBool(key, value); + } else if (key == "last_update_check_time") { + this->lastUpdateCheckTime = QDateTime::fromString(value).toLocalTime(); + } else if (key.startsWith("rate_limit_time/")) { + static const QRegularExpression regex("\\brate_limit_time/(?.+)"); + QRegularExpressionMatch match = regex.match(key); + if (match.hasMatch()) { + this->rateLimitTimes.insert(match.captured("url"), QDateTime::fromString(value).toLocalTime()); + } } else { logWarn(QString("Invalid config key found in config file %1: '%2'").arg(this->getConfigFilepath()).arg(key)); } @@ -456,6 +464,13 @@ QMap PorymapConfig::getKeyValueMap() { map.insert("project_settings_tab", QString::number(this->projectSettingsTab)); map.insert("warp_behavior_warning_disabled", QString::number(this->warpBehaviorWarningDisabled)); map.insert("check_for_updates", QString::number(this->checkForUpdates)); + map.insert("last_update_check_time", this->lastUpdateCheckTime.toUTC().toString()); + for (auto i = this->rateLimitTimes.cbegin(), end = this->rateLimitTimes.cend(); i != end; i++){ + // Only include rate limit times that are still active (i.e., in the future) + const QDateTime time = i.value(); + if (!time.isNull() && time > QDateTime::currentDateTime()) + map.insert("rate_limit_time/" + i.key().toString(), time.toUTC().toString()); + } return map; } @@ -634,6 +649,26 @@ void PorymapConfig::setProjectSettingsTab(int tab) { this->save(); } +void PorymapConfig::setWarpBehaviorWarningDisabled(bool disabled) { + this->warpBehaviorWarningDisabled = disabled; + this->save(); +} + +void PorymapConfig::setCheckForUpdates(bool enabled) { + this->checkForUpdates = enabled; + this->save(); +} + +void PorymapConfig::setLastUpdateCheckTime(QDateTime time) { + this->lastUpdateCheckTime = time; + this->save(); +} + +void PorymapConfig::setRateLimitTimes(QMap map) { + this->rateLimitTimes = map; + this->save(); +} + QString PorymapConfig::getRecentProject() { return this->recentProjects.value(0); } @@ -784,24 +819,22 @@ int PorymapConfig::getProjectSettingsTab() { return this->projectSettingsTab; } -void PorymapConfig::setWarpBehaviorWarningDisabled(bool disabled) { - this->warpBehaviorWarningDisabled = disabled; - this->save(); -} - bool PorymapConfig::getWarpBehaviorWarningDisabled() { return this->warpBehaviorWarningDisabled; } -void PorymapConfig::setCheckForUpdates(bool enabled) { - this->checkForUpdates = enabled; - this->save(); -} - bool PorymapConfig::getCheckForUpdates() { return this->checkForUpdates; } +QDateTime PorymapConfig::getLastUpdateCheckTime() { + return this->lastUpdateCheckTime; +} + +QMap PorymapConfig::getRateLimitTimes() { + return this->rateLimitTimes; +} + const QStringList ProjectConfig::versionStrings = { "pokeruby", "pokefirered", diff --git a/src/core/network.cpp b/src/core/network.cpp new file mode 100644 index 00000000..3f2d3cb2 --- /dev/null +++ b/src/core/network.cpp @@ -0,0 +1,146 @@ +#include "network.h" +#include "config.h" + +#include +#include +#include + +// Fallback wait time (in seconds) for rate limiting +static const int DefaultWaitTime = 120; + +NetworkAccessManager::NetworkAccessManager(QObject * parent) : QNetworkAccessManager(parent) { + // We store rate limit end times in the user's config so that Porymap will still respect them after a restart. + // To avoid reading/writing to a local file during network operations, we only read/write the file when the + // manager is created/destroyed respectively. + this->rateLimitTimes = porymapConfig.getRateLimitTimes(); + this->setRedirectPolicy(QNetworkRequest::NoLessSafeRedirectPolicy); +}; + +NetworkAccessManager::~NetworkAccessManager() { + porymapConfig.setRateLimitTimes(this->rateLimitTimes); + qDeleteAll(this->cache); +} + +const QNetworkRequest NetworkAccessManager::getRequest(const QUrl &url) { + QNetworkRequest request(url); + + // Set User-Agent to porymap/#.#.# + request.setHeader(QNetworkRequest::UserAgentHeader, QString("%1/%2").arg(QCoreApplication::applicationName()) + .arg(QCoreApplication::applicationVersion())); + + // If we've made a successful request in this session already, set the If-None-Match header. + // We'll only get a full response from the server if the data has changed since this last request. + // This helps to avoid hitting rate limits. + auto cacheEntry = this->cache.value(url, nullptr); + if (cacheEntry) + request.setHeader(QNetworkRequest::IfNoneMatchHeader, cacheEntry->eTag); + + return request; +} + +NetworkReplyData * NetworkAccessManager::get(const QString &url) { + return this->get(QUrl(url)); +} + +NetworkReplyData * NetworkAccessManager::get(const QUrl &url) { + NetworkReplyData * data = new NetworkReplyData(); + data->m_url = url; + + // If we are rate-limited, don't send a new request. + if (this->rateLimitTimes.contains(url)) { + auto time = this->rateLimitTimes.value(url); + if (!time.isNull() && time > QDateTime::currentDateTime()) { + data->m_retryAfter = time; + data->m_error = QString("Rate limit reached. Please try again after %1.").arg(data->m_retryAfter.toString()); + QTimer::singleShot(1000, data, &NetworkReplyData::finish); // We can't emit this signal before caller has a chance to connect + return data; + } + // Rate limiting expired + this->rateLimitTimes.remove(url); + } + + QNetworkReply * reply = QNetworkAccessManager::get(this->getRequest(url)); + connect(reply, &QNetworkReply::finished, [this, reply, data] { + this->processReply(reply, data); + data->finish(); + }); + + return data; +} + +void NetworkAccessManager::processReply(QNetworkReply * reply, NetworkReplyData * data) { + if (!reply || !reply->isFinished()) + return; + + auto url = reply->url(); + reply->deleteLater(); + + int statusCode = reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt(); + + // Handle pagination (specifically, the format GitHub uses). + // This header is still sent for a 304, so we don't need to bother caching it. + if (reply->hasRawHeader("link")) { + static const QRegularExpression regex("<(?.+)?>; rel=\"next\""); + QRegularExpressionMatch match = regex.match(QString(reply->rawHeader("link"))); + if (match.hasMatch()) + data->m_nextUrl = QUrl(match.captured("url")); + } + + if (statusCode == 304) { + // "Not Modified", data hasn't changed since our last request. + data->m_body = this->cache.value(url)->data; + return; + } + + // Handle standard rate limit header + if (reply->hasRawHeader("retry-after")) { + auto retryAfter = QVariant(reply->rawHeader("retry-after")); + if (retryAfter.canConvert()) { + data->m_retryAfter = retryAfter.toDateTime().toLocalTime(); + } else if (retryAfter.canConvert()) { + data->m_retryAfter = QDateTime::currentDateTime().addSecs(retryAfter.toInt()); + } + if (data->m_retryAfter.isNull() || data->m_retryAfter <= QDateTime::currentDateTime()) { + data->m_retryAfter = QDateTime::currentDateTime().addSecs(DefaultWaitTime); + } + if (statusCode == 429) { + data->m_error = "Too many requests. "; + } else if (statusCode == 503) { + data->m_error = "Service busy or unavailable. "; + } + data->m_error.append(QString("Please try again after %1.").arg(data->m_retryAfter.toString())); + this->rateLimitTimes.insert(url, data->m_retryAfter); + return; + } + + // Handle GitHub's rate limit headers. As of writing this is (without authentication) 60 requests per IP address per hour. + bool ok; + int limitRemaining = reply->rawHeader("x-ratelimit-remaining").toInt(&ok); + if (ok && limitRemaining <= 0) { + auto limitReset = reply->rawHeader("x-ratelimit-reset").toLongLong(&ok); + data->m_retryAfter = ok ? QDateTime::fromSecsSinceEpoch(limitReset).toLocalTime() + : QDateTime::currentDateTime().addSecs(DefaultWaitTime);; + data->m_error = QString("Too many requests. Please try again after %1.").arg(data->m_retryAfter.toString()); + this->rateLimitTimes.insert(url, data->m_retryAfter); + return; + } + + // Handle remaining errors generically + auto error = reply->error(); + if (error != QNetworkReply::NoError) { + data->m_error = reply->errorString(); + return; + } + + // Successful reply, we've received new data. Insert this data in the cache. + CacheEntry * cacheEntry = this->cache.value(url, nullptr); + if (!cacheEntry) { + cacheEntry = new CacheEntry; + this->cache.insert(url, cacheEntry); + } + auto eTagHeader = reply->header(QNetworkRequest::ETagHeader); + if (eTagHeader.isValid()) + cacheEntry->eTag = eTagHeader.toString(); + + cacheEntry->data = data->m_body = reply->readAll(); +} diff --git a/src/mainwindow.cpp b/src/mainwindow.cpp index 84c7fd43..bc259533 100644 --- a/src/mainwindow.cpp +++ b/src/mainwindow.cpp @@ -59,6 +59,7 @@ MainWindow::MainWindow(QWidget *parent) : ui->setupUi(this); cleanupLargeLog(); + logInfo(QString("Launching Porymap v%1").arg(PORYMAP_VERSION)); this->initWindow(); if (porymapConfig.getReopenOnLaunch() && this->openProject(porymapConfig.getRecentProject(), true)) @@ -255,7 +256,7 @@ void MainWindow::on_actionCheck_for_Updates_triggered() { void MainWindow::checkForUpdates(bool requestedByUser) { if (!this->networkAccessManager) - this->networkAccessManager = new QNetworkAccessManager(this); + this->networkAccessManager = new NetworkAccessManager(this); if (!this->updatePromoter) { this->updatePromoter = new UpdatePromoter(this, this->networkAccessManager); @@ -265,9 +266,17 @@ void MainWindow::checkForUpdates(bool requestedByUser) { }); } - if (requestedByUser) - this->updatePromoter->requestDialog(); + + if (requestedByUser) { + openSubWindow(this->updatePromoter); + } else { + // This is an automatic update check. Only run if we haven't done one in the last 5 minutes + QDateTime lastCheck = porymapConfig.getLastUpdateCheckTime(); + if (lastCheck.addSecs(5*60) >= QDateTime::currentDateTime()) + return; + } this->updatePromoter->checkForUpdates(); + porymapConfig.setLastUpdateCheckTime(QDateTime::currentDateTime()); } void MainWindow::initEditor() { diff --git a/src/ui/updatepromoter.cpp b/src/ui/updatepromoter.cpp index f8270b4e..71f4dce9 100644 --- a/src/ui/updatepromoter.cpp +++ b/src/ui/updatepromoter.cpp @@ -3,13 +3,13 @@ #include "log.h" #include "config.h" -#include #include #include #include #include +#include -UpdatePromoter::UpdatePromoter(QWidget *parent, QNetworkAccessManager *manager) +UpdatePromoter::UpdatePromoter(QWidget *parent, NetworkAccessManager *manager) : QDialog(parent), ui(new Ui::UpdatePromoter), manager(manager) @@ -18,6 +18,7 @@ UpdatePromoter::UpdatePromoter(QWidget *parent, QNetworkAccessManager *manager) // Set up "Do not alert me" check box this->updatePreferences(); + ui->checkBox_StopAlerts->setVisible(false); connect(ui->checkBox_StopAlerts, &QCheckBox::stateChanged, [this](int state) { bool enable = (state != Qt::Checked); porymapConfig.setCheckForUpdates(enable); @@ -25,7 +26,9 @@ UpdatePromoter::UpdatePromoter(QWidget *parent, QNetworkAccessManager *manager) }); // Set up button box + this->button_Retry = ui->buttonBox->button(QDialogButtonBox::Retry); this->button_Downloads = ui->buttonBox->addButton("Go to Downloads...", QDialogButtonBox::ActionRole); + ui->buttonBox->button(QDialogButtonBox::Close)->setDefault(true); connect(ui->buttonBox, &QDialogButtonBox::clicked, this, &UpdatePromoter::dialogButtonClicked); this->resetDialog(); @@ -33,47 +36,55 @@ UpdatePromoter::UpdatePromoter(QWidget *parent, QNetworkAccessManager *manager) void UpdatePromoter::resetDialog() { this->button_Downloads->setEnabled(false); + ui->text_Changelog->setVisible(false); ui->label_Warning->setVisible(false); - ui->label_Status->setText("Checking for updates..."); + ui->label_Status->setText(""); this->changelog = QString(); - this->downloadLink = QString(); + this->downloadUrl = QString(); + this->breakingChanges = false; + this->foundReleases = false; + this->visitedUrls.clear(); } void UpdatePromoter::checkForUpdates() { - // Ignore request if one is still active. - if (this->reply && !this->reply->isFinished()) + // If the Retry button is disabled, making requests is disabled + if (!this->button_Retry->isEnabled()) return; - this->resetDialog(); - ui->buttonBox->button(QDialogButtonBox::Retry)->setEnabled(false); - // We could get ".../releases/latest" to retrieve less data, but this would run into problems if the + this->resetDialog(); + this->button_Retry->setEnabled(false); + ui->label_Status->setText("Checking for updates..."); + + // We could use the URL ".../releases/latest" to retrieve less data, but this would run into problems if the // most recent item on the releases page is not actually a new release (like the static windows build). // By getting all releases we can also present a multi-version changelog of all changes since the host release. - static const QNetworkRequest request(QUrl("https://api.github.com/repos/huderlem/porymap/releases")); - this->reply = this->manager->get(request); + static const QUrl url("https://api.github.com/repos/huderlem/porymap/releases"); + this->get(url); +} - connect(this->reply, &QNetworkReply::finished, [this] { - ui->buttonBox->button(QDialogButtonBox::Retry)->setEnabled(true); - auto error = this->reply->error(); - if (error == QNetworkReply::NoError) { - this->processWebpage(QJsonDocument::fromJson(this->reply->readAll())); +void UpdatePromoter::get(const QUrl &url) { + this->visitedUrls.insert(url); + auto reply = this->manager->get(url); + connect(reply, &NetworkReplyData::finished, [this, reply] () { + if (!reply->errorString().isEmpty()) { + this->error(reply->errorString()); + this->disableRequestsUntil(reply->retryAfter()); } else { - this->processError(this->reply->errorString()); + this->processWebpage(QJsonDocument::fromJson(reply->body()), reply->nextUrl()); } + reply->deleteLater(); }); } // Read all the items on the releases page, ignoring entries without a version identifier tag. // Objects in the releases page data are sorted newest to oldest. -void UpdatePromoter::processWebpage(const QJsonDocument &data) { - bool updateAvailable = false; - bool breakingChanges = false; - bool foundRelease = false; - +// Returns true when finished, returns false to request processing for the next page. +void UpdatePromoter::processWebpage(const QJsonDocument &data, const QUrl &nextUrl) { const QJsonArray releases = data.array(); - for (int i = 0; i < releases.size(); i++) { + int i; + for (i = 0; i < releases.size(); i++) { auto release = releases.at(i).toObject(); // Convert tag string to version numbers @@ -89,57 +100,77 @@ void UpdatePromoter::processWebpage(const QJsonDocument &data) { if (!ok) continue; // We've found a valid release tag. If the version number is not newer than the host version then we can stop looking at releases. - foundRelease = true; + this->foundReleases = true; if (!this->isNewerVersion(major, minor, patch)) break; const QString description = release.value("body").toString(); - const QString url = release.value("html_url").toString(); - if (description.isEmpty() || url.isEmpty()) { + if (description.isEmpty()) { // If the release was published very recently it won't have a description yet, in which case don't tell the user about it yet. - // If there's no URL, something has gone wrong and we should skip this release. continue; } - if (this->downloadLink.isEmpty()) { + if (this->downloadUrl.isEmpty()) { // This is the first (newest) release we've found. Record its URL for download. - this->downloadLink = url; - breakingChanges = (major > PORYMAP_VERSION_MAJOR); + const QUrl url = QUrl(release.value("html_url").toString()); + if (url.isEmpty()) { + // If there's no URL, something has gone wrong and we should skip this release. + continue; + } + this->downloadUrl = url; + this->breakingChanges = (major > PORYMAP_VERSION_MAJOR); } // Record the changelog of this release so we can show all changes since the host release. this->changelog.append(QString("## %1\n%2\n\n").arg(tagName).arg(description)); - updateAvailable = true; } - if (!foundRelease) { - // We retrieved the webpage but didn't successfully parse any releases. - this->processError("Error parsing releases webpage"); + // If we read the entire page then we didn't find a release as old as the host version. + // Keep looking on the second page, there might still be new releases there. + if (i == releases.size() && !nextUrl.isEmpty() && !this->visitedUrls.contains(nextUrl)) { + this->get(nextUrl); return; } - // If there's a new update available the dialog will always be opened. - // Otherwise the dialog is only open if the user requested it. - if (updateAvailable) { - this->button_Downloads->setEnabled(!this->downloadLink.isEmpty()); - ui->text_Changelog->setMarkdown(this->changelog); - ui->text_Changelog->setVisible(true); - ui->label_Warning->setVisible(breakingChanges); - ui->label_Status->setText("A new version of Porymap is available!"); + if (!this->foundReleases) { + // We retrieved the webpage but didn't successfully parse any releases. + this->error("Error parsing releases webpage"); + return; + } + + // Populate dialog with result + bool updateAvailable = !this->changelog.isEmpty(); + ui->label_Status->setText(updateAvailable ? "A new version of Porymap is available!" + : "Your version of Porymap is up to date!"); + ui->label_Warning->setVisible(this->breakingChanges); + ui->text_Changelog->setMarkdown(this->changelog); + ui->text_Changelog->setVisible(updateAvailable); + this->button_Downloads->setEnabled(!this->downloadUrl.isEmpty()); + this->button_Retry->setEnabled(true); + + // Alert the user if there's a new update available and the dialog wasn't already open. + // Show the window, but also show the option to turn off automatic alerts in the future. + if (updateAvailable && !this->isVisible()) { + ui->checkBox_StopAlerts->setVisible(true); this->show(); - } else { - // The rest of the UI remains in the state set by resetDialog - ui->label_Status->setText("Your version of Porymap is up to date!"); - } + } } -void UpdatePromoter::processError(const QString &err) { +void UpdatePromoter::disableRequestsUntil(const QDateTime time) { + this->button_Retry->setEnabled(false); + + auto timeUntil = QDateTime::currentDateTime().msecsTo(time); + if (timeUntil < 0) timeUntil = 0; + QTimer::singleShot(timeUntil, Qt::VeryCoarseTimer, [this]() { + this->button_Retry->setEnabled(true); + }); +} + +void UpdatePromoter::error(const QString &err) { const QString message = QString("Failed to check for version update: %1").arg(err); - if (this->isVisible()) { - ui->label_Status->setText(message); - } else { + ui->label_Status->setText(message); + if (!this->isVisible()) logWarn(message); - } } bool UpdatePromoter::isNewerVersion(int major, int minor, int patch) { @@ -150,35 +181,17 @@ bool UpdatePromoter::isNewerVersion(int major, int minor, int patch) { return patch > PORYMAP_VERSION_PATCH; } -// The dialog can either be shown programmatically when an update is available -// or if the user manually selects "Check for Updates" in the menu. -// When the dialog is shown programmatically there is a check box to disable automatic alerts. -// If the user requested the dialog (and it wasn't already open) this check box should be hidden. -void UpdatePromoter::requestDialog() { - if (!this->isVisible()){ - ui->checkBox_StopAlerts->setVisible(false); - this->show(); - } else if (this->isMinimized()) { - this->showNormal(); - } else { - this->raise(); - this->activateWindow(); - } -} - void UpdatePromoter::updatePreferences() { const QSignalBlocker blocker(ui->checkBox_StopAlerts); - ui->checkBox_StopAlerts->setChecked(porymapConfig.getCheckForUpdates()); + ui->checkBox_StopAlerts->setChecked(!porymapConfig.getCheckForUpdates()); } void UpdatePromoter::dialogButtonClicked(QAbstractButton *button) { - auto buttonRole = ui->buttonBox->buttonRole(button); - if (buttonRole == QDialogButtonBox::RejectRole) { + if (ui->buttonBox->buttonRole(button) == QDialogButtonBox::RejectRole) { this->close(); - } else if (buttonRole == QDialogButtonBox::AcceptRole) { - // "Retry" button + } else if (button == this->button_Retry) { this->checkForUpdates(); - } else if (button == this->button_Downloads && !this->downloadLink.isEmpty()) { - QDesktopServices::openUrl(QUrl(this->downloadLink)); + } else if (button == this->button_Downloads) { + QDesktopServices::openUrl(this->downloadUrl); } } From 582fb101cf86ce2ab05136ce0099aa6c4af0728d Mon Sep 17 00:00:00 2001 From: GriffinR Date: Fri, 2 Feb 2024 10:31:11 -0500 Subject: [PATCH 09/26] Minor network fixes --- src/core/network.cpp | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/src/core/network.cpp b/src/core/network.cpp index 3f2d3cb2..901d291f 100644 --- a/src/core/network.cpp +++ b/src/core/network.cpp @@ -72,7 +72,11 @@ void NetworkAccessManager::processReply(QNetworkReply * reply, NetworkReplyData if (!reply || !reply->isFinished()) return; - auto url = reply->url(); + // The url in the request and the url ultimately processed (reply->url()) may differ if the request was redirected. + // For identification purposes (e.g. knowing if we are rate limited before a request is made) we use the url that + // was originally given for the request. + auto url = data->m_url; + reply->deleteLater(); int statusCode = reply->attribute(QNetworkRequest::HttpStatusCodeAttribute).toInt(); @@ -88,7 +92,11 @@ void NetworkAccessManager::processReply(QNetworkReply * reply, NetworkReplyData if (statusCode == 304) { // "Not Modified", data hasn't changed since our last request. - data->m_body = this->cache.value(url)->data; + auto cacheEntry = this->cache.value(url, nullptr); + if (cacheEntry) + data->m_body = cacheEntry->data; + else + data->m_error = "Failed to read webpage from cache."; return; } From 5def0e8be188ecdd9145de4dd4fcff015a069285 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Mon, 5 Feb 2024 11:54:35 -0500 Subject: [PATCH 10/26] Reenable Retry button for parsing errors --- include/ui/updatepromoter.h | 3 +-- src/core/network.cpp | 2 +- src/ui/updatepromoter.cpp | 30 +++++++++++++++--------------- 3 files changed, 17 insertions(+), 18 deletions(-) diff --git a/include/ui/updatepromoter.h b/include/ui/updatepromoter.h index 4465e0dc..b3abd381 100644 --- a/include/ui/updatepromoter.h +++ b/include/ui/updatepromoter.h @@ -37,8 +37,7 @@ private: void resetDialog(); void get(const QUrl &url); void processWebpage(const QJsonDocument &data, const QUrl &nextUrl); - void disableRequestsUntil(const QDateTime time); - void error(const QString &err); + void error(const QString &err, const QDateTime time = QDateTime()); bool isNewerVersion(int major, int minor, int patch); private slots: diff --git a/src/core/network.cpp b/src/core/network.cpp index 901d291f..94594d68 100644 --- a/src/core/network.cpp +++ b/src/core/network.cpp @@ -147,7 +147,7 @@ void NetworkAccessManager::processReply(QNetworkReply * reply, NetworkReplyData this->cache.insert(url, cacheEntry); } auto eTagHeader = reply->header(QNetworkRequest::ETagHeader); - if (eTagHeader.isValid()) + if (eTagHeader.canConvert()) cacheEntry->eTag = eTagHeader.toString(); cacheEntry->data = data->m_body = reply->readAll(); diff --git a/src/ui/updatepromoter.cpp b/src/ui/updatepromoter.cpp index 71f4dce9..5305a647 100644 --- a/src/ui/updatepromoter.cpp +++ b/src/ui/updatepromoter.cpp @@ -69,8 +69,7 @@ void UpdatePromoter::get(const QUrl &url) { auto reply = this->manager->get(url); connect(reply, &NetworkReplyData::finished, [this, reply] () { if (!reply->errorString().isEmpty()) { - this->error(reply->errorString()); - this->disableRequestsUntil(reply->retryAfter()); + this->error(reply->errorString(), reply->retryAfter()); } else { this->processWebpage(QJsonDocument::fromJson(reply->body()), reply->nextUrl()); } @@ -79,8 +78,7 @@ void UpdatePromoter::get(const QUrl &url) { } // Read all the items on the releases page, ignoring entries without a version identifier tag. -// Objects in the releases page data are sorted newest to oldest. -// Returns true when finished, returns false to request processing for the next page. +// Objects in the releases page data are sorted newest to oldest. void UpdatePromoter::processWebpage(const QJsonDocument &data, const QUrl &nextUrl) { const QJsonArray releases = data.array(); int i; @@ -156,21 +154,23 @@ void UpdatePromoter::processWebpage(const QJsonDocument &data, const QUrl &nextU } } -void UpdatePromoter::disableRequestsUntil(const QDateTime time) { - this->button_Retry->setEnabled(false); - - auto timeUntil = QDateTime::currentDateTime().msecsTo(time); - if (timeUntil < 0) timeUntil = 0; - QTimer::singleShot(timeUntil, Qt::VeryCoarseTimer, [this]() { - this->button_Retry->setEnabled(true); - }); -} - -void UpdatePromoter::error(const QString &err) { +void UpdatePromoter::error(const QString &err, const QDateTime retryAfter) { const QString message = QString("Failed to check for version update: %1").arg(err); ui->label_Status->setText(message); if (!this->isVisible()) logWarn(message); + + // If a "retry after" date/time is provided, disable the Retry button until then. + // Otherwise users are allowed to retry after an error. + auto timeUntil = QDateTime::currentDateTime().msecsTo(retryAfter); + if (timeUntil > 0) { + this->button_Retry->setEnabled(false); + QTimer::singleShot(timeUntil, Qt::VeryCoarseTimer, [this]() { + this->button_Retry->setEnabled(true); + }); + } else { + this->button_Retry->setEnabled(true); + } } bool UpdatePromoter::isNewerVersion(int major, int minor, int patch) { From e76729ce62b0217991f912593a2297a153125c16 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Tue, 6 Feb 2024 16:15:56 -0500 Subject: [PATCH 11/26] Limit update promoter to Windows/macOS --- src/mainwindow.cpp | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/mainwindow.cpp b/src/mainwindow.cpp index bc259533..3d094be2 100644 --- a/src/mainwindow.cpp +++ b/src/mainwindow.cpp @@ -41,6 +41,12 @@ #include #include +// We only publish release binaries for Windows and macOS. +// This is relevant for the update promoter, which alerts users of a new release. +#if defined(Q_OS_WIN) || defined(Q_OS_MACOS) +#define RELEASE_PLATFORM +#endif + using OrderedJson = poryjson::Json; using OrderedJsonDoc = poryjson::JsonDoc; @@ -111,6 +117,10 @@ void MainWindow::initWindow() { this->initShortcuts(); this->restoreWindowState(); +#ifndef RELEASE_PLATFORM + ui->actionCheck_for_Updates->setVisible(false); +#endif + setWindowDisabled(true); } @@ -254,6 +264,7 @@ void MainWindow::on_actionCheck_for_Updates_triggered() { checkForUpdates(true); } +#ifdef RELEASE_PLATFORM void MainWindow::checkForUpdates(bool requestedByUser) { if (!this->networkAccessManager) this->networkAccessManager = new NetworkAccessManager(this); @@ -278,6 +289,9 @@ void MainWindow::checkForUpdates(bool requestedByUser) { this->updatePromoter->checkForUpdates(); porymapConfig.setLastUpdateCheckTime(QDateTime::currentDateTime()); } +#else +void MainWindow::checkForUpdates(bool) {} +#endif void MainWindow::initEditor() { this->editor = new Editor(ui); From 73b5c0501d675890e52aef076b83f82e3b6e510a Mon Sep 17 00:00:00 2001 From: GriffinR Date: Wed, 7 Feb 2024 15:35:11 -0500 Subject: [PATCH 12/26] Only alert user at most once per new release --- include/config.h | 7 ++++++ include/ui/updatepromoter.h | 4 +-- porymap.pro | 10 ++------ src/config.cpp | 18 +++++++++++++ src/mainwindow.cpp | 2 +- src/scriptapi/scripting.cpp | 6 ++--- src/ui/aboutporymap.cpp | 2 +- src/ui/updatepromoter.cpp | 50 +++++++++++++++---------------------- 8 files changed, 54 insertions(+), 45 deletions(-) diff --git a/include/config.h b/include/config.h index 485e97eb..54398cca 100644 --- a/include/config.h +++ b/include/config.h @@ -10,9 +10,12 @@ #include #include #include +#include #include "events.h" +static const QVersionNumber porymapVersion = QVersionNumber::fromString(PORYMAP_VERSION); + // In both versions the default new map border is a generic tree #define DEFAULT_BORDER_RSE (QList{0x1D4, 0x1D5, 0x1DC, 0x1DD}) #define DEFAULT_BORDER_FRLG (QList{0x14, 0x15, 0x1C, 0x1D}) @@ -78,6 +81,7 @@ public: this->warpBehaviorWarningDisabled = false; this->checkForUpdates = true; this->lastUpdateCheckTime = QDateTime(); + this->lastUpdateCheckVersion = porymapVersion; this->rateLimitTimes.clear(); } void addRecentProject(QString project); @@ -112,6 +116,7 @@ public: void setWarpBehaviorWarningDisabled(bool disabled); void setCheckForUpdates(bool enabled); void setLastUpdateCheckTime(QDateTime time); + void setLastUpdateCheckVersion(QVersionNumber version); void setRateLimitTimes(QMap map); QString getRecentProject(); QStringList getRecentProjects(); @@ -145,6 +150,7 @@ public: bool getWarpBehaviorWarningDisabled(); bool getCheckForUpdates(); QDateTime getLastUpdateCheckTime(); + QVersionNumber getLastUpdateCheckVersion(); QMap getRateLimitTimes(); protected: virtual QString getConfigFilepath() override; @@ -196,6 +202,7 @@ private: bool warpBehaviorWarningDisabled; bool checkForUpdates; QDateTime lastUpdateCheckTime; + QVersionNumber lastUpdateCheckVersion; QMap rateLimitTimes; }; diff --git a/include/ui/updatepromoter.h b/include/ui/updatepromoter.h index b3abd381..8b67c69e 100644 --- a/include/ui/updatepromoter.h +++ b/include/ui/updatepromoter.h @@ -5,6 +5,7 @@ #include #include +#include namespace Ui { class UpdatePromoter; @@ -29,7 +30,7 @@ private: QString changelog; QUrl downloadUrl; - bool breakingChanges; + QVersionNumber newVersion; bool foundReleases; QSet visitedUrls; // Prevent infinite redirection @@ -38,7 +39,6 @@ private: void get(const QUrl &url); void processWebpage(const QJsonDocument &data, const QUrl &nextUrl); void error(const QString &err, const QDateTime time = QDateTime()); - bool isNewerVersion(int major, int minor, int patch); private slots: void dialogButtonClicked(QAbstractButton *button); diff --git a/porymap.pro b/porymap.pro index cf4cc451..43eef36b 100644 --- a/porymap.pro +++ b/porymap.pro @@ -14,14 +14,8 @@ RC_ICONS = resources/icons/porymap-icon-2.ico ICON = resources/icons/porymap.icns QMAKE_CXXFLAGS += -std=c++17 -Wall QMAKE_TARGET_BUNDLE_PREFIX = com.pret -VERSION_MAJOR = 5 -VERSION_MINOR = 3 -VERSION_PATCH = 0 -VERSION = $${VERSION_MAJOR}.$${VERSION_MINOR}.$${VERSION_PATCH} -DEFINES += PORYMAP_VERSION_MAJOR=$$VERSION_MAJOR \ - PORYMAP_VERSION_MINOR=$$VERSION_MINOR \ - PORYMAP_VERSION_PATCH=$$VERSION_PATCH \ - PORYMAP_VERSION=\\\"$$VERSION\\\" +VERSION = 5.3.0 +DEFINES += PORYMAP_VERSION=\\\"$$VERSION\\\" SOURCES += src/core/block.cpp \ src/core/bitpacker.cpp \ diff --git a/src/config.cpp b/src/config.cpp index 967c21c8..177aeafa 100644 --- a/src/config.cpp +++ b/src/config.cpp @@ -411,6 +411,14 @@ void PorymapConfig::parseConfigKeyValue(QString key, QString value) { this->checkForUpdates = getConfigBool(key, value); } else if (key == "last_update_check_time") { this->lastUpdateCheckTime = QDateTime::fromString(value).toLocalTime(); + } else if (key == "last_update_check_version") { + auto version = QVersionNumber::fromString(value); + if (version.segmentCount() != 3) { + logWarn(QString("Invalid config value for %1: '%2'. Must be 3 numbers separated by '.'").arg(key).arg(value)); + this->lastUpdateCheckVersion = porymapVersion; + } else { + this->lastUpdateCheckVersion = version; + } } else if (key.startsWith("rate_limit_time/")) { static const QRegularExpression regex("\\brate_limit_time/(?.+)"); QRegularExpressionMatch match = regex.match(key); @@ -465,6 +473,7 @@ QMap PorymapConfig::getKeyValueMap() { map.insert("warp_behavior_warning_disabled", QString::number(this->warpBehaviorWarningDisabled)); map.insert("check_for_updates", QString::number(this->checkForUpdates)); map.insert("last_update_check_time", this->lastUpdateCheckTime.toUTC().toString()); + map.insert("last_update_check_version", this->lastUpdateCheckVersion.toString()); for (auto i = this->rateLimitTimes.cbegin(), end = this->rateLimitTimes.cend(); i != end; i++){ // Only include rate limit times that are still active (i.e., in the future) const QDateTime time = i.value(); @@ -664,6 +673,11 @@ void PorymapConfig::setLastUpdateCheckTime(QDateTime time) { this->save(); } +void PorymapConfig::setLastUpdateCheckVersion(QVersionNumber version) { + this->lastUpdateCheckVersion = version; + this->save(); +} + void PorymapConfig::setRateLimitTimes(QMap map) { this->rateLimitTimes = map; this->save(); @@ -831,6 +845,10 @@ QDateTime PorymapConfig::getLastUpdateCheckTime() { return this->lastUpdateCheckTime; } +QVersionNumber PorymapConfig::getLastUpdateCheckVersion() { + return this->lastUpdateCheckVersion; +} + QMap PorymapConfig::getRateLimitTimes() { return this->rateLimitTimes; } diff --git a/src/mainwindow.cpp b/src/mainwindow.cpp index 3d094be2..fb08e898 100644 --- a/src/mainwindow.cpp +++ b/src/mainwindow.cpp @@ -65,7 +65,7 @@ MainWindow::MainWindow(QWidget *parent) : ui->setupUi(this); cleanupLargeLog(); - logInfo(QString("Launching Porymap v%1").arg(PORYMAP_VERSION)); + logInfo(QString("Launching Porymap v%1").arg(QCoreApplication::applicationVersion())); this->initWindow(); if (porymapConfig.getReopenOnLaunch() && this->openProject(porymapConfig.getRecentProject(), true)) diff --git a/src/scriptapi/scripting.cpp b/src/scriptapi/scripting.cpp index aa547724..112585c7 100644 --- a/src/scriptapi/scripting.cpp +++ b/src/scriptapi/scripting.cpp @@ -78,9 +78,9 @@ void Scripting::populateGlobalObject(MainWindow *mainWindow) { // Get version numbers QJSValue version = instance->engine->newObject(); - version.setProperty("major", PORYMAP_VERSION_MAJOR); - version.setProperty("minor", PORYMAP_VERSION_MINOR); - version.setProperty("patch", PORYMAP_VERSION_PATCH); + version.setProperty("major", porymapVersion.majorVersion()); + version.setProperty("minor", porymapVersion.minorVersion()); + version.setProperty("patch", porymapVersion.microVersion()); constants.setProperty("version", version); // Get basic tileset information diff --git a/src/ui/aboutporymap.cpp b/src/ui/aboutporymap.cpp index 96f20ee8..38c28144 100644 --- a/src/ui/aboutporymap.cpp +++ b/src/ui/aboutporymap.cpp @@ -8,7 +8,7 @@ AboutPorymap::AboutPorymap(QWidget *parent) : { ui->setupUi(this); - this->ui->label_Version->setText(QString("Version %1 - %2").arg(PORYMAP_VERSION).arg(QStringLiteral(__DATE__))); + this->ui->label_Version->setText(QString("Version %1 - %2").arg(QCoreApplication::applicationVersion()).arg(QStringLiteral(__DATE__))); this->ui->textBrowser->setSource(QUrl("qrc:/CHANGELOG.md")); } diff --git a/src/ui/updatepromoter.cpp b/src/ui/updatepromoter.cpp index 5305a647..8ca2b6cd 100644 --- a/src/ui/updatepromoter.cpp +++ b/src/ui/updatepromoter.cpp @@ -43,7 +43,7 @@ void UpdatePromoter::resetDialog() { this->changelog = QString(); this->downloadUrl = QString(); - this->breakingChanges = false; + this->newVersion = QVersionNumber(); this->foundReleases = false; this->visitedUrls.clear(); } @@ -87,19 +87,12 @@ void UpdatePromoter::processWebpage(const QJsonDocument &data, const QUrl &nextU // Convert tag string to version numbers const QString tagName = release.value("tag_name").toString(); - const QStringList tag = tagName.split("."); - if (tag.length() != 3) continue; - bool ok; - int major = tag.at(0).toInt(&ok); - if (!ok) continue; - int minor = tag.at(1).toInt(&ok); - if (!ok) continue; - int patch = tag.at(2).toInt(&ok); - if (!ok) continue; + const QVersionNumber version = QVersionNumber::fromString(tagName); + if (version.segmentCount() != 3) continue; // We've found a valid release tag. If the version number is not newer than the host version then we can stop looking at releases. this->foundReleases = true; - if (!this->isNewerVersion(major, minor, patch)) + if (porymapVersion >= version) break; const QString description = release.value("body").toString(); @@ -116,7 +109,7 @@ void UpdatePromoter::processWebpage(const QJsonDocument &data, const QUrl &nextU continue; } this->downloadUrl = url; - this->breakingChanges = (major > PORYMAP_VERSION_MAJOR); + this->newVersion = version; } // Record the changelog of this release so we can show all changes since the host release. @@ -137,20 +130,25 @@ void UpdatePromoter::processWebpage(const QJsonDocument &data, const QUrl &nextU } // Populate dialog with result - bool updateAvailable = !this->changelog.isEmpty(); - ui->label_Status->setText(updateAvailable ? "A new version of Porymap is available!" - : "Your version of Porymap is up to date!"); - ui->label_Warning->setVisible(this->breakingChanges); ui->text_Changelog->setMarkdown(this->changelog); - ui->text_Changelog->setVisible(updateAvailable); + ui->text_Changelog->setVisible(!this->changelog.isEmpty()); this->button_Downloads->setEnabled(!this->downloadUrl.isEmpty()); this->button_Retry->setEnabled(true); + if (!this->newVersion.isNull()) { + ui->label_Status->setText("A new version of Porymap is available!"); + ui->label_Warning->setVisible(this->newVersion.majorVersion() > porymapVersion.majorVersion()); - // Alert the user if there's a new update available and the dialog wasn't already open. - // Show the window, but also show the option to turn off automatic alerts in the future. - if (updateAvailable && !this->isVisible()) { - ui->checkBox_StopAlerts->setVisible(true); - this->show(); + // Alert the user about the new version if the dialog wasn't already open. + // Show the window, but also show the option to turn off automatic alerts in the future. + // We only show this alert once for a given release. + if (!this->isVisible() && this->newVersion > porymapConfig.getLastUpdateCheckVersion()) { + ui->checkBox_StopAlerts->setVisible(true); + this->show(); + } + porymapConfig.setLastUpdateCheckVersion(this->newVersion); + } else { + ui->label_Status->setText("Your version of Porymap is up to date!"); + ui->label_Warning->setVisible(false); } } @@ -173,14 +171,6 @@ void UpdatePromoter::error(const QString &err, const QDateTime retryAfter) { } } -bool UpdatePromoter::isNewerVersion(int major, int minor, int patch) { - if (major != PORYMAP_VERSION_MAJOR) - return major > PORYMAP_VERSION_MAJOR; - if (minor != PORYMAP_VERSION_MINOR) - return minor > PORYMAP_VERSION_MINOR; - return patch > PORYMAP_VERSION_PATCH; -} - void UpdatePromoter::updatePreferences() { const QSignalBlocker blocker(ui->checkBox_StopAlerts); ui->checkBox_StopAlerts->setChecked(!porymapConfig.getCheckForUpdates()); From 3eed13a1629eefc0805e418091ffc8a395c17c27 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Mon, 12 Feb 2024 13:36:14 -0500 Subject: [PATCH 13/26] Update changelog --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9b3b30bd..d1c4859b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,9 @@ 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. It also includes changes to the scripting API that may change the behavior of existing porymap scripts. If porymap is used with a project or API script that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly. ## [Unreleased] +### Added +- Add a `Check for Updates` option to show new releases (Windows and macOS only). + ### Changed - If Wild Encounters fail to load they are now only disabled for that session, and the settings remain unchanged. - Defaults are used if project constants are missing, rather than failing to open the project or changing settings. From 012f2a213a36901738792015727b9c8375bc62b2 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Tue, 13 Feb 2024 16:36:54 -0500 Subject: [PATCH 14/26] Release 5.4.0 --- CHANGELOG.md | 6 +++++- RELEASE-README.txt | 20 ++++++++++++++++++-- porymap.pro | 2 +- 3 files changed, 24 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d1c4859b..3c328f96 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,9 @@ 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. It also includes changes to the scripting API that may change the behavior of existing porymap scripts. If porymap is used with a project or API script that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly. ## [Unreleased] +Nothing, yet. + +## [5.4.0] - 2024-02-13 ### Added - Add a `Check for Updates` option to show new releases (Windows and macOS only). @@ -477,7 +480,8 @@ 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/5.3.0...HEAD +[Unreleased]: https://github.com/huderlem/porymap/compare/5.4.0...HEAD +[5.4.0]: https://github.com/huderlem/porymap/compare/5.3.0...5.4.0 [5.3.0]: https://github.com/huderlem/porymap/compare/5.2.0...5.3.0 [5.2.0]: https://github.com/huderlem/porymap/compare/5.1.1...5.2.0 [5.1.1]: https://github.com/huderlem/porymap/compare/5.1.0...5.1.1 diff --git a/RELEASE-README.txt b/RELEASE-README.txt index 643ff343..b1c48a92 100644 --- a/RELEASE-README.txt +++ b/RELEASE-README.txt @@ -1,5 +1,5 @@ -Version: 5.3.0 -Date: January 15th, 2024 +Version: 5.4.0 +Date: February 13th, 2024 This version of porymap works with pokeruby and pokeemerald as of the following commit hashes: * pokeemerald: c76beed98990a57c84d3930190fd194abfedf7e8 @@ -12,6 +12,22 @@ Please report any issues on GitHub: [https://github.com/huderlem/porymap/issues] ------------------------- +## [5.4.0] - 2024-02-13 +### Added +- Add a `Check for Updates` option to show new releases (Windows and macOS only). + +### Changed +- If Wild Encounters fail to load they are now only disabled for that session, and the settings remain unchanged. +- Defaults are used if project constants are missing, rather than failing to open the project or changing settings. +- Selector images now center on the selection when eyedropping or zooming. + +### Fixed +- Fix some minor visual issues with the various zoom sliders. +- Smooth out scrolling when mouse is over tile/metatile images. +- Fix the Tileset Editor selectors getting extra white space when changing tilesets. +- Fix a crash when adding disabled events with the Pencil tool. +- Fix error log about failing to find the scripts file when a new map is created. + ## [5.3.0] - 2024-01-15 ### Added - Add zoom sliders to the Tileset Editor. diff --git a/porymap.pro b/porymap.pro index 43eef36b..6b0c234e 100644 --- a/porymap.pro +++ b/porymap.pro @@ -14,7 +14,7 @@ RC_ICONS = resources/icons/porymap-icon-2.ico ICON = resources/icons/porymap.icns QMAKE_CXXFLAGS += -std=c++17 -Wall QMAKE_TARGET_BUNDLE_PREFIX = com.pret -VERSION = 5.3.0 +VERSION = 5.4.0 DEFINES += PORYMAP_VERSION=\\\"$$VERSION\\\" SOURCES += src/core/block.cpp \ From 56e4955c549c62b783ee639204ef1fa803204ca2 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Thu, 21 Mar 2024 15:22:53 -0400 Subject: [PATCH 15/26] Fix struct parsing using multiple methods to re-read a single member --- CHANGELOG.md | 3 ++- src/core/parseutil.cpp | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3c328f96..0f97e933 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,8 @@ 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. It also includes changes to the scripting API that may change the behavior of existing porymap scripts. If porymap is used with a project or API script that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly. ## [Unreleased] -Nothing, yet. +### Fixed +- Fix object event sprites not loading for some struct data formats. ## [5.4.0] - 2024-02-13 ### Added diff --git a/src/core/parseutil.cpp b/src/core/parseutil.cpp index cee1dd5f..8af1bf2b 100644 --- a/src/core/parseutil.cpp +++ b/src/core/parseutil.cpp @@ -568,7 +568,7 @@ QMap> ParseUtil::readCStructs(const QString &fi values.insert(key, value); } else { // For compatibility with structs that don't specify member names. - if (memberMap.contains(i)) + if (memberMap.contains(i) && !values.contains(memberMap.value(i))) values.insert(memberMap.value(i), QString::fromStdString(v.string_value())); } i++; From 6fe85394612f97c0e113cb3f60d74c5d90b6fdff Mon Sep 17 00:00:00 2001 From: GriffinR Date: Thu, 21 Mar 2024 15:24:08 -0400 Subject: [PATCH 16/26] Fix number->string conversion in struct parsing --- include/lib/fex/array_value.h | 12 ++++++------ src/core/parseutil.cpp | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/include/lib/fex/array_value.h b/include/lib/fex/array_value.h index 88bb0a93..642cc129 100644 --- a/include/lib/fex/array_value.h +++ b/include/lib/fex/array_value.h @@ -77,16 +77,16 @@ namespace fex switch (type_) { case Type::kEmpty: - return "kEmpty: {}"; + return "{}"; case Type::kNumber: - return "kNumber: " + std::to_string(int_value_); + return std::to_string(int_value_); case Type::kString: - return "kString: \"" + string_value_ + "\""; + return "\"" + string_value_ + "\""; case Type::kIdentifier: - return "kIdentifier: " + string_value_; + return string_value_; case Type::kValueList: { - std::string out = "kValueList: {\n"; + std::string out = "{\n"; for (const ArrayValue &v : values_) { out += "\t" + v.ToString() + ",\n"; @@ -94,7 +94,7 @@ namespace fex return out + "}\n"; } case Type::kValuePair: - return "kValuePair: " + pair_.first + " = " + pair_.second->ToString() + "\n"; + return pair_.first + " = " + pair_.second->ToString() + "\n"; } } diff --git a/src/core/parseutil.cpp b/src/core/parseutil.cpp index 8af1bf2b..c5d09635 100644 --- a/src/core/parseutil.cpp +++ b/src/core/parseutil.cpp @@ -564,12 +564,12 @@ QMap> ParseUtil::readCStructs(const QString &fi for (const fex::ArrayValue &v : it->second.values()) { if (v.type() == fex::ArrayValue::Type::kValuePair) { QString key = QString::fromStdString(v.pair().first); - QString value = QString::fromStdString(v.pair().second->string_value()); + QString value = QString::fromStdString(v.pair().second->ToString()); values.insert(key, value); } else { // For compatibility with structs that don't specify member names. if (memberMap.contains(i) && !values.contains(memberMap.value(i))) - values.insert(memberMap.value(i), QString::fromStdString(v.string_value())); + values.insert(memberMap.value(i), QString::fromStdString(v.ToString())); } i++; } From 199799f1c2bda5201d5a0f6172226c30d4498252 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Thu, 21 Mar 2024 15:33:00 -0400 Subject: [PATCH 17/26] Release 5.4.1 --- CHANGELOG.md | 6 +++++- RELEASE-README.txt | 8 ++++++-- porymap.pro | 2 +- 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f97e933..a6d13ce3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,9 @@ 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. It also includes changes to the scripting API that may change the behavior of existing porymap scripts. If porymap is used with a project or API script that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly. ## [Unreleased] +Nothing, yet. + +## [5.4.1] - 2024-03-21 ### Fixed - Fix object event sprites not loading for some struct data formats. @@ -481,7 +484,8 @@ 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/5.4.0...HEAD +[Unreleased]: https://github.com/huderlem/porymap/compare/5.4.1...HEAD +[5.4.1]: https://github.com/huderlem/porymap/compare/5.4.0...5.4.1 [5.4.0]: https://github.com/huderlem/porymap/compare/5.3.0...5.4.0 [5.3.0]: https://github.com/huderlem/porymap/compare/5.2.0...5.3.0 [5.2.0]: https://github.com/huderlem/porymap/compare/5.1.1...5.2.0 diff --git a/RELEASE-README.txt b/RELEASE-README.txt index b1c48a92..f6d927b0 100644 --- a/RELEASE-README.txt +++ b/RELEASE-README.txt @@ -1,5 +1,5 @@ -Version: 5.4.0 -Date: February 13th, 2024 +Version: 5.4.1 +Date: March 21st, 2024 This version of porymap works with pokeruby and pokeemerald as of the following commit hashes: * pokeemerald: c76beed98990a57c84d3930190fd194abfedf7e8 @@ -12,6 +12,10 @@ Please report any issues on GitHub: [https://github.com/huderlem/porymap/issues] ------------------------- +## [5.4.1] - 2024-03-21 +### Fixed +- Fix object event sprites not loading for some struct data formats. + ## [5.4.0] - 2024-02-13 ### Added - Add a `Check for Updates` option to show new releases (Windows and macOS only). diff --git a/porymap.pro b/porymap.pro index 6b0c234e..dfc3306e 100644 --- a/porymap.pro +++ b/porymap.pro @@ -14,7 +14,7 @@ RC_ICONS = resources/icons/porymap-icon-2.ico ICON = resources/icons/porymap.icns QMAKE_CXXFLAGS += -std=c++17 -Wall QMAKE_TARGET_BUNDLE_PREFIX = com.pret -VERSION = 5.4.0 +VERSION = 5.4.1 DEFINES += PORYMAP_VERSION=\\\"$$VERSION\\\" SOURCES += src/core/block.cpp \ From 83a57c145c9a7ff1cd89b7ce2154431540a1db68 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Thu, 21 Mar 2024 15:38:02 -0400 Subject: [PATCH 18/26] Update manual --- docs/_sources/reference/CHANGELOG.md.txt | 24 +- docs/genindex.html | 166 ++++---- docs/index.html | 208 ++++----- docs/manual/editing-map-collisions.html | 166 ++++---- docs/manual/editing-map-events.html | 166 ++++---- docs/manual/project-files.html | 166 ++++---- docs/manual/scripting-capabilities.html | 166 ++++---- docs/manual/settings-and-options.html | 166 ++++---- docs/manual/tileset-editor.html | 166 ++++---- docs/reference/changelog.html | 514 ++++++++++++----------- docs/search.html | 166 ++++---- docs/searchindex.js | 2 +- 12 files changed, 1118 insertions(+), 958 deletions(-) diff --git a/docs/_sources/reference/CHANGELOG.md.txt b/docs/_sources/reference/CHANGELOG.md.txt index c254bfe2..a6d13ce3 100644 --- a/docs/_sources/reference/CHANGELOG.md.txt +++ b/docs/_sources/reference/CHANGELOG.md.txt @@ -9,6 +9,26 @@ The **"Breaking Changes"** listed below are changes that have been made in the d ## [Unreleased] Nothing, yet. +## [5.4.1] - 2024-03-21 +### Fixed +- Fix object event sprites not loading for some struct data formats. + +## [5.4.0] - 2024-02-13 +### Added +- Add a `Check for Updates` option to show new releases (Windows and macOS only). + +### Changed +- If Wild Encounters fail to load they are now only disabled for that session, and the settings remain unchanged. +- Defaults are used if project constants are missing, rather than failing to open the project or changing settings. +- Selector images now center on the selection when eyedropping or zooming. + +### Fixed +- Fix some minor visual issues with the various zoom sliders. +- Smooth out scrolling when mouse is over tile/metatile images. +- Fix the Tileset Editor selectors getting extra white space when changing tilesets. +- Fix a crash when adding disabled events with the Pencil tool. +- Fix error log about failing to find the scripts file when a new map is created. + ## [5.3.0] - 2024-01-15 ### Added - Add zoom sliders to the Tileset Editor. @@ -464,7 +484,9 @@ Nothing, yet. ## [1.0.0] - 2018-10-26 This was the initial release. -[Unreleased]: https://github.com/huderlem/porymap/compare/5.3.0...HEAD +[Unreleased]: https://github.com/huderlem/porymap/compare/5.4.1...HEAD +[5.4.1]: https://github.com/huderlem/porymap/compare/5.4.0...5.4.1 +[5.4.0]: https://github.com/huderlem/porymap/compare/5.3.0...5.4.0 [5.3.0]: https://github.com/huderlem/porymap/compare/5.2.0...5.3.0 [5.2.0]: https://github.com/huderlem/porymap/compare/5.1.1...5.2.0 [5.1.1]: https://github.com/huderlem/porymap/compare/5.1.0...5.1.1 diff --git a/docs/genindex.html b/docs/genindex.html index b76e73be..16e48e74 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -219,124 +219,134 @@
  • Changelog
    • Unreleased
      • -
    • 5.3.0 - 2024-01-15
        -
      • Added
        • -
      • Changed
        • +
      • 5.4.1 - 2024-03-21
        • -
      • 5.2.0 - 2024-01-02
          -
        • Added
          • -
        • Changed
          • -
        • Fixed
          • +
        • 5.4.0 - 2024-02-13
          • -
        • 5.1.1 - 2023-02-20
            -
          • Added
            • -
          • Changed
            • -
          • Fixed
            • +
          • 5.3.0 - 2024-01-15
            • -
          • 5.1.0 - 2023-01-22
              -
            • Added
              • -
            • Changed
              • -
            • Fixed
              • +
            • 5.2.0 - 2024-01-02
              • -
            • 5.0.0 - 2022-10-30
                +
              • 5.1.1 - 2023-02-20 +
                • +
              • 5.1.0 - 2023-01-22 +
                • +
              • 5.0.0 - 2022-10-30
                • -
              • 4.5.0 - 2021-12-26
                  -
                • Added
                  • -
                • Changed
                  • -
                • Fixed
                  • +
                • 4.5.0 - 2021-12-26
                  • -
                • 4.4.0 - 2020-12-20
                    -
                  • Added
                    • -
                  • Changed
                    • -
                  • Fixed
                    • +
                  • 4.4.0 - 2020-12-20
                    • -
                  • 4.3.1 - 2020-07-17
                      -
                    • Added
                      • -
                    • Changed
                      • -
                    • Fixed
                      • +
                    • 4.3.1 - 2020-07-17
                      • -
                    • 4.3.0 - 2020-06-27
                        -
                      • Added
                        • -
                      • Changed
                        • -
                      • Fixed
                        • +
                      • 4.3.0 - 2020-06-27
                        • -
                      • 4.2.0 - 2020-06-06
                          -
                        • Added
                          • -
                        • Changed
                          • -
                        • Fixed
                          • +
                        • 4.2.0 - 2020-06-06
                          • -
                        • 4.1.0 - 2020-05-18
                            -
                          • Added
                            • -
                          • Changed
                            • -
                          • Fixed
                            • +
                          • 4.1.0 - 2020-05-18
                            • -
                          • 4.0.0 - 2020-04-28
                              -
                            • Breaking Changes
                              • -
                            • Added
                              • -
                            • Changed
                              • -
                            • Fixed
                              • +
                            • 4.0.0 - 2020-04-28
                              • -
                            • 3.0.1 - 2020-03-04
                                -
                              • Fixed
                                • +
                              • 3.0.1 - 2020-03-04
                                • -
                              • 3.0.0 - 2020-03-04
                                  -
                                • Breaking Changes
                                  • -
                                • Added
                                  • -
                                • Changed
                                  • -
                                • Fixed
                                  • +
                                • 3.0.0 - 2020-03-04
                                  • -
                                • 2.0.0 - 2019-10-16
                                    -
                                  • Breaking Changes
                                    • -
                                  • Added
                                    • -
                                  • Changed
                                    • -
                                  • Fixed
                                    • +
                                  • 2.0.0 - 2019-10-16
                                    • -
                                  • 1.2.2 - 2019-05-16
                                      -
                                    • Added
                                      • -
                                    • Changed
                                      • -
                                    • Fixed
                                      • +
                                    • 1.2.2 - 2019-05-16
                                      • -
                                    • 1.2.1 - 2019-02-16
                                        -
                                      • Added
                                        • -
                                      • Fixed
                                        • +
                                      • 1.2.1 - 2019-02-16
                                        • -
                                      • 1.2.0 - 2019-02-04
                                          -
                                        • Breaking Changes
                                          • -
                                        • Added
                                          • -
                                        • Changed
                                          • -
                                        • Fixed
                                          • +
                                        • 1.2.0 - 2019-02-04
                                          • -
                                        • 1.1.0 - 2018-12-27
                                        • Related Projects
                                          • diff --git a/docs/index.html b/docs/index.html index a4700258..b02f9ab9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -219,124 +219,134 @@
                                          • Changelog
                                            • Unreleased
                                              • -
                                            • 5.3.0 - 2024-01-15
                                                -
                                              • Added
                                                • -
                                              • Changed
                                                • +
                                              • 5.4.1 - 2024-03-21
                                                • -
                                              • 5.2.0 - 2024-01-02
                                                  -
                                                • Added
                                                  • -
                                                • Changed
                                                  • -
                                                • Fixed
                                                  • +
                                                • 5.4.0 - 2024-02-13
                                                  • -
                                                • 5.1.1 - 2023-02-20
                                                    -
                                                  • Added
                                                    • -
                                                  • Changed
                                                    • -
                                                  • Fixed
                                                    • +
                                                  • 5.3.0 - 2024-01-15
                                                    • -
                                                  • 5.1.0 - 2023-01-22
                                                      -
                                                    • Added
                                                      • -
                                                    • Changed
                                                      • -
                                                    • Fixed
                                                      • +
                                                    • 5.2.0 - 2024-01-02
                                                      • -
                                                    • 5.0.0 - 2022-10-30
                                                        +
                                                      • 5.1.1 - 2023-02-20 +
                                                        • +
                                                      • 5.1.0 - 2023-01-22 +
                                                        • +
                                                      • 5.0.0 - 2022-10-30
                                                        • -
                                                      • 4.5.0 - 2021-12-26
                                                          -
                                                        • Added
                                                          • -
                                                        • Changed
                                                          • -
                                                        • Fixed
                                                          • +
                                                        • 4.5.0 - 2021-12-26
                                                          • -
                                                        • 4.4.0 - 2020-12-20
                                                            -
                                                          • Added
                                                            • -
                                                          • Changed
                                                            • -
                                                          • Fixed
                                                            • +
                                                          • 4.4.0 - 2020-12-20
                                                            • -
                                                          • 4.3.1 - 2020-07-17
                                                              -
                                                            • Added
                                                              • -
                                                            • Changed
                                                              • -
                                                            • Fixed
                                                              • +
                                                            • 4.3.1 - 2020-07-17
                                                              • -
                                                            • 4.3.0 - 2020-06-27
                                                                -
                                                              • Added
                                                                • -
                                                              • Changed
                                                                • -
                                                              • Fixed
                                                                • +
                                                              • 4.3.0 - 2020-06-27
                                                                • -
                                                              • 4.2.0 - 2020-06-06
                                                                  -
                                                                • Added
                                                                  • -
                                                                • Changed
                                                                  • -
                                                                • Fixed
                                                                  • +
                                                                • 4.2.0 - 2020-06-06
                                                                  • -
                                                                • 4.1.0 - 2020-05-18
                                                                    -
                                                                  • Added
                                                                    • -
                                                                  • Changed
                                                                    • -
                                                                  • Fixed
                                                                    • +
                                                                  • 4.1.0 - 2020-05-18
                                                                    • -
                                                                  • 4.0.0 - 2020-04-28
                                                                      -
                                                                    • Breaking Changes
                                                                      • -
                                                                    • Added
                                                                      • -
                                                                    • Changed
                                                                      • -
                                                                    • Fixed
                                                                      • +
                                                                    • 4.0.0 - 2020-04-28
                                                                      • -
                                                                    • 3.0.1 - 2020-03-04
                                                                        -
                                                                      • Fixed
                                                                        • +
                                                                      • 3.0.1 - 2020-03-04
                                                                        • -
                                                                      • 3.0.0 - 2020-03-04
                                                                          -
                                                                        • Breaking Changes
                                                                          • -
                                                                        • Added
                                                                          • -
                                                                        • Changed
                                                                          • -
                                                                        • Fixed
                                                                          • +
                                                                        • 3.0.0 - 2020-03-04
                                                                          • -
                                                                        • 2.0.0 - 2019-10-16
                                                                            -
                                                                          • Breaking Changes
                                                                            • -
                                                                          • Added
                                                                            • -
                                                                          • Changed
                                                                            • -
                                                                          • Fixed
                                                                            • +
                                                                          • 2.0.0 - 2019-10-16
                                                                            • -
                                                                          • 1.2.2 - 2019-05-16
                                                                              -
                                                                            • Added
                                                                              • -
                                                                            • Changed
                                                                              • -
                                                                            • Fixed
                                                                              • +
                                                                            • 1.2.2 - 2019-05-16
                                                                              • -
                                                                            • 1.2.1 - 2019-02-16
                                                                                -
                                                                              • Added
                                                                                • -
                                                                              • Fixed
                                                                                • +
                                                                              • 1.2.1 - 2019-02-16
                                                                                • -
                                                                              • 1.2.0 - 2019-02-04
                                                                                  -
                                                                                • Breaking Changes
                                                                                  • -
                                                                                • Added
                                                                                  • -
                                                                                • Changed
                                                                                  • -
                                                                                • Fixed
                                                                                  • +
                                                                                • 1.2.0 - 2019-02-04
                                                                                  • -
                                                                                • 1.1.0 - 2018-12-27
                                                                                • Related Projects
                                                                                  • @@ -519,26 +529,28 @@
                                                                                  • Changelog
                                                                                  • Related Projects
                                                                                    • diff --git a/docs/manual/editing-map-collisions.html b/docs/manual/editing-map-collisions.html index 03db886e..5deca8ac 100644 --- a/docs/manual/editing-map-collisions.html +++ b/docs/manual/editing-map-collisions.html @@ -220,124 +220,134 @@
                                                                                    • Changelog
                                                                                      • Unreleased
                                                                                        • -
                                                                                      • 5.3.0 - 2024-01-15
                                                                                          -
                                                                                        • Added
                                                                                          • -
                                                                                        • Changed
                                                                                          • +
                                                                                        • 5.4.1 - 2024-03-21
                                                                                          • -
                                                                                        • 5.2.0 - 2024-01-02
                                                                                            -
                                                                                          • Added
                                                                                            • -
                                                                                          • Changed
                                                                                            • -
                                                                                          • Fixed
                                                                                            • +
                                                                                          • 5.4.0 - 2024-02-13
                                                                                            • -
                                                                                          • 5.1.1 - 2023-02-20
                                                                                              -
                                                                                            • Added
                                                                                              • -
                                                                                            • Changed
                                                                                              • -
                                                                                            • Fixed
                                                                                              • +
                                                                                            • 5.3.0 - 2024-01-15
                                                                                              • -
                                                                                            • 5.1.0 - 2023-01-22
                                                                                                -
                                                                                              • Added
                                                                                                • -
                                                                                              • Changed
                                                                                                • -
                                                                                              • Fixed
                                                                                                • +
                                                                                              • 5.2.0 - 2024-01-02
                                                                                                • -
                                                                                              • 5.0.0 - 2022-10-30
                                                                                                  +
                                                                                                • 5.1.1 - 2023-02-20 +
                                                                                                  • +
                                                                                                • 5.1.0 - 2023-01-22 +
                                                                                                  • +
                                                                                                • 5.0.0 - 2022-10-30
                                                                                                  • -
                                                                                                • 4.5.0 - 2021-12-26
                                                                                                    -
                                                                                                  • Added
                                                                                                    • -
                                                                                                  • Changed
                                                                                                    • -
                                                                                                  • Fixed
                                                                                                    • +
                                                                                                  • 4.5.0 - 2021-12-26
                                                                                                    • -
                                                                                                  • 4.4.0 - 2020-12-20
                                                                                                      -
                                                                                                    • Added
                                                                                                      • -
                                                                                                    • Changed
                                                                                                      • -
                                                                                                    • Fixed
                                                                                                      • +
                                                                                                    • 4.4.0 - 2020-12-20
                                                                                                      • -
                                                                                                    • 4.3.1 - 2020-07-17
                                                                                                        -
                                                                                                      • Added
                                                                                                        • -
                                                                                                      • Changed
                                                                                                        • -
                                                                                                      • Fixed
                                                                                                        • +
                                                                                                      • 4.3.1 - 2020-07-17
                                                                                                        • -
                                                                                                      • 4.3.0 - 2020-06-27
                                                                                                          -
                                                                                                        • Added
                                                                                                          • -
                                                                                                        • Changed
                                                                                                          • -
                                                                                                        • Fixed
                                                                                                          • +
                                                                                                        • 4.3.0 - 2020-06-27
                                                                                                          • -
                                                                                                        • 4.2.0 - 2020-06-06
                                                                                                            -
                                                                                                          • Added
                                                                                                            • -
                                                                                                          • Changed
                                                                                                            • -
                                                                                                          • Fixed
                                                                                                            • +
                                                                                                          • 4.2.0 - 2020-06-06
                                                                                                            • -
                                                                                                          • 4.1.0 - 2020-05-18
                                                                                                              -
                                                                                                            • Added
                                                                                                              • -
                                                                                                            • Changed
                                                                                                              • -
                                                                                                            • Fixed
                                                                                                              • +
                                                                                                            • 4.1.0 - 2020-05-18
                                                                                                              • -
                                                                                                            • 4.0.0 - 2020-04-28
                                                                                                                -
                                                                                                              • Breaking Changes
                                                                                                                • -
                                                                                                              • Added
                                                                                                                • -
                                                                                                              • Changed
                                                                                                                • -
                                                                                                              • Fixed
                                                                                                                • +
                                                                                                              • 4.0.0 - 2020-04-28
                                                                                                                • -
                                                                                                              • 3.0.1 - 2020-03-04
                                                                                                                  -
                                                                                                                • Fixed
                                                                                                                  • +
                                                                                                                • 3.0.1 - 2020-03-04
                                                                                                                  • -
                                                                                                                • 3.0.0 - 2020-03-04
                                                                                                                    -
                                                                                                                  • Breaking Changes
                                                                                                                    • -
                                                                                                                  • Added
                                                                                                                    • -
                                                                                                                  • Changed
                                                                                                                    • -
                                                                                                                  • Fixed
                                                                                                                    • +
                                                                                                                  • 3.0.0 - 2020-03-04
                                                                                                                    • -
                                                                                                                  • 2.0.0 - 2019-10-16
                                                                                                                      -
                                                                                                                    • Breaking Changes
                                                                                                                      • -
                                                                                                                    • Added
                                                                                                                      • -
                                                                                                                    • Changed
                                                                                                                      • -
                                                                                                                    • Fixed
                                                                                                                      • +
                                                                                                                    • 2.0.0 - 2019-10-16
                                                                                                                      • -
                                                                                                                    • 1.2.2 - 2019-05-16
                                                                                                                        -
                                                                                                                      • Added
                                                                                                                        • -
                                                                                                                      • Changed
                                                                                                                        • -
                                                                                                                      • Fixed
                                                                                                                        • +
                                                                                                                      • 1.2.2 - 2019-05-16
                                                                                                                        • -
                                                                                                                      • 1.2.1 - 2019-02-16
                                                                                                                          -
                                                                                                                        • Added
                                                                                                                          • -
                                                                                                                        • Fixed
                                                                                                                          • +
                                                                                                                        • 1.2.1 - 2019-02-16
                                                                                                                          • -
                                                                                                                        • 1.2.0 - 2019-02-04
                                                                                                                            -
                                                                                                                          • Breaking Changes
                                                                                                                            • -
                                                                                                                          • Added
                                                                                                                            • -
                                                                                                                          • Changed
                                                                                                                            • -
                                                                                                                          • Fixed
                                                                                                                            • +
                                                                                                                          • 1.2.0 - 2019-02-04
                                                                                                                            • -
                                                                                                                          • 1.1.0 - 2018-12-27
                                                                                                                          • Related Projects
                                                                                                                            • diff --git a/docs/manual/editing-map-events.html b/docs/manual/editing-map-events.html index bd3cd82e..362cd912 100644 --- a/docs/manual/editing-map-events.html +++ b/docs/manual/editing-map-events.html @@ -220,124 +220,134 @@
                                                                                                                            • Changelog
                                                                                                                              • Unreleased
                                                                                                                                • -
                                                                                                                              • 5.3.0 - 2024-01-15
                                                                                                                                  -
                                                                                                                                • Added
                                                                                                                                  • -
                                                                                                                                • Changed
                                                                                                                                  • +
                                                                                                                                • 5.4.1 - 2024-03-21
                                                                                                                                  • -
                                                                                                                                • 5.2.0 - 2024-01-02
                                                                                                                                    -
                                                                                                                                  • Added
                                                                                                                                    • -
                                                                                                                                  • Changed
                                                                                                                                    • -
                                                                                                                                  • Fixed
                                                                                                                                    • +
                                                                                                                                  • 5.4.0 - 2024-02-13
                                                                                                                                    • -
                                                                                                                                  • 5.1.1 - 2023-02-20
                                                                                                                                      -
                                                                                                                                    • Added
                                                                                                                                      • -
                                                                                                                                    • Changed
                                                                                                                                      • -
                                                                                                                                    • Fixed
                                                                                                                                      • +
                                                                                                                                    • 5.3.0 - 2024-01-15
                                                                                                                                      • -
                                                                                                                                    • 5.1.0 - 2023-01-22
                                                                                                                                        -
                                                                                                                                      • Added
                                                                                                                                        • -
                                                                                                                                      • Changed
                                                                                                                                        • -
                                                                                                                                      • Fixed
                                                                                                                                        • +
                                                                                                                                      • 5.2.0 - 2024-01-02
                                                                                                                                        • -
                                                                                                                                      • 5.0.0 - 2022-10-30
                                                                                                                                          +
                                                                                                                                        • 5.1.1 - 2023-02-20 +
                                                                                                                                          • +
                                                                                                                                        • 5.1.0 - 2023-01-22 +
                                                                                                                                          • +
                                                                                                                                        • 5.0.0 - 2022-10-30
                                                                                                                                          • -
                                                                                                                                        • 4.5.0 - 2021-12-26
                                                                                                                                            -
                                                                                                                                          • Added
                                                                                                                                            • -
                                                                                                                                          • Changed
                                                                                                                                            • -
                                                                                                                                          • Fixed
                                                                                                                                            • +
                                                                                                                                          • 4.5.0 - 2021-12-26
                                                                                                                                            • -
                                                                                                                                          • 4.4.0 - 2020-12-20
                                                                                                                                              -
                                                                                                                                            • Added
                                                                                                                                              • -
                                                                                                                                            • Changed
                                                                                                                                              • -
                                                                                                                                            • Fixed
                                                                                                                                              • +
                                                                                                                                            • 4.4.0 - 2020-12-20
                                                                                                                                              • -
                                                                                                                                            • 4.3.1 - 2020-07-17
                                                                                                                                                -
                                                                                                                                              • Added
                                                                                                                                                • -
                                                                                                                                              • Changed
                                                                                                                                                • -
                                                                                                                                              • Fixed
                                                                                                                                                • +
                                                                                                                                              • 4.3.1 - 2020-07-17
                                                                                                                                                • -
                                                                                                                                              • 4.3.0 - 2020-06-27
                                                                                                                                                  -
                                                                                                                                                • Added
                                                                                                                                                  • -
                                                                                                                                                • Changed
                                                                                                                                                  • -
                                                                                                                                                • Fixed
                                                                                                                                                  • +
                                                                                                                                                • 4.3.0 - 2020-06-27
                                                                                                                                                  • -
                                                                                                                                                • 4.2.0 - 2020-06-06
                                                                                                                                                    -
                                                                                                                                                  • Added
                                                                                                                                                    • -
                                                                                                                                                  • Changed
                                                                                                                                                    • -
                                                                                                                                                  • Fixed
                                                                                                                                                    • +
                                                                                                                                                  • 4.2.0 - 2020-06-06
                                                                                                                                                    • -
                                                                                                                                                  • 4.1.0 - 2020-05-18
                                                                                                                                                      -
                                                                                                                                                    • Added
                                                                                                                                                      • -
                                                                                                                                                    • Changed
                                                                                                                                                      • -
                                                                                                                                                    • Fixed
                                                                                                                                                      • +
                                                                                                                                                    • 4.1.0 - 2020-05-18
                                                                                                                                                      • -
                                                                                                                                                    • 4.0.0 - 2020-04-28
                                                                                                                                                        -
                                                                                                                                                      • Breaking Changes
                                                                                                                                                        • -
                                                                                                                                                      • Added
                                                                                                                                                        • -
                                                                                                                                                      • Changed
                                                                                                                                                        • -
                                                                                                                                                      • Fixed
                                                                                                                                                        • +
                                                                                                                                                      • 4.0.0 - 2020-04-28
                                                                                                                                                        • -
                                                                                                                                                      • 3.0.1 - 2020-03-04
                                                                                                                                                          -
                                                                                                                                                        • Fixed
                                                                                                                                                          • +
                                                                                                                                                        • 3.0.1 - 2020-03-04
                                                                                                                                                          • -
                                                                                                                                                        • 3.0.0 - 2020-03-04
                                                                                                                                                            -
                                                                                                                                                          • Breaking Changes
                                                                                                                                                            • -
                                                                                                                                                          • Added
                                                                                                                                                            • -
                                                                                                                                                          • Changed
                                                                                                                                                            • -
                                                                                                                                                          • Fixed
                                                                                                                                                            • +
                                                                                                                                                          • 3.0.0 - 2020-03-04
                                                                                                                                                            • -
                                                                                                                                                          • 2.0.0 - 2019-10-16
                                                                                                                                                              -
                                                                                                                                                            • Breaking Changes
                                                                                                                                                              • -
                                                                                                                                                            • Added
                                                                                                                                                              • -
                                                                                                                                                            • Changed
                                                                                                                                                              • -
                                                                                                                                                            • Fixed
                                                                                                                                                              • +
                                                                                                                                                            • 2.0.0 - 2019-10-16
                                                                                                                                                              • -
                                                                                                                                                            • 1.2.2 - 2019-05-16
                                                                                                                                                                -
                                                                                                                                                              • Added
                                                                                                                                                                • -
                                                                                                                                                              • Changed
                                                                                                                                                                • -
                                                                                                                                                              • Fixed
                                                                                                                                                                • +
                                                                                                                                                              • 1.2.2 - 2019-05-16
                                                                                                                                                                • -
                                                                                                                                                              • 1.2.1 - 2019-02-16
                                                                                                                                                                  -
                                                                                                                                                                • Added
                                                                                                                                                                  • -
                                                                                                                                                                • Fixed
                                                                                                                                                                  • +
                                                                                                                                                                • 1.2.1 - 2019-02-16
                                                                                                                                                                  • -
                                                                                                                                                                • 1.2.0 - 2019-02-04
                                                                                                                                                                    -
                                                                                                                                                                  • Breaking Changes
                                                                                                                                                                    • -
                                                                                                                                                                  • Added
                                                                                                                                                                    • -
                                                                                                                                                                  • Changed
                                                                                                                                                                    • -
                                                                                                                                                                  • Fixed
                                                                                                                                                                    • +
                                                                                                                                                                  • 1.2.0 - 2019-02-04
                                                                                                                                                                    • -
                                                                                                                                                                  • 1.1.0 - 2018-12-27
                                                                                                                                                                  • Related Projects
                                                                                                                                                                    • diff --git a/docs/manual/project-files.html b/docs/manual/project-files.html index a5c9e1a1..5e9c44dc 100644 --- a/docs/manual/project-files.html +++ b/docs/manual/project-files.html @@ -220,124 +220,134 @@
                                                                                                                                                                    • Changelog
                                                                                                                                                                      • Unreleased
                                                                                                                                                                        • -
                                                                                                                                                                      • 5.3.0 - 2024-01-15
                                                                                                                                                                          -
                                                                                                                                                                        • Added
                                                                                                                                                                          • -
                                                                                                                                                                        • Changed
                                                                                                                                                                          • +
                                                                                                                                                                        • 5.4.1 - 2024-03-21
                                                                                                                                                                          • -
                                                                                                                                                                        • 5.2.0 - 2024-01-02
                                                                                                                                                                            -
                                                                                                                                                                          • Added
                                                                                                                                                                            • -
                                                                                                                                                                          • Changed
                                                                                                                                                                            • -
                                                                                                                                                                          • Fixed
                                                                                                                                                                            • +
                                                                                                                                                                          • 5.4.0 - 2024-02-13
                                                                                                                                                                            • -
                                                                                                                                                                          • 5.1.1 - 2023-02-20
                                                                                                                                                                              -
                                                                                                                                                                            • Added
                                                                                                                                                                              • -
                                                                                                                                                                            • Changed
                                                                                                                                                                              • -
                                                                                                                                                                            • Fixed
                                                                                                                                                                              • +
                                                                                                                                                                            • 5.3.0 - 2024-01-15
                                                                                                                                                                              • -
                                                                                                                                                                            • 5.1.0 - 2023-01-22
                                                                                                                                                                                -
                                                                                                                                                                              • Added
                                                                                                                                                                                • -
                                                                                                                                                                              • Changed
                                                                                                                                                                                • -
                                                                                                                                                                              • Fixed
                                                                                                                                                                                • +
                                                                                                                                                                              • 5.2.0 - 2024-01-02
                                                                                                                                                                                • -
                                                                                                                                                                              • 5.0.0 - 2022-10-30
                                                                                                                                                                                  +
                                                                                                                                                                                • 5.1.1 - 2023-02-20 +
                                                                                                                                                                                  • +
                                                                                                                                                                                • 5.1.0 - 2023-01-22 +
                                                                                                                                                                                  • +
                                                                                                                                                                                • 5.0.0 - 2022-10-30
                                                                                                                                                                                  • -
                                                                                                                                                                                • 4.5.0 - 2021-12-26
                                                                                                                                                                                    -
                                                                                                                                                                                  • Added
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Changed
                                                                                                                                                                                    • -
                                                                                                                                                                                  • Fixed
                                                                                                                                                                                    • +
                                                                                                                                                                                  • 4.5.0 - 2021-12-26
                                                                                                                                                                                    • -
                                                                                                                                                                                  • 4.4.0 - 2020-12-20
                                                                                                                                                                                      -
                                                                                                                                                                                    • Added
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Changed
                                                                                                                                                                                      • -
                                                                                                                                                                                    • Fixed
                                                                                                                                                                                      • +
                                                                                                                                                                                    • 4.4.0 - 2020-12-20
                                                                                                                                                                                      • -
                                                                                                                                                                                    • 4.3.1 - 2020-07-17
                                                                                                                                                                                        -
                                                                                                                                                                                      • Added
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Changed
                                                                                                                                                                                        • -
                                                                                                                                                                                      • Fixed
                                                                                                                                                                                        • +
                                                                                                                                                                                      • 4.3.1 - 2020-07-17
                                                                                                                                                                                        • -
                                                                                                                                                                                      • 4.3.0 - 2020-06-27
                                                                                                                                                                                          -
                                                                                                                                                                                        • Added
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Changed
                                                                                                                                                                                          • -
                                                                                                                                                                                        • Fixed
                                                                                                                                                                                          • +
                                                                                                                                                                                        • 4.3.0 - 2020-06-27
                                                                                                                                                                                          • -
                                                                                                                                                                                        • 4.2.0 - 2020-06-06
                                                                                                                                                                                            -
                                                                                                                                                                                          • Added
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Changed
                                                                                                                                                                                            • -
                                                                                                                                                                                          • Fixed
                                                                                                                                                                                            • +
                                                                                                                                                                                          • 4.2.0 - 2020-06-06
                                                                                                                                                                                            • -
                                                                                                                                                                                          • 4.1.0 - 2020-05-18
                                                                                                                                                                                              -
                                                                                                                                                                                            • Added
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Changed
                                                                                                                                                                                              • -
                                                                                                                                                                                            • Fixed
                                                                                                                                                                                              • +
                                                                                                                                                                                            • 4.1.0 - 2020-05-18
                                                                                                                                                                                              • -
                                                                                                                                                                                            • 4.0.0 - 2020-04-28
                                                                                                                                                                                                -
                                                                                                                                                                                              • Breaking Changes
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Added
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Changed
                                                                                                                                                                                                • -
                                                                                                                                                                                              • Fixed
                                                                                                                                                                                                • +
                                                                                                                                                                                              • 4.0.0 - 2020-04-28
                                                                                                                                                                                                • -
                                                                                                                                                                                              • 3.0.1 - 2020-03-04
                                                                                                                                                                                                  -
                                                                                                                                                                                                • Fixed
                                                                                                                                                                                                  • +
                                                                                                                                                                                                • 3.0.1 - 2020-03-04
                                                                                                                                                                                                  • -
                                                                                                                                                                                                • 3.0.0 - 2020-03-04
                                                                                                                                                                                                    -
                                                                                                                                                                                                  • Breaking Changes
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  • Added
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                    • +
                                                                                                                                                                                                  • 3.0.0 - 2020-03-04
                                                                                                                                                                                                    • -
                                                                                                                                                                                                  • 2.0.0 - 2019-10-16
                                                                                                                                                                                                      -
                                                                                                                                                                                                    • Breaking Changes
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Added
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Changed
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • Fixed
                                                                                                                                                                                                      • +
                                                                                                                                                                                                    • 2.0.0 - 2019-10-16
                                                                                                                                                                                                      • -
                                                                                                                                                                                                    • 1.2.2 - 2019-05-16
                                                                                                                                                                                                        -
                                                                                                                                                                                                      • Added
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      • Changed
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      • Fixed
                                                                                                                                                                                                        • +
                                                                                                                                                                                                      • 1.2.2 - 2019-05-16
                                                                                                                                                                                                        • -
                                                                                                                                                                                                      • 1.2.1 - 2019-02-16
                                                                                                                                                                                                          -
                                                                                                                                                                                                        • Added
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • Fixed
                                                                                                                                                                                                          • +
                                                                                                                                                                                                        • 1.2.1 - 2019-02-16
                                                                                                                                                                                                          • -
                                                                                                                                                                                                        • 1.2.0 - 2019-02-04
                                                                                                                                                                                                            -
                                                                                                                                                                                                          • Breaking Changes
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Added
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Changed
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • Fixed
                                                                                                                                                                                                            • +
                                                                                                                                                                                                          • 1.2.0 - 2019-02-04
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          • 1.1.0 - 2018-12-27
                                                                                                                                                                                                          • Related Projects
                                                                                                                                                                                                            • diff --git a/docs/manual/scripting-capabilities.html b/docs/manual/scripting-capabilities.html index b37a149c..3826c6a6 100644 --- a/docs/manual/scripting-capabilities.html +++ b/docs/manual/scripting-capabilities.html @@ -220,124 +220,134 @@
                                                                                                                                                                                                            • Changelog
                                                                                                                                                                                                              • Unreleased
                                                                                                                                                                                                                • -
                                                                                                                                                                                                              • 5.3.0 - 2024-01-15
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                • Added
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • Changed
                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                • 5.4.1 - 2024-03-21
                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                • 5.2.0 - 2024-01-02
                                                                                                                                                                                                                    -
                                                                                                                                                                                                                  • Added
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                  • 5.4.0 - 2024-02-13
                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                  • 5.1.1 - 2023-02-20
                                                                                                                                                                                                                      -
                                                                                                                                                                                                                    • Added
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Changed
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • Fixed
                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                    • 5.3.0 - 2024-01-15
                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                    • 5.1.0 - 2023-01-22
                                                                                                                                                                                                                        -
                                                                                                                                                                                                                      • Added
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Changed
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • Fixed
                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                      • 5.2.0 - 2024-01-02
                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                      • 5.0.0 - 2022-10-30
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                        • 5.1.1 - 2023-02-20 +
                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                        • 5.1.0 - 2023-01-22 +
                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                        • 5.0.0 - 2022-10-30
                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                        • 4.5.0 - 2021-12-26
                                                                                                                                                                                                                            -
                                                                                                                                                                                                                          • Added
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Changed
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • Fixed
                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                          • 4.5.0 - 2021-12-26
                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                          • 4.4.0 - 2020-12-20
                                                                                                                                                                                                                              -
                                                                                                                                                                                                                            • Added
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Changed
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • Fixed
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            • 4.4.0 - 2020-12-20
                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                            • 4.3.1 - 2020-07-17
                                                                                                                                                                                                                                -
                                                                                                                                                                                                                              • Added
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Changed
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • Fixed
                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                              • 4.3.1 - 2020-07-17
                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                              • 4.3.0 - 2020-06-27
                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                • Added
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Changed
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • Fixed
                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                • 4.3.0 - 2020-06-27
                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                • 4.2.0 - 2020-06-06
                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                  • Added
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                  • 4.2.0 - 2020-06-06
                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                  • 4.1.0 - 2020-05-18
                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • Added
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Changed
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • Fixed
                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                    • 4.1.0 - 2020-05-18
                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                    • 4.0.0 - 2020-04-28
                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                      • Breaking Changes
                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                      • Added
                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                      • Changed
                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                      • Fixed
                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                      • 4.0.0 - 2020-04-28
                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                      • 3.0.1 - 2020-03-04
                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                        • Fixed
                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                        • 3.0.1 - 2020-03-04
                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                        • 3.0.0 - 2020-03-04
                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                          • Breaking Changes
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Added
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Changed
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • Fixed
                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                          • 3.0.0 - 2020-03-04
                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                          • 2.0.0 - 2019-10-16
                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                            • Breaking Changes
                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                            • Added
                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                            • Changed
                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                            • Fixed
                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                            • 2.0.0 - 2019-10-16
                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                            • 1.2.2 - 2019-05-16
                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                              • Added
                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                              • Changed
                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                              • Fixed
                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                              • 1.2.2 - 2019-05-16
                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                              • 1.2.1 - 2019-02-16
                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                • Added
                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                • Fixed
                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                • 1.2.1 - 2019-02-16
                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                • 1.2.0 - 2019-02-04
                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                  • Breaking Changes
                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                  • Added
                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                  • 1.2.0 - 2019-02-04
                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                  • 1.1.0 - 2018-12-27
                                                                                                                                                                                                                                                  • Related Projects
                                                                                                                                                                                                                                                    • diff --git a/docs/manual/settings-and-options.html b/docs/manual/settings-and-options.html index 067c507c..4444e788 100644 --- a/docs/manual/settings-and-options.html +++ b/docs/manual/settings-and-options.html @@ -220,124 +220,134 @@
                                                                                                                                                                                                                                                    • Changelog
                                                                                                                                                                                                                                                      • Unreleased
                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                      • 5.3.0 - 2024-01-15
                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                        • Added
                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                        • Changed
                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                        • 5.4.1 - 2024-03-21
                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                        • 5.2.0 - 2024-01-02
                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                          • Added
                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                          • Changed
                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                          • Fixed
                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                          • 5.4.0 - 2024-02-13
                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                          • 5.1.1 - 2023-02-20
                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                            • Added
                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                            • Changed
                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                            • Fixed
                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                            • 5.3.0 - 2024-01-15
                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                            • 5.1.0 - 2023-01-22
                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                              • Added
                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                              • Changed
                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                              • Fixed
                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                              • 5.2.0 - 2024-01-02
                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                              • 5.0.0 - 2022-10-30
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                • 5.1.1 - 2023-02-20 +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                • 5.1.0 - 2023-01-22 +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                • 5.0.0 - 2022-10-30
                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                • 4.5.0 - 2021-12-26
                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                  • Added
                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                  • 4.5.0 - 2021-12-26
                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                  • 4.4.0 - 2020-12-20
                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                    • Added
                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                    • Changed
                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                    • Fixed
                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                    • 4.4.0 - 2020-12-20
                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                    • 4.3.1 - 2020-07-17
                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                      • Added
                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                      • Changed
                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                      • Fixed
                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                      • 4.3.1 - 2020-07-17
                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                      • 4.3.0 - 2020-06-27
                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                        • Added
                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                        • Changed
                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                        • Fixed
                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                        • 4.3.0 - 2020-06-27
                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                        • 4.2.0 - 2020-06-06
                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                          • Added
                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                          • Changed
                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                          • Fixed
                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                          • 4.2.0 - 2020-06-06
                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                          • 4.1.0 - 2020-05-18
                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                            • Added
                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                            • Changed
                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                            • Fixed
                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                            • 4.1.0 - 2020-05-18
                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                            • 4.0.0 - 2020-04-28
                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                              • Breaking Changes
                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                              • Added
                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                              • Changed
                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                              • Fixed
                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                              • 4.0.0 - 2020-04-28
                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                              • 3.0.1 - 2020-03-04
                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                • Fixed
                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                • 3.0.1 - 2020-03-04
                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                • 3.0.0 - 2020-03-04
                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                  • Breaking Changes
                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                  • Added
                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                  • 3.0.0 - 2020-03-04
                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                  • 2.0.0 - 2019-10-16
                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                    • Breaking Changes
                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                    • Added
                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                    • Changed
                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                    • Fixed
                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                    • 2.0.0 - 2019-10-16
                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                    • 1.2.2 - 2019-05-16
                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                      • Added
                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                      • Changed
                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                      • Fixed
                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                      • 1.2.2 - 2019-05-16
                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                      • 1.2.1 - 2019-02-16
                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Added
                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                        • Fixed
                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                        • 1.2.1 - 2019-02-16
                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                        • 1.2.0 - 2019-02-04
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Breaking Changes
                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                          • Added
                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                          • Changed
                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                          • Fixed
                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                          • 1.2.0 - 2019-02-04
                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                          • 1.1.0 - 2018-12-27
                                                                                                                                                                                                                                                                                          • Related Projects
                                                                                                                                                                                                                                                                                            • diff --git a/docs/manual/tileset-editor.html b/docs/manual/tileset-editor.html index afe77b37..e319a0f5 100644 --- a/docs/manual/tileset-editor.html +++ b/docs/manual/tileset-editor.html @@ -220,124 +220,134 @@
                                                                                                                                                                                                                                                                                            • Changelog
                                                                                                                                                                                                                                                                                              • Unreleased
                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                              • 5.3.0 - 2024-01-15
                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                • Added
                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                • Changed
                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                • 5.4.1 - 2024-03-21
                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                • 5.2.0 - 2024-01-02
                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                  • Added
                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                  • 5.4.0 - 2024-02-13
                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                  • 5.1.1 - 2023-02-20
                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                    • Added
                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                    • Changed
                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                    • Fixed
                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                    • 5.3.0 - 2024-01-15
                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                    • 5.1.0 - 2023-01-22
                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                      • Added
                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                      • Changed
                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                      • Fixed
                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                      • 5.2.0 - 2024-01-02
                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                      • 5.0.0 - 2022-10-30
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                        • 5.1.1 - 2023-02-20 +
                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                        • 5.1.0 - 2023-01-22 +
                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                        • 5.0.0 - 2022-10-30
                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                        • 4.5.0 - 2021-12-26
                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                          • Added
                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                          • Changed
                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                          • Fixed
                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                          • 4.5.0 - 2021-12-26
                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                          • 4.4.0 - 2020-12-20
                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                            • Added
                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                            • Changed
                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                            • Fixed
                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                            • 4.4.0 - 2020-12-20
                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                            • 4.3.1 - 2020-07-17
                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                              • Added
                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                              • Changed
                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                              • Fixed
                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                              • 4.3.1 - 2020-07-17
                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                              • 4.3.0 - 2020-06-27
                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                • Added
                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                • Changed
                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                • Fixed
                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                • 4.3.0 - 2020-06-27
                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                • 4.2.0 - 2020-06-06
                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                  • Added
                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                  • 4.2.0 - 2020-06-06
                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                  • 4.1.0 - 2020-05-18
                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                    • Added
                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                    • Changed
                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                    • Fixed
                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                    • 4.1.0 - 2020-05-18
                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                    • 4.0.0 - 2020-04-28
                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Breaking Changes
                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                      • Added
                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                      • Changed
                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                      • Fixed
                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                      • 4.0.0 - 2020-04-28
                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                      • 3.0.1 - 2020-03-04
                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Fixed
                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                        • 3.0.1 - 2020-03-04
                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                        • 3.0.0 - 2020-03-04
                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                          • Breaking Changes
                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                          • Added
                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                          • Changed
                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                          • Fixed
                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                          • 3.0.0 - 2020-03-04
                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                          • 2.0.0 - 2019-10-16
                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Breaking Changes
                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                            • Added
                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                            • Changed
                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                            • Fixed
                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                            • 2.0.0 - 2019-10-16
                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                            • 1.2.2 - 2019-05-16
                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                              • Added
                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                              • Changed
                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                              • Fixed
                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                              • 1.2.2 - 2019-05-16
                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                              • 1.2.1 - 2019-02-16
                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Added
                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                • Fixed
                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                • 1.2.1 - 2019-02-16
                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                • 1.2.0 - 2019-02-04
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                  • Breaking Changes
                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                  • Added
                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                  • 1.2.0 - 2019-02-04
                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                  • 1.1.0 - 2018-12-27
                                                                                                                                                                                                                                                                                                                                  • Related Projects
                                                                                                                                                                                                                                                                                                                                    • diff --git a/docs/reference/changelog.html b/docs/reference/changelog.html index 6ede1718..23f4b65f 100644 --- a/docs/reference/changelog.html +++ b/docs/reference/changelog.html @@ -220,124 +220,134 @@
                                                                                                                                                                                                                                                                                                                                    • Changelog
                                                                                                                                                                                                                                                                                                                                      • Unreleased
                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                      • 5.3.0 - 2024-01-15
                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                        • Added
                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                        • Changed
                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                        • 5.4.1 - 2024-03-21
                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                        • 5.2.0 - 2024-01-02
                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                          • Added
                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                          • Changed
                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                          • Fixed
                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                          • 5.4.0 - 2024-02-13
                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                          • 5.1.1 - 2023-02-20
                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                            • Added
                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                            • Changed
                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                            • Fixed
                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                            • 5.3.0 - 2024-01-15
                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                            • 5.1.0 - 2023-01-22
                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                              • Added
                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                              • Changed
                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                              • Fixed
                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                              • 5.2.0 - 2024-01-02
                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                              • 5.0.0 - 2022-10-30
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • 5.1.1 - 2023-02-20 +
                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                • 5.1.0 - 2023-01-22 +
                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                • 5.0.0 - 2022-10-30
                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                • 4.5.0 - 2021-12-26
                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • Added
                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                  • 4.5.0 - 2021-12-26
                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                  • 4.4.0 - 2020-12-20
                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Added
                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                    • Changed
                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                    • Fixed
                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                    • 4.4.0 - 2020-12-20
                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                    • 4.3.1 - 2020-07-17
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Added
                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                      • Changed
                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                      • Fixed
                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                      • 4.3.1 - 2020-07-17
                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                      • 4.3.0 - 2020-06-27
                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • Added
                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                        • Changed
                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                        • Fixed
                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                        • 4.3.0 - 2020-06-27
                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                        • 4.2.0 - 2020-06-06
                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                          • Added
                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                          • Changed
                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                          • Fixed
                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                          • 4.2.0 - 2020-06-06
                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                          • 4.1.0 - 2020-05-18
                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                            • Added
                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                            • Changed
                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                            • Fixed
                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                            • 4.1.0 - 2020-05-18
                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                            • 4.0.0 - 2020-04-28
                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                              • Breaking Changes
                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                              • Added
                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                              • Changed
                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                              • Fixed
                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                              • 4.0.0 - 2020-04-28
                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                              • 3.0.1 - 2020-03-04
                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                • Fixed
                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                • 3.0.1 - 2020-03-04
                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                • 3.0.0 - 2020-03-04
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                  • Breaking Changes
                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                  • Added
                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                  • 3.0.0 - 2020-03-04
                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                  • 2.0.0 - 2019-10-16
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                    • Breaking Changes
                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                    • Added
                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                    • Changed
                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                    • Fixed
                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                    • 2.0.0 - 2019-10-16
                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                    • 1.2.2 - 2019-05-16
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                      • Added
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Changed
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Fixed
                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                      • 1.2.2 - 2019-05-16
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • 1.2.1 - 2019-02-16
                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                        • Added
                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                        • Fixed
                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                        • 1.2.1 - 2019-02-16
                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                        • 1.2.0 - 2019-02-04
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                          • Breaking Changes
                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                          • Added
                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                          • Changed
                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                          • Fixed
                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                          • 1.2.0 - 2019-02-04
                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                          • 1.1.0 - 2018-12-27
                                                                                                                                                                                                                                                                                                                                                                          • Related Projects
                                                                                                                                                                                                                                                                                                                                                                            • @@ -414,21 +424,57 @@ and this project somewhat adheres to Semantic Versioning. The MAJOR version number is bumped when there are breaking changes in the pret projects.

                                                                                                                                                                                                                                                                                                                                                                            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. It also includes changes to the scripting API that may change the behavior of existing porymap scripts. If porymap is used with a project or API script that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly.

                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                            Unreleased

                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Unreleased

                                                                                                                                                                                                                                                                                                                                                                            Nothing, yet.

                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                            5.3.0 - 2024-01-15

                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            5.4.1 - 2024-03-21

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Fixed

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                            • Fix object event sprites not loading for some struct data formats.
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            5.4.0 - 2024-02-13

                                                                                                                                                                                                                                                                                                                                                                            Added

                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                            • Add a Check for Updates option to show new releases (Windows and macOS only).
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Changed

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                            • If Wild Encounters fail to load they are now only disabled for that session, and the settings remain unchanged.
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            • Defaults are used if project constants are missing, rather than failing to open the project or changing settings.
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            • Selector images now center on the selection when eyedropping or zooming.
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Fixed

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                            • Fix some minor visual issues with the various zoom sliders.
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            • Smooth out scrolling when mouse is over tile/metatile images.
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            • Fix the Tileset Editor selectors getting extra white space when changing tilesets.
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            • Fix a crash when adding disabled events with the Pencil tool.
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            • Fix error log about failing to find the scripts file when a new map is created.
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            5.3.0 - 2024-01-15

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Added

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            • Add zoom sliders to the Tileset Editor.
                                                                                                                                                                                                                                                                                                                                                                            • Add getMetatileBehaviorName and setMetatileBehaviorName to the API.
                                                                                                                                                                                                                                                                                                                                                                            • Add metatile_behaviors, num_primary_palettes, and num_secondary_palettes to constants in the API.
                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                            Changed

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Changed

                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                            Fixed

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Fixed

                                                                                                                                                                                                                                                                                                                                                                            • Fix the metatile selector rectangle jumping when selecting up or left of the origin.
                                                                                                                                                                                                                                                                                                                                                                            • Fix the event group tabs sometimes showing an event from the wrong group.
                                                                                                                                                                                                                                                                                                                                                                              • @@ -453,10 +499,10 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                              5.2.0 - 2024-01-02

                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                              Added

                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              5.2.0 - 2024-01-02

                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              Added

                                                                                                                                                                                                                                                                                                                                                                              • Add an editor window under Options -> Project Settings... to customize the project-specific settings in porymap.project.cfg and porymap.user.cfg.
                                                                                                                                                                                                                                                                                                                                                                              • Add an editor window under Options -> Custom Scripts... for Porymap’s API scripts.
                                                                                                                                                                                                                                                                                                                                                                                • @@ -470,8 +516,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                Changed

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                Changed

                                                                                                                                                                                                                                                                                                                                                                                • Script dropdowns now include scripts from the current map’s scripts file.
                                                                                                                                                                                                                                                                                                                                                                                • Encounter Rate now defaults to the most commonly used value, rather than 0.
                                                                                                                                                                                                                                                                                                                                                                                  • @@ -486,8 +532,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                  Fixed

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  Fixed

                                                                                                                                                                                                                                                                                                                                                                                  • Fix text boxes in the Palette Editor calculating color incorrectly.
                                                                                                                                                                                                                                                                                                                                                                                  • Fix metatile labels being sorted incorrectly for tileset names with multiple underscores.
                                                                                                                                                                                                                                                                                                                                                                                    • @@ -509,23 +555,23 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                    5.1.1 - 2023-02-20

                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                    Added

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    5.1.1 - 2023-02-20

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    Added

                                                                                                                                                                                                                                                                                                                                                                                    • Add registerToggleAction to the scripting API
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                    Changed

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    Changed

                                                                                                                                                                                                                                                                                                                                                                                    • Change encounter tab copy and paste behavior.
                                                                                                                                                                                                                                                                                                                                                                                    • A warning will appear if a custom script fails to load or an action fails to run.
                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                    Fixed

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    Fixed

                                                                                                                                                                                                                                                                                                                                                                                    • Fix null characters being unpredictably written to some JSON files.
                                                                                                                                                                                                                                                                                                                                                                                    • Fix tilesets that share part of their name loading incorrectly.
                                                                                                                                                                                                                                                                                                                                                                                      • @@ -541,10 +587,10 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                      5.1.0 - 2023-01-22

                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                      Added

                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      5.1.0 - 2023-01-22

                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Added

                                                                                                                                                                                                                                                                                                                                                                                      • Add new config options for reorganizing metatile attributes.
                                                                                                                                                                                                                                                                                                                                                                                      • Add setScale to the scripting API.
                                                                                                                                                                                                                                                                                                                                                                                        • @@ -552,8 +598,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                        Changed

                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Changed

                                                                                                                                                                                                                                                                                                                                                                                        • Double-clicking on a connecting map on the Map or Events tabs will now open that map.
                                                                                                                                                                                                                                                                                                                                                                                        • Hovering on border metatiles with the mouse will now display their information in the bottom bar.
                                                                                                                                                                                                                                                                                                                                                                                          • @@ -562,8 +608,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                          Fixed

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Fixed

                                                                                                                                                                                                                                                                                                                                                                                          • Fix the Region Map Editor being opened by the Shortcuts Editor.
                                                                                                                                                                                                                                                                                                                                                                                          • Fix New Map settings being preserved when switching projects.
                                                                                                                                                                                                                                                                                                                                                                                            • @@ -576,8 +622,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                            5.0.0 - 2022-10-30

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            5.0.0 - 2022-10-30

                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                            Added

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            Added

                                                                                                                                                                                                                                                                                                                                                                                            • Add prefab support
                                                                                                                                                                                                                                                                                                                                                                                            • Add Cut/Copy/Paste for metatiles in the Tileset Editor.
                                                                                                                                                                                                                                                                                                                                                                                              • @@ -601,8 +647,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                              Changed

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Changed

                                                                                                                                                                                                                                                                                                                                                                                              • Previous settings will be remembered in the New Map Options window.
                                                                                                                                                                                                                                                                                                                                                                                              • The Custom Attributes table for map headers and events now supports types other than strings.
                                                                                                                                                                                                                                                                                                                                                                                                • @@ -626,8 +672,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                Fixed

                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Fixed

                                                                                                                                                                                                                                                                                                                                                                                                • Fix events losing their assigned script when the script autocomplete is used.
                                                                                                                                                                                                                                                                                                                                                                                                • Fix the unsaved changes indicator not disappearing when saving changes to events.
                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -653,10 +699,10 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                  4.5.0 - 2021-12-26

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                  Added

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  4.5.0 - 2021-12-26

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                  Added

                                                                                                                                                                                                                                                                                                                                                                                                  • WSL project paths are now supported. (For example, \wsl$\Ubuntu-20.04\home\huderlem\pokeemerald)
                                                                                                                                                                                                                                                                                                                                                                                                  • Add ability to export map timelapse animated GIFs with File -> Export Map Timelapse Image....
                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -668,8 +714,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                    Changed

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    Changed

                                                                                                                                                                                                                                                                                                                                                                                                    • New events will be placed in the center of the current view of the map.
                                                                                                                                                                                                                                                                                                                                                                                                    • Scripting API errors are more detailed and logged in more situations.
                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -678,8 +724,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                      Fixed

                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      Fixed

                                                                                                                                                                                                                                                                                                                                                                                                      • Fix % operator in C defines not being evaluated
                                                                                                                                                                                                                                                                                                                                                                                                      • Fix tileset palette editor crash that could occur when switching maps or tilesets with it open.
                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -689,10 +735,10 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                        4.4.0 - 2020-12-20

                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                        Added

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        4.4.0 - 2020-12-20

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        Added

                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                        Changed

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        Changed

                                                                                                                                                                                                                                                                                                                                                                                                        • Holding shift now toggles “Smart Path” drawing; when the “Smart Paths” checkbox is checked, holding shift will temporarily disable it.
                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                        Fixed

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        Fixed

                                                                                                                                                                                                                                                                                                                                                                                                        • Fix a bug with the current metatile selection zoom.
                                                                                                                                                                                                                                                                                                                                                                                                        • Fix bug preventing the status bar from updating the current position while dragging events.
                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -726,26 +772,26 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                          4.3.1 - 2020-07-17

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                          Added

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          4.3.1 - 2020-07-17

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          Added

                                                                                                                                                                                                                                                                                                                                                                                                          • Add keyboard shortcut Ctrl + D for duplicating map events.
                                                                                                                                                                                                                                                                                                                                                                                                          • Add keyboard shortcut Ctrl + Shift + Z for “redo” in the tileset editor.
                                                                                                                                                                                                                                                                                                                                                                                                          • Add scripting api to reorder metatile layers and draw them with opacity.
                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                          Changed

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          Changed

                                                                                                                                                                                                                                                                                                                                                                                                          • The tileset editor now syncs its metatile selection with the map’s metatile selector.
                                                                                                                                                                                                                                                                                                                                                                                                          • The number of object events per map is now limited to OBJECT_EVENT_TEMPLATES_COUNT
                                                                                                                                                                                                                                                                                                                                                                                                          • The tileset editor can now flip selections that were taken from an existing metatile.
                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                          Fixed

                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          Fixed

                                                                                                                                                                                                                                                                                                                                                                                                          • Fix bug where editing a metatile layer would have no effect.
                                                                                                                                                                                                                                                                                                                                                                                                          • Fix a crash that occured when creating a new tileset using triple layer mode.
                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -756,22 +802,22 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                            4.3.0 - 2020-06-27

                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                            Added

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            4.3.0 - 2020-06-27

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            Added

                                                                                                                                                                                                                                                                                                                                                                                                            • Add triple-layer metatiles support.
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                            Changed

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            Changed

                                                                                                                                                                                                                                                                                                                                                                                                            • The “Open Scripts” button will fall back to scripts.inc if scripts.pory doesn’t exist.
                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                            Fixed

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            Fixed

                                                                                                                                                                                                                                                                                                                                                                                                            • Fix bug where exported tileset images could be horizontally or vertically flipped.
                                                                                                                                                                                                                                                                                                                                                                                                            • Fix bug where the map list wasn’t filtered properly after switching filter types.
                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -779,47 +825,47 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                              4.2.0 - 2020-06-06

                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                              Added

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              4.2.0 - 2020-06-06

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              Added

                                                                                                                                                                                                                                                                                                                                                                                                              • Add more project-specific configs to better support porting features from different projects.
                                                                                                                                                                                                                                                                                                                                                                                                              • Add metatile label names to the status bar when hovering over metatiles in the map editor tab.
                                                                                                                                                                                                                                                                                                                                                                                                              • Add mouse coordinates to the status bar when hovering in the events tab.
                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                              Changed

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              Changed

                                                                                                                                                                                                                                                                                                                                                                                                              • metatile_labels.h is now watched for changes.
                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                              Fixed

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              Fixed

                                                                                                                                                                                                                                                                                                                                                                                                              • Reduce time it takes to load maps and save in the tileset editor.
                                                                                                                                                                                                                                                                                                                                                                                                              • Fix crash that could occur when parsing unknown symbols when evaluating define expressions.
                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                              4.1.0 - 2020-05-18

                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                              Added

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              4.1.0 - 2020-05-18

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              Added

                                                                                                                                                                                                                                                                                                                                                                                                              • Add scripting capabilities, which allows the user to add custom behavior to Porymap using JavaScript scripts.
                                                                                                                                                                                                                                                                                                                                                                                                              • Add ability to import FRLG tileset .bvd files from Advance Map 1.92.
                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                              Changed

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              Changed

                                                                                                                                                                                                                                                                                                                                                                                                              • Edit modes are no longer shared between the Map and Events tabs. Pencil is default for Map tab, and Pointer is default for Events tab.
                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                              Fixed

                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              Fixed

                                                                                                                                                                                                                                                                                                                                                                                                              • Disallow drawing new heal locations in the events tab.
                                                                                                                                                                                                                                                                                                                                                                                                              • Fix issue where the metatile selection window was not resizable.
                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -830,16 +876,16 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                                4.0.0 - 2020-04-28

                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                Breaking Changes

                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                4.0.0 - 2020-04-28

                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                Breaking Changes

                                                                                                                                                                                                                                                                                                                                                                                                                • If you are using pokeemerald or pokeruby, there were changes made in pokeemerald/#1010 and pokeruby/#776 that you will need to integrate in order to use this version of porymap.
                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                Added

                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                Added

                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                Changed

                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                Changed

                                                                                                                                                                                                                                                                                                                                                                                                                • Porymap now saves map and encounter json data in an order consistent with the upstream repos. This will provide more comprehensible diffs when files are saved.
                                                                                                                                                                                                                                                                                                                                                                                                                • Update Porymap icon.
                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -859,8 +905,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                                  Fixed

                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                  Fixed

                                                                                                                                                                                                                                                                                                                                                                                                                  • Fix bug where pressing TAB key did not navigate through widgets in the wild encounter tables.
                                                                                                                                                                                                                                                                                                                                                                                                                  • Fix bug that allowed selecting an invalid metatile in the metatile selector.
                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -869,19 +915,19 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                                    3.0.1 - 2020-03-04

                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                    Fixed

                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                    3.0.0 - 2020-03-04

                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                    Breaking Changes

                                                                                                                                                                                                                                                                                                                                                                                                                    • 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
                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -890,22 +936,22 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                                        Added

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        Added

                                                                                                                                                                                                                                                                                                                                                                                                                        • 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

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        Changed

                                                                                                                                                                                                                                                                                                                                                                                                                        • Draw map connections with the current map’s tilesets to more accurately mimic their appearance in-game.
                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                        Fixed

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        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.
                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -915,17 +961,17 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                                          2.0.0 - 2019-10-16

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                          Breaking Changes

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                          2.0.0 - 2019-10-16

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                          Breaking Changes

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                                          Added

                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                          Added

                                                                                                                                                                                                                                                                                                                                                                                                                          • Add wild encounter table editor.
                                                                                                                                                                                                                                                                                                                                                                                                                          • Add dark themes.
                                                                                                                                                                                                                                                                                                                                                                                                                            • @@ -933,16 +979,16 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                                            Changed

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +

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

                                                                                                                                                                                                                                                                                                                                                                                                                            Fixed

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            Fixed

                                                                                                                                                                                                                                                                                                                                                                                                                            • Fix bug where map group names were hardcoded when creating a new map.
                                                                                                                                                                                                                                                                                                                                                                                                                            • Fix bug in Tileset Editor where multi-tile selections weren’t properly painted when clicking on the bottom row of the metatile layers.
                                                                                                                                                                                                                                                                                                                                                                                                                              • @@ -953,18 +999,18 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                                              1.2.2 - 2019-05-16

                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Added

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              1.2.2 - 2019-05-16

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Added

                                                                                                                                                                                                                                                                                                                                                                                                                              • Add region map editor
                                                                                                                                                                                                                                                                                                                                                                                                                              • Add ability to add new tilesets
                                                                                                                                                                                                                                                                                                                                                                                                                              • Add official Porymap documentation website: https://huderlem.github.io/porymap/
                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                              Changed

                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                              Changed

                                                                                                                                                                                                                                                                                                                                                                                                                              • Event sprites now display as facing the direction of their movement type.
                                                                                                                                                                                                                                                                                                                                                                                                                              • Default values for newly-created events now use valid values from the project, rather than hardcoded values.
                                                                                                                                                                                                                                                                                                                                                                                                                                • @@ -974,8 +1020,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                                                Fixed

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Fixed

                                                                                                                                                                                                                                                                                                                                                                                                                                • Fix bug in zoomed metatile selector where a large selection rectangle was being rendered.
                                                                                                                                                                                                                                                                                                                                                                                                                                • Fix bug where edited map icons were not rendered properly.
                                                                                                                                                                                                                                                                                                                                                                                                                                  • @@ -984,32 +1030,32 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                                                  1.2.1 - 2019-02-16

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Added

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  1.2.1 - 2019-02-16

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Added

                                                                                                                                                                                                                                                                                                                                                                                                                                  • Add ability to zoom in and out the map metatile selector via a slider at the bottom of the metatile selector window.
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Fixed

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Fixed

                                                                                                                                                                                                                                                                                                                                                                                                                                  • Fix crash when creating a new map from a layout that has no pre-existing maps that use it.
                                                                                                                                                                                                                                                                                                                                                                                                                                  • Fix bug where var_value, trainer_type and trainer_sight_or_berry_tree_id JSON fields were being interpreted as integers.
                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                  1.2.0 - 2019-02-04

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Breaking Changes

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  1.2.0 - 2019-02-04

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Breaking Changes

                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Added

                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Added

                                                                                                                                                                                                                                                                                                                                                                                                                                  • 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.
                                                                                                                                                                                                                                                                                                                                                                                                                                  • Add ability to import tileset palettes (JASC, .pal, .tpl, .gpl, .act).
                                                                                                                                                                                                                                                                                                                                                                                                                                    • @@ -1022,8 +1068,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                                                    Changed

                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                    Changed

                                                                                                                                                                                                                                                                                                                                                                                                                                    • Collapse the map list by default.
                                                                                                                                                                                                                                                                                                                                                                                                                                    • Collision view now has a transparency slider to help make it easier to view the underlying metatiles.
                                                                                                                                                                                                                                                                                                                                                                                                                                      • @@ -1037,8 +1083,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                                                      Fixed

                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Fixed

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Fix bug where smart paths could be auto-enabled, despite the checkbox being disabled.
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Fix crash that could occur when changing the palette id in the tileset palette editor.
                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -1047,32 +1093,32 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                                                        1.1.0 - 2018-12-27

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                        Breaking Changes

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                        1.1.0 - 2018-12-27

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Breaking Changes

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                        Added

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Added

                                                                                                                                                                                                                                                                                                                                                                                                                                        • Add porymap.project.cfg config file to project repos, in order to house project-specific settings, such as base_game_version=pokeemerald.
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Write all logs to porymap.log file, so users can view any errors that porymap hits.
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Changelog
                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                        Changed

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Changed

                                                                                                                                                                                                                                                                                                                                                                                                                                        • Add porymap.cfg base config file, rather than using built-in system settings (e.g. registry on Windows).
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Properly read/write map headers for pokeemerald.
                                                                                                                                                                                                                                                                                                                                                                                                                                        • 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.
                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                        Fixed

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Fixed

                                                                                                                                                                                                                                                                                                                                                                                                                                        • Creating new hidden-item events now uses a valid default flag value.
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Fix bug where tilesets were sometimes not displaying their bottom row of metatiles.
                                                                                                                                                                                                                                                                                                                                                                                                                                          • @@ -1085,8 +1131,8 @@ and this project somewhat adheres to -

                                                                                                                                                                                                                                                                                                                                                                                                                                          1.0.0 - 2018-10-26

                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                          1.0.0 - 2018-10-26

                                                                                                                                                                                                                                                                                                                                                                                                                                          This was the initial release.

                                                                                                                                                                                                                                                                                                                                                                                                                                        diff --git a/docs/search.html b/docs/search.html index dfe9fce4..b596566c 100644 --- a/docs/search.html +++ b/docs/search.html @@ -219,124 +219,134 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Changelog
                                                                                                                                                                                                                                                                                                                                                                                                                                          • Unreleased
                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                          • 5.3.0 - 2024-01-15
                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                            • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                            • Changed
                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                            • 5.4.1 - 2024-03-21
                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                            • 5.2.0 - 2024-01-02
                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                              • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                              • Changed
                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                              • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                              • 5.4.0 - 2024-02-13
                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                              • 5.1.1 - 2023-02-20
                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                • Changed
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                • 5.3.0 - 2024-01-15
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                • 5.1.0 - 2023-01-22
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • 5.2.0 - 2024-01-02
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • 5.0.0 - 2022-10-30
                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • 5.1.1 - 2023-02-20 +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • 5.1.0 - 2023-01-22 +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • 5.0.0 - 2022-10-30
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • 4.5.0 - 2021-12-26
                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Changed
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • 4.5.0 - 2021-12-26
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • 4.4.0 - 2020-12-20
                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Changed
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • 4.4.0 - 2020-12-20
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • 4.3.1 - 2020-07-17
                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Changed
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • 4.3.1 - 2020-07-17
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • 4.3.0 - 2020-06-27
                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Changed
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 4.3.0 - 2020-06-27
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 4.2.0 - 2020-06-06
                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Changed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • 4.2.0 - 2020-06-06
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • 4.1.0 - 2020-05-18
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Changed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • 4.1.0 - 2020-05-18
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • 4.0.0 - 2020-04-28
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Breaking Changes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Changed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • 4.0.0 - 2020-04-28
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • 3.0.1 - 2020-03-04
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • 3.0.1 - 2020-03-04
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • 3.0.0 - 2020-03-04
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Breaking Changes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Changed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • 3.0.0 - 2020-03-04
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • 2.0.0 - 2019-10-16
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Breaking Changes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Changed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • 2.0.0 - 2019-10-16
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • 1.2.2 - 2019-05-16
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Changed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • 1.2.2 - 2019-05-16
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • 1.2.1 - 2019-02-16
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 1.2.1 - 2019-02-16
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • 1.2.0 - 2019-02-04
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Breaking Changes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Added
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Changed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Fixed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • 1.2.0 - 2019-02-04
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • 1.1.0 - 2018-12-27
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Related Projects
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • diff --git a/docs/searchindex.js b/docs/searchindex.js index 07b46e1f..82601ee5 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index","manual/creating-new-maps","manual/editing-map-collisions","manual/editing-map-connections","manual/editing-map-events","manual/editing-map-header","manual/editing-map-tiles","manual/editing-wild-encounters","manual/introduction","manual/navigation","manual/project-files","manual/region-map-editor","manual/scripting-capabilities","manual/settings-and-options","manual/shortcuts","manual/tileset-editor","reference/changelog","reference/related-projects"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:54},filenames:["index.rst","manual/creating-new-maps.rst","manual/editing-map-collisions.rst","manual/editing-map-connections.rst","manual/editing-map-events.rst","manual/editing-map-header.rst","manual/editing-map-tiles.rst","manual/editing-wild-encounters.rst","manual/introduction.rst","manual/navigation.rst","manual/project-files.rst","manual/region-map-editor.rst","manual/scripting-capabilities.rst","manual/settings-and-options.rst","manual/shortcuts.rst","manual/tileset-editor.rst","reference/changelog.md","reference/related-projects.rst"],objects:{"":{onBlockChanged:[12,1,1,""],onBlockHoverChanged:[12,1,1,""],onBlockHoverCleared:[12,1,1,""],onBorderMetatileChanged:[12,1,1,""],onBorderResized:[12,1,1,""],onBorderVisibilityToggled:[12,1,1,""],onMainTabChanged:[12,1,1,""],onMapOpened:[12,1,1,""],onMapResized:[12,1,1,""],onMapShifted:[12,1,1,""],onMapViewTabChanged:[12,1,1,""],onProjectClosed:[12,1,1,""],onProjectOpened:[12,1,1,""],onTilesetUpdated:[12,1,1,""]},"constants.version":{major:[12,0,1,""],minor:[12,0,1,""],patch:[12,0,1,""]},constants:{base_game_version:[12,0,1,""],layers_per_metatile:[12,0,1,""],max_primary_metatiles:[12,0,1,""],max_primary_tiles:[12,0,1,""],max_secondary_metatiles:[12,0,1,""],max_secondary_tiles:[12,0,1,""],metatile_behaviors:[12,0,1,""],num_primary_palettes:[12,0,1,""],num_secondary_palettes:[12,0,1,""],tiles_per_metatile:[12,0,1,""]},map:{bucketFill:[12,1,1,""],bucketFillFromSelection:[12,1,1,""],commit:[12,1,1,""],getAllowBiking:[12,1,1,""],getAllowEscaping:[12,1,1,""],getAllowRunning:[12,1,1,""],getBattleScene:[12,1,1,""],getBlock:[12,1,1,""],getBorderDimensions:[12,1,1,""],getBorderHeight:[12,1,1,""],getBorderMetatileId:[12,1,1,""],getBorderWidth:[12,1,1,""],getCollision:[12,1,1,""],getDimensions:[12,1,1,""],getElevation:[12,1,1,""],getFloorNumber:[12,1,1,""],getHeight:[12,1,1,""],getLocation:[12,1,1,""],getMetatileAttributes:[12,1,1,""],getMetatileBehavior:[12,1,1,""],getMetatileBehaviorName:[12,1,1,""],getMetatileEncounterType:[12,1,1,""],getMetatileId:[12,1,1,""],getMetatileLabel:[12,1,1,""],getMetatileLayerType:[12,1,1,""],getMetatileTerrainType:[12,1,1,""],getMetatileTile:[12,1,1,""],getMetatileTiles:[12,1,1,""],getNumPrimaryTilesetMetatiles:[12,1,1,""],getNumPrimaryTilesetTiles:[12,1,1,""],getNumSecondaryTilesetMetatiles:[12,1,1,""],getNumSecondaryTilesetTiles:[12,1,1,""],getPrimaryTileset:[12,1,1,""],getPrimaryTilesetPalette:[12,1,1,""],getPrimaryTilesetPalettePreview:[12,1,1,""],getPrimaryTilesetPalettes:[12,1,1,""],getPrimaryTilesetPalettesPreview:[12,1,1,""],getRequiresFlash:[12,1,1,""],getSecondaryTileset:[12,1,1,""],getSecondaryTilesetPalette:[12,1,1,""],getSecondaryTilesetPalettePreview:[12,1,1,""],getSecondaryTilesetPalettes:[12,1,1,""],getSecondaryTilesetPalettesPreview:[12,1,1,""],getShowLocationName:[12,1,1,""],getSong:[12,1,1,""],getTilePixels:[12,1,1,""],getType:[12,1,1,""],getWeather:[12,1,1,""],getWidth:[12,1,1,""],magicFill:[12,1,1,""],magicFillFromSelection:[12,1,1,""],redraw:[12,1,1,""],setAllowBiking:[12,1,1,""],setAllowEscaping:[12,1,1,""],setAllowRunning:[12,1,1,""],setBattleScene:[12,1,1,""],setBlock:[12,1,1,""],setBlocksFromSelection:[12,1,1,""],setBorderDimensions:[12,1,1,""],setBorderHeight:[12,1,1,""],setBorderMetatileId:[12,1,1,""],setBorderWidth:[12,1,1,""],setCollision:[12,1,1,""],setDimensions:[12,1,1,""],setElevation:[12,1,1,""],setFloorNumber:[12,1,1,""],setHeight:[12,1,1,""],setLocation:[12,1,1,""],setMetatileAttributes:[12,1,1,""],setMetatileBehavior:[12,1,1,""],setMetatileBehaviorName:[12,1,1,""],setMetatileEncounterType:[12,1,1,""],setMetatileId:[12,1,1,""],setMetatileLabel:[12,1,1,""],setMetatileLayerType:[12,1,1,""],setMetatileTerrainType:[12,1,1,""],setMetatileTile:[12,1,1,""],setMetatileTiles:[12,1,1,""],setPrimaryTileset:[12,1,1,""],setPrimaryTilesetPalette:[12,1,1,""],setPrimaryTilesetPalettePreview:[12,1,1,""],setPrimaryTilesetPalettes:[12,1,1,""],setPrimaryTilesetPalettesPreview:[12,1,1,""],setRequiresFlash:[12,1,1,""],setSecondaryTileset:[12,1,1,""],setSecondaryTilesetPalette:[12,1,1,""],setSecondaryTilesetPalettePreview:[12,1,1,""],setSecondaryTilesetPalettes:[12,1,1,""],setSecondaryTilesetPalettesPreview:[12,1,1,""],setShowLocationName:[12,1,1,""],setSong:[12,1,1,""],setType:[12,1,1,""],setWeather:[12,1,1,""],setWidth:[12,1,1,""],shift:[12,1,1,""]},overlay:{addImage:[12,1,1,""],addMetatileImage:[12,1,1,""],addPath:[12,1,1,""],addRect:[12,1,1,""],addText:[12,1,1,""],addTileImage:[12,1,1,""],clear:[12,1,1,""],clearClippingRect:[12,1,1,""],createImage:[12,1,1,""],getHorizontalScale:[12,1,1,""],getOpacity:[12,1,1,""],getPosition:[12,1,1,""],getRotation:[12,1,1,""],getVerticalScale:[12,1,1,""],getVisibility:[12,1,1,""],getX:[12,1,1,""],getY:[12,1,1,""],hide:[12,1,1,""],move:[12,1,1,""],rotate:[12,1,1,""],setClippingRect:[12,1,1,""],setHorizontalScale:[12,1,1,""],setOpacity:[12,1,1,""],setPosition:[12,1,1,""],setRotation:[12,1,1,""],setScale:[12,1,1,""],setVerticalScale:[12,1,1,""],setVisibility:[12,1,1,""],setX:[12,1,1,""],setY:[12,1,1,""],show:[12,1,1,""]},utility:{error:[12,1,1,""],getBattleSceneNames:[12,1,1,""],getBorderVisibility:[12,1,1,""],getCustomScripts:[12,1,1,""],getGridVisibility:[12,1,1,""],getInputItem:[12,1,1,""],getInputNumber:[12,1,1,""],getInputText:[12,1,1,""],getLocationNames:[12,1,1,""],getMainTab:[12,1,1,""],getMapNames:[12,1,1,""],getMapTypeNames:[12,1,1,""],getMapViewTab:[12,1,1,""],getMetatileBehaviorNames:[12,1,1,""],getMetatileLayerOpacity:[12,1,1,""],getMetatileLayerOrder:[12,1,1,""],getPrimaryTilesetNames:[12,1,1,""],getSecondaryTilesetNames:[12,1,1,""],getSmartPathsEnabled:[12,1,1,""],getSongNames:[12,1,1,""],getTilesetNames:[12,1,1,""],getWeatherNames:[12,1,1,""],isPrimaryTileset:[12,1,1,""],isSecondaryTileset:[12,1,1,""],log:[12,1,1,""],registerAction:[12,1,1,""],registerToggleAction:[12,1,1,""],setBorderVisibility:[12,1,1,""],setGridVisibility:[12,1,1,""],setMainTab:[12,1,1,""],setMapViewTab:[12,1,1,""],setMetatileLayerOpacity:[12,1,1,""],setMetatileLayerOrder:[12,1,1,""],setSmartPathsEnabled:[12,1,1,""],setTimeout:[12,1,1,""],showError:[12,1,1,""],showMessage:[12,1,1,""],showQuestion:[12,1,1,""],showWarning:[12,1,1,""],warn:[12,1,1,""]}},objnames:{"0":["js","attribute","JavaScript attribute"],"1":["js","function","JavaScript function"]},objtypes:{"0":"js:attribute","1":"js:function"},terms:{"0e8ccfc4fd3544001f4c25fafd401f7558bdefba":16,"0x0":[13,16],"0x000":13,"0x014":13,"0x015":13,"0x01c":13,"0x01d":13,"0x1":[12,13],"0x10":12,"0x11":12,"0x1d4":13,"0x1d5":13,"0x1dc":13,"0x1dd":13,"0x1ff":13,"0x220":15,"0x3e00":13,"0x3ff":13,"0x4":[8,12],"0x60000000":13,"0x7000000":13,"0x8":12,"0x9":12,"0xc00":13,"0xd":12,"0xf000":13,"0xff":13,"2x2":13,"3x3":6,"4bpp":11,"82abc164dc9f6a74fdf0c535cc1621b7ed05318b":16,"8bpp":[11,16],"8x8":[12,15],"boolean":12,"byte":13,"case":[2,4,13],"const":12,"default":[4,6,7,9,10,11,12,13,14,16],"export":[12,15,16],"final":[8,12],"function":[4,8,11,13,16],"goto":4,"import":[2,6,13,16],"long":[2,12,16],"new":[0,2,3,4,6,9,10,11,12,13,14,15,16],"null":[13,16],"pok\u00e9":6,"pok\u00e9cent":4,"pok\u00e9mon":[4,6,9,10,13,16],"return":[4,12],"switch":[9,12,15,16],"true":[2,12,13],"try":[2,12],"var":[4,10],"while":[2,4,6,12,13,14,16],AND:4,Adding:0,For:[1,2,3,4,5,6,7,9,11,12,13,14,15,16],IDs:[10,16],Its:[8,16],MUS:10,NOT:12,One:[7,12],That:8,The:[0,1,2,4,5,6,7,8,9,10,12,13,16],Their:13,Then:[2,6,7,12],There:[4,8,11,12,15],These:[2,3,6,7,10,12,13,15],Use:[4,6,13],Used:[5,15],Useful:12,With:[4,12],YES:12,Yes:12,a0ba1b7c6353f7e4f3066025514c05b323a0123d:16,a1ea3b5e394bc115ba9b86348c161094a00dcca7:16,aarrggbb:12,abil:[2,4,12,16],abl:[2,4,11,12],about:[0,12,16],abov:[2,4,6,8,9,11,12,15,16],accept:[7,12],access:[4,12,13,16],accomod:16,accomplish:6,accord:[13,16],accordingli:16,accur:16,across:[13,15],act:16,action:[0,6,14,16],actionnam:12,activ:[4,7,12,16],actual:[4,12,16],ad365a35c1536740cbcbc10bee66e5dd908c39e7:16,adb0a444577b59eb02788c782a3d04bc285be0ba:16,add:[1,3,4,7,11,12,13,15,16],added:[12,16],addfilledrect:16,addimag:[12,16],adding:[7,16],addit:[5,8,10,12,13,15],addition:[4,6,12,13,16],addmetatileimag:12,addpath:12,addrect:[12,16],addtext:12,addtileimag:12,adher:16,adjac:[4,12],adjust:[6,7,15,16],adob:15,advanc:[2,8,16,17],advancemap:[13,16],affect:12,after:[2,4,6,8,10,12,16],again:[4,6],alia:11,all:[2,3,4,6,7,9,11,12,13,14,15,16],allow:[1,2,4,5,6,7,8,9,12,13,15,16],alon:12,along:2,alongsid:13,alphabet:16,alreadi:[12,14],also:[2,4,5,6,7,10,11,12,13,14,15,16],alter:7,altern:[1,4],altogeth:15,alwai:[2,4,16],amount:16,angl:12,ani:[1,2,4,6,9,11,12,13,15,16],anim:[4,12,16],anoth:[4,6,7,9,11,16],anyth:[4,6,12],api:[0,16],app:13,appdata:[13,14],appear:[4,6,9,11,12,15,16],append:[5,10],appli:[12,15,16],applic:[9,13,14,16],applymov:4,applynighttint:12,appropri:2,arbitrarili:16,area:[2,4,6,8,9,11,12,16],aren:[10,16],argument:[12,15,16],around:[4,6,9,11,16],arrai:[11,12],arriv:4,arrow:[4,16],asid:13,assign:[4,7,16],associ:[1,2,4,11,13,15],assum:[12,16],attempt:[15,16],attribut:[12,13,15,16],autcomplet:16,auto:16,autocomplet:16,automat:[3,4,5,12,13,15,16],avail:[4,6,7,8,9,11,13],awai:7,awar:6,axi:6,back:[6,16],background:[0,5,9,12,15],bad:16,bar:[12,16],base:[0,1,6,7,10,11,13,16],base_game_vers:[12,16],basement:5,basic:[2,6,8,9,12],batch:12,battl:[4,5,10,12],battlescen:12,bbg_event_player_facing_:10,bcoord_event_weather_:10,becaus:[2,4,9,12,13],becom:[13,16],been:[12,16],befor:[2,6,8,12,16],begin:[],behav:[4,12,16],behavior:[10,12,13,16],behind:[12,16],being:[2,8,13,16],bele:1,belong:5,below:[2,4,6,7,10,12,16],berri:4,better:16,between:[2,3,4,9,11,12,15,16],beyond:16,bflag_:10,bigger:6,bike:[1,5,12,13],bin:[10,13],binari:[8,11,15],bit:[12,13,15,16],bitem_:10,black:12,blob:[],block:[1,2,12,16],blue:4,bmap_battle_scene_:10,bmap_type_:10,bmb_:10,bmovement_type_:10,bobj_event_gfx_:10,boi:17,border:[0,1,4,10,12,13,16],bordercolor:[12,16],both:[3,6,13,15,16],bottom:[2,6,12,13,15,16],bound:[4,16],boundari:16,box:[4,7,10,11,12,13,15,16],bread:6,bridg:2,brief:4,briefli:9,bring:[4,6,7,9,11],browser:12,brush:12,bsecret_base_:10,bspecies_:10,btrainer_type_:10,bucket:[0,12,14],bucketfil:12,bucketfillfromselect:12,bug:16,build:[4,6,8,12],built:[6,16],bulk:16,bump:16,butter:6,button:[0,3,6,7,8,9,10,11,12,13,15,16],bvar_:10,bvd:[15,16],bweather_:10,c68ba9f4e8e260f2e3389eccd15f6ee5f4bdcd3:16,c73de8bed752ca538d90cfc93c4a9e8c7965f8c9:16,cach:12,calcul:[10,16],call:[6,12,16],callabl:12,callback:[13,16],can:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],cancel:[12,14],cannot:[1,4,5,14,16],capabl:[0,16],categori:15,caus:[12,16],cave:7,cdae0c1444bed98e652c87dc3e3edcecacfef8b:16,ceil:12,center:[1,4,6,9,16],certain:[4,10,12,15,16],cfg:[6,13,14,16],chain:6,chanc:7,chang:[0,1,3,4,7,8,9,11,12,13],changelog:0,charact:[4,16],check:[4,6,7,9,12,13,16],checkbox:[3,6,16],checkerboard:16,choos:[4,6,7,8,9,10,12],citi:[3,8],clear:[11,12,16],clearclippingrect:12,click:[1,2,3,4,6,7,8,9,11,12,14,16],cliff:2,clip:[12,16],clipboard:16,clockwis:12,clone:[0,13,16],close:[4,12,16],code:[4,12,13,15],collaps:[9,16],collect:5,collid:12,collis:[0,4,6,8,9,12,13,16],collision_opac:[],color:[12,15,16,17],column:[2,13],com:[0,13,16],combin:[2,15],combo:[4,16],combobox:[11,16],comma:13,command:[4,14,16],comment:16,commit:[12,13,16],commitchang:12,common:2,commonli:[2,16],compat:16,compil:8,complet:12,comprehens:[14,16],concept:2,config:[6,12,13,16],configur:[0,6,11,13,16],confirm:[12,13],conjunct:6,connect:[0,4,6,8,9,12,16],consecut:12,consid:13,consist:[12,13,16],constant:[10,11,15,16],constants_event_bg:10,constants_fieldmap:10,constants_flag:10,constants_glob:10,constants_heal_loc:10,constants_item:10,constants_map_group:10,constants_map_typ:10,constants_metatile_behavior:10,constants_metatile_label:10,constants_obj_ev:10,constants_obj_event_mov:10,constants_oppon:[],constants_pokemon:10,constants_region_map_sect:10,constants_secret_bas:10,constants_song:10,constants_trainer_typ:10,constants_var:10,constants_weath:10,construct:13,contain:[4,9,12,13,15,16],content:12,context:[9,15],contigu:[6,16],continu:[2,6],contrast:16,control:[2,4,5,8],conveni:[4,6,12,15,16],convert:[15,16],coord:12,coordin:[4,11,12,16],coorespond:16,copi:[6,7,15,16],corner:[3,12],correctli:[13,16],correspond:[11,13,16],corrupt:16,could:[12,16],count:[2,10,15,16],counterclockwis:12,coupl:11,cover:[4,9,15],crash:16,creat:[0,4,6,7,9,11,12,13,15,16],create_map_text_fil:[],createimag:[12,16],creation:6,critic:12,cross:8,crosshair:[],ctrl:[3,4,6,8,9,11,12,14,16],cumbersom:12,current:[2,4,6,7,8,9,11,12,13,14,15,16],cursor:[4,6,11,14,16],custom:[0,1,5,6,11,13,14,16],custom_script:[],cut:16,dai:[7,12],dark:16,data:[6,7,8,10,11,12,13,15,16],data_event_script:10,data_heal_loc:10,data_layouts_fold:10,data_map_fold:10,data_obj_event_gfx:10,data_obj_event_gfx_info:10,data_obj_event_gfx_point:10,data_obj_event_pic_t:10,data_pokemon_gfx:10,data_scripts_fold:10,data_tilesets_fold:10,date:16,daunt:9,deactiv:4,debug:12,decim:12,decompil:[8,16,17],decor:12,default_primary_tileset:[],default_secondary_tileset:[],defin:[6,11,12,13,15,16],define_attribute_behavior:10,define_attribute_encount:10,define_attribute_lay:10,define_attribute_terrain:10,define_heal_locations_prefix:10,define_map_dynam:10,define_map_empti:10,define_map_prefix:10,define_map_s:10,define_map_section_count:10,define_map_section_empti:10,define_map_section_prefix:10,define_mask_behavior:10,define_mask_collis:10,define_mask_elev:10,define_mask_lay:10,define_mask_metatil:10,define_max_level:10,define_metatile_label_prefix:10,define_metatiles_primari:10,define_min_level:10,define_obj_event_count:10,define_pals_primari:10,define_pals_tot:10,define_spawn_prefix:10,define_tiles_primari:10,define_tiles_tot:10,definit:13,degre:12,del:[14,16],delai:12,delaym:12,delet:[0,3,11,12,14,15,16],deltai:12,deltax:12,demand:12,demonstr:6,denot:2,depend:[1,6,12,13,16],depth:[15,16],describ:[4,7],descript:4,design:6,desir:[3,6,9],despit:16,destin:[3,4],detail:[4,6,9,11,12,13,16],detailedtext:12,detect:12,determin:[2,4,11,13,15],diagonist:12,dialog:[8,9,12,14,16],did:16,diff:16,differ:[1,2,4,6,9,11,12,13,15,16],difficulti:8,dig:[5,12,13],dimens:[6,10,11,12,13,16],direct:[2,3,4,6,10,13,16],directli:[4,12,13],directori:[12,16],disabl:[6,7,10,12,13,16],disallow:16,disappear:16,disassembl:17,discontin:[],disk:[7,12],displai:[1,4,6,7,8,11,12,13,15,16],disppear:[],dissect:4,distanc:[4,16],distinguish:11,dive:0,divid:13,document:[12,16],doe:[4,6,8,10,12,13],doesn:[2,6,12,13,16],doing:8,don:[3,16],done:[11,15],doubl:[3,4,9,11,16],down:[6,7,8,16],download:[8,12],drag:[3,4,6,11,14,16],draw:[4,8,11,12,14,15,16],drawn:[12,16],drop:[7,16],dropdown:[3,6,12,13,15,16],due:16,dummi:4,duplic:[4,14,16],dure:[2,4,16],dynam:[4,10],each:[2,4,5,6,7,9,10,11,12,13,15,16],easi:[1,4,6],easier:[6,11,15,16],easiest:3,east:[2,3],ecmascript:12,ecount:10,edg:12,edit:[0,8,9,10,11,13,14,15,16],editor:[0,4,8,13,16,17],effect:[13,15,16],either:[2,6,9,12,13,15,16],element:[12,16],elev:[1,2,4,12,13,16],ellips:16,ellipt:12,els:[2,4],elsewher:12,emerg:0,empti:[7,8,10,12,13,16],enabl:[3,6,10,12,13,16],enable_event_clone_object:[],enable_event_secret_bas:[],enable_event_weather_trigg:[],enable_floor_numb:[],enable_heal_location_respawn_data:[],enable_hidden_item_quant:[],enable_hidden_item_requires_itemfind:[],enable_map_allow_flag:[],enable_triple_layer_metatil:[12,16],enclos:12,encount:[0,10,12,13,16],encountertyp:12,end:[10,16],endless:12,enforc:[7,13,16],engin:[4,5],enhanc:12,ensur:4,enter:[1,2,4,5,9,10,11,12,14],entir:[6,11,12,15,16],entranc:4,entri:[0,12,16],equal:4,equival:8,eras:12,error:[12,16],escap:[1,5,12,13],essenti:12,etc:16,evalu:16,even:[2,6,12,14],evenli:13,event:[0,1,3,8,9,10,12,14,16],event_bg:10,event_object:10,event_object_mov:10,event_script:10,everi:[6,11,12,13,15],exactli:6,exampl:[1,2,3,4,5,6,11,12,15,16],except:[2,4],exchang:11,exclus:[4,5,15],execut:[4,12],exist:[1,4,6,8,10,11,12,13,16],exit:[4,12,13,16],expand:[5,9,16],expect:[10,13,16],expens:12,explain:4,explan:11,explanatori:5,explicitli:16,explor:2,express:[10,13,16],extend:[4,16],extens:[4,12,16],extra:16,extract:10,extrem:3,eyedropp:[6,14,15],face:[4,10,15,16],fail:[13,16],fake:12,fall:16,fals:12,familiar:8,fan:16,favor:16,featur:[2,3,8,9,11,16],feel:0,few:[4,6,8,9,16],field:[0,4,5,6,11,13,16],fieldmap:10,file:[0,3,4,6,8,9,11,12,15,16],filepath:[10,11,12,13,16],fill:[0,2,12,13,14,16],fillcolor:[12,16],filter:[9,16],find:[0,10,13,16],finish:[2,11],first:[2,4,6,7,8,9,11,12,13,16],fit:16,fix:6,flag:[4,10,16],flash:[5,12],flip:[11,12,16],floor:[1,5,12,13,16],floornumb:12,flow:[2,6],flower:[8,12],floweri:8,fly:[1,4],focu:16,folder:[1,8,9,10,13,16],follow:[0,6,8,12],font:12,forc:[12,13],forceredraw:12,fork:12,form:[12,15],format:[6,11,12,15,16,17],found:[4,8,10,13,15,16],four:[7,13],frame:[10,16],freeli:12,frlg:16,from:[1,2,4,6,7,8,9,10,11,12,13,14,16,17],front:[4,16],full:[12,16],fullest:9,func:12,functionnam:12,game:[2,4,5,6,7,8,9,11,12,13,16,17],gameplai:[2,4,9],gba:15,gen:[8,17],gener:[2,8,10,12,14],get:[0,6,10,12],getallowbik:12,getallowescap:12,getallowrun:12,getbattlescen:12,getbattlescenenam:12,getblock:12,getborderdimens:12,getborderheight:12,getbordermetatileid:12,getbordervis:12,getborderwidth:12,getcollis:12,getcustomscript:12,getdimens:12,getelev:12,getfloornumb:12,getgridvis:12,getheight:12,gethorizontalscal:12,geti:12,getinputitem:12,getinputnumb:12,getinputtext:12,getloc:12,getlocationnam:12,getmaintab:12,getmapnam:12,getmaptypenam:12,getmapviewtab:12,getmetatileattribut:12,getmetatilebehavior:12,getmetatilebehaviornam:[12,16],getmetatileencountertyp:12,getmetatileid:12,getmetatilelabel:12,getmetatilelayeropac:12,getmetatilelayerord:12,getmetatilelayertyp:12,getmetatileterraintyp:12,getmetatiletil:12,getnumprimarytilesetmetatil:12,getnumprimarytilesettil:12,getnumsecondarytilesetmetatil:12,getnumsecondarytilesettil:12,getopac:12,getposit:12,getprimarytileset:12,getprimarytilesetnam:12,getprimarytilesetpalett:12,getprimarytilesetpalettepreview:12,getprimarytilesetpalettespreview:12,getrequiresflash:12,getrot:12,getsecondarytileset:12,getsecondarytilesetnam:12,getsecondarytilesetpalett:12,getsecondarytilesetpalettepreview:12,getsecondarytilesetpalettespreview:12,getshowlocationnam:12,getsmartpathsen:12,getsong:12,getsongnam:12,gettilepixel:12,gettilesetnam:12,gettyp:12,getverticalscal:12,getvis:12,getweath:12,getweathernam:12,getwidth:12,getx:12,gif:[6,16],ginitialmovementtypefacingdirect:10,git:[4,8],github:[0,13,16],gitignor:13,give:[4,6,7,9,16],given:[7,12,15,16],global:[0,4,10,12],global_fieldmap:10,gmonicont:10,gobjecteventgraphicsinfopoint:10,goe:12,going:[4,14],good:[10,12],gpl:16,grai:15,graphic:[2,4,5,10,13,16],graphics_file_rul:15,grass:[2,8,12,15],grasstil:12,grayscal:16,great:8,green:[4,7],greet:8,grid:[6,12,14,16],group:[0,1,6,9,13,14,16],grow:16,gtileset_:10,gtileset_gener:13,gtileset_pallettown:13,gtileset_petalburg:13,guarante:[12,16],gwildmonhead:10,hack:[8,15],had:13,half:2,handl:16,happen:[4,12,16],hardcod:[4,16],hardwar:15,has:[2,3,4,5,9,11,12,14,15,16],have:[2,3,4,6,7,8,9,11,12,13,14,15,16],head:11,headbutt_mon:7,header:[0,9,10,13,16],heal:[0,1,10,13,16],heal_loc:[4,10],heal_location_:[10,16],healloc:10,healspot:0,height:[1,11,12,13,16],help:[6,15,16],here:[2,12,13,14,15],hex:[15,16],hexadecim:2,hidden:[0,6,10,12,13,16],hide:[1,5,12,16],hierarch:9,high:17,higher:12,highest:13,highli:8,highlight:16,higlight:11,histori:[2,12,14,16],hit:16,hold:[4,6,14,16],home:16,hop:2,horizont:[3,12,16],hous:16,hover:[6,16],how:[2,4,6,8,9,12,16],howev:[4,6,12],hscale:[12,16],html:12,http:[0,13,16],huderlem:[0,16],huge:16,ice:15,icon:[6,10,12,13,16],idea:10,ident:[2,6],identifi:10,ids:12,ignor:[8,16],illustr:[2,6],imag:[0,2,4,6,10,12,13,16],immedi:16,impass:[2,12],implement:7,implicitli:12,improperli:16,improv:[8,16],inanim:16,inc:[4,10,13,16],incbin_u16:13,incbin_u32:13,incbin_u8:13,includ:[2,4,6,7,9,10,11,13,15,16],inclus:12,incomapt:[],incompat:[6,16],incorrect:16,incorrectli:16,increment:12,independ:16,index:[7,12,15,16],indexof:12,indic:[6,12,15,16],individu:[6,12,15,16],indoor:1,info:12,inform:[12,13,16],informativetext:12,inherit:4,initi:[12,13,16],initial_facing_t:10,input:[12,16],insert:12,insid:[4,12],instal:8,instanc:[11,13],instead:[4,10,12,13,16],integ:[11,16],integr:[10,16],interact:[2,4,9,12,16],interchang:16,interest:12,interpret:16,interrupt:16,interv:12,introduc:16,introduct:0,invalid:16,investig:[],invis:[4,12],involv:4,iscompress:13,isprimarytileset:12,issecondarytileset:12,issu:16,item:[0,5,10,12,13,16],itemfind:[4,13,16],iter:16,its:[4,6,12,15,16],itself:12,jasc:[15,16],javascript:[12,16],json:[6,7,10,11,13,16],json_layout:10,json_map_group:10,json_region_map_entri:10,json_region_porymap_cfg:10,json_wild_encount:10,jump:16,junk:16,just:[1,2,6,7,15],kanto:16,keep:[3,5,16],kei:[6,14,16],keyboard:[11,12,14,16],keyword:12,known:4,label:[10,11,12,13,16],laid:6,land:[2,12],languag:17,larg:[6,16],larger:[6,9],last:[12,16],later:12,launch:[8,13,16],layer:[12,13,16],layers_per_metatil:12,layertyp:12,layout:[0,1,9,10,13,16],layouts_t:16,learn:[6,8,9],leav:[2,12],left:[2,4,6,8,9,11,12,13,14,15,16],length:12,let:[2,4,6,7,8,9,11,12,17],letter:12,level:[2,7,10,16,17],librari:[13,14],life:[4,6],like:[2,4,6,9,12,13,15,16],limit:[5,10,12,13,15,16],line:[4,6,13,16],linux:[8,16],list:[0,1,4,6,10,11,12,13,14,16],listen:17,littl:4,load:[4,8,9,12,13,16],local:4,locat:[0,1,5,6,8,10,11,12,13,16],lock:[4,6,16],log:[12,16],logic:12,longer:[4,16],look:[0,4,8,9,11],lose:16,lot:15,lower:[12,16],mac:[8,16],maco:[13,14,16],macro:[10,13,16],made:[7,12,13,16],magic:[12,14,16],magicfil:12,magicfillfromselect:12,mai:[1,2,4,7,13,15,16],main:[0,6,7,8,11,12,13,16],main_splitter_st:[],maintain:[2,10],major:[12,16],make:[2,4,6,8,11,12,13,15,16],makefil:15,manag:12,mani:[4,8,9,11,12,14,15,16],manipul:[7,12],manual:[0,12,15],map:[0,7,8,10,16,17],map_:10,map_dynam:16,map_group:10,map_groups_count:16,map_non:16,map_sort_ord:[],map_splitter_st:[],map_typ:10,map_type_indoor:5,mapgrid_collision_mask:[10,13],mapgrid_elevation_mask:[10,13],mapgrid_metatile_id_mask:[10,13],mapjson:16,mapnam:12,mapsec_:10,mapsec_non:11,mark:[4,12],mart:6,mask:[10,13,16],master:[],match:[4,6,13,16],math:12,max:[12,13,16],max_level:10,max_map_data_s:10,max_primary_metatil:12,max_primary_til:12,max_secondary_metatil:12,max_secondary_til:12,maximum:[7,10,12,13,16],mb_tall_grass:12,mean:[2,3,4,12],meant:17,measur:[4,16],memori:12,menu:[0,3,7,12,16],messag:[12,16],met:12,metatil:[0,1,2,4,8,9,10,12,13,14,16],metatile_:10,metatile_attr_behavior_mask:[10,13],metatile_attr_layer_mask:[10,13],metatile_attribut:13,metatile_attribute_behavior:10,metatile_attribute_encounter_typ:10,metatile_attribute_layer_typ:10,metatile_attribute_terrain:10,metatile_attributes_s:[],metatile_behavior:[10,12,15,16],metatile_behavior_mask:[],metatile_encounter_type_mask:[],metatile_general_grass:[],metatile_general_plain_grass:15,metatile_id:[],metatile_label:[10,15,16],metatile_layer_type_mask:[],metatile_secretbase_pc:15,metatile_terrain_type_mask:[],metatileid:12,metatiles_zoom:[],method:[6,16],middl:[6,12,14,15,16],might:[7,12],millisecond:12,mimic:16,min:[12,16],min_level:10,minimum:[7,10,12,16],minor:[12,16],mirror:0,miscellan:[5,12],mislead:16,miss:[0,16],mistak:[6,11],mode:[1,9,14,16],modif:2,modifi:[6,9,11,12,13,15,16],moment:12,monitor:16,monitor_fil:[],more:[4,6,8,9,11,12,13,14,15,16],most:[2,8,9,11,16],mostli:5,mountain:[2,6],mous:[4,6,11,12,16],mouseov:16,move:[2,3,4,5,12,14,16],movement:[4,10,16],much:8,multi:[2,16],multilin:16,multipl:[4,6,7,11,14,16],music:[5,9,10,16,17],must:[3,4,6,7,8,12,15],my_script:12,name:[1,4,5,6,7,9,10,11,12,13,15,16],nativ:[],navig:[0,3,4,7,8,11,16],nearli:2,necessari:[],need:[2,3,4,5,6,11,12,13,15,16],neg:[5,11,12,16],never:4,new_map_border_metatil:[],new_map_elev:[],new_map_metatil:[],newblock:12,newheight:12,newli:[12,16],newmetatileid:12,newtab:12,newwidth:12,next:[2,4,7,8,9,12,15,16],nice:12,night:12,nodej:12,nodep:8,non:[4,11,16],none:[10,12],normal:[4,6,12,13,15],north:2,notabl:[8,16],note:[5,10,12,13],noth:[4,12,16],notic:[11,12,16],now:[2,6,7,8,12,16],npc:[4,10,13],num_metatiles_in_primari:10,num_pals_in_primari:10,num_pals_tot:10,num_primary_palett:[12,16],num_secondary_palett:[12,16],num_til:15,num_tiles_in_primari:10,num_tiles_tot:10,number:[1,2,4,5,7,10,12,13,16],object:[0,2,6,9,10,12,13,16],object_ev:10,object_event_graph:10,object_event_graphics_info:[10,16],object_event_graphics_info_point:10,object_event_pic_t:10,object_event_templates_count:10,occur:[12,16],odd:12,off:[2,6,12,16],offici:16,offset:[3,11,16],old:[14,16],oldheight:12,oldtab:12,oldwidth:12,onblockchang:[12,16],onblockhoverchang:12,onblockhoverclear:12,onbordermetatilechang:12,onborderres:12,onbordervisibilitytoggl:12,onc:[4,6,12,16],one:[2,3,4,6,7,9,11,12,13,16],ones:16,onli:[2,3,4,6,7,9,10,12,13,15,16],onmaintabchang:12,onmapopen:12,onmapres:[12,16],onmapshift:12,onmapviewtabchang:12,onprojectclos:12,onprojectopen:12,ontilesetupd:12,onto:[2,6,9,11,12],opac:[12,16],opaqu:12,open:[0,3,6,7,8,9,11,12,13,14,15,16],oper:[9,12,15,16],oppon:[],optim:6,option:[0,2,4,9,10,11,12,13,14,15,16],order:[1,4,7,12,16],organ:9,origin:[4,12,13,16],other:[4,6,9,11,12,13,16,17],otherwis:[7,10],our:[7,8,12],out:[0,2,4,6,7,9,11,14,16],outdoor:1,outlin:[6,12,14,16],output:[10,13,15],outsid:[12,15,16],over:[2,4,5,6,9,16],overal:16,overhaul:16,overlai:16,overlap:13,overload:12,overrid:[10,13,16],overridden:[10,13],overview:12,overworld:[4,16],overwrit:[12,13,14],overwritten:12,own:[12,13],pad:16,paint:[0,6,8,9,11,12,14,16],pair:[12,15],pal:[11,15,16],palett:[0,10,11,12,16],paletteid:12,paletteindex:12,pane:[6,9,11,15,16],panel:[2,8,13,15,16],pars:16,part:[9,16],partial:[6,16],particular:2,particularli:4,passabl:12,past:16,patch:12,path:[0,2,10,11,12,13,14,16],pathwai:6,patient:9,pattern:[6,12],pencil:[0,4,8,14,16],per:[13,14,16],percent:12,perform:[6,12,16],perman:12,persist:16,petalburg:[3,8],pick:[4,15],picker:[6,16],pictur:[7,15,16],pink:4,pixel:[12,15,16],place:[4,6,8,11,16],placehold:16,plai:5,plain:[11,16],plain_grass:[],platform:[8,13,16],player:[1,2,3,4,6,9,11,14,15,16],pleas:0,plu:[3,4],png:[10,15,16],pointer:[0,4,14,16],pokecryst:17,pokeemerald:[4,6,8,10,11,12,13,16],pokefir:[4,5,6,8,11,12,13,15,16],pokemon:[1,7,9,10,12,13,16],pokemon_gfx:10,pokemon_icon:10,pokemon_icon_t:10,poker:17,pokerubi:[4,6,8,10,12,13,16],polish:17,pond:6,poor:16,pop:8,popul:[7,11,12,13,15],popular:17,popup:[1,5,11],pori:[4,10,13,16],port:16,portion:6,porycript:4,porymap:[1,3,4,6,7,9,10,11,12,14,15,16],porymap_config:10,poryscript:[13,16,17],posit:[0,6,11,12,13,16],possibl:[7,12,16],power:[6,12],pre:[6,16],predict:16,prefab:[0,12,13,16],prefabr:6,prefabs_filepath:6,prefabs_import_prompt:[],prefer:[4,13,14,16],prefix:[5,10,12,16],present:12,preserv:16,press:[3,4,6,8,9,16],pret:[8,13,14,16],pretti:7,pretty_cursor:[],prevblock:12,prevent:16,preview:[6,12],previou:[2,16],previous:[12,16],prevmetatileid:12,primari:[1,6,8,10,12,13,15,16],pro:15,probabl:[10,12],procedur:12,process:[2,4],program:17,project:[0,1,2,4,5,6,8,9,11,12,14,15,16],project_root:6,projectpath:12,prompt:[6,12,13,14,16],proper:16,properli:16,properti:[0,2,4,5,8,9,10,11,12,13,16],provid:[4,6,7,8,12,13,15,16],pull:16,purpos:[2,9],qt6:16,quantiti:[4,13],question:12,quick:6,quickli:9,radiu:[4,6],rais:16,randint:12,random:12,rang:[4,12,13],rate:[7,16],rather:[6,12,16],ratio:7,raw:12,rawvalu:12,reach:0,reactiv:16,read:[4,8,10,11,12,13,16],realist:15,reason:[7,13,15],receiv:4,recent:16,recent_map:[],recent_project:[],recommend:8,rectangl:[6,12,16],rectangular:12,red:[2,7,16],redo:[0,2,4,8,11,14,16],redraw:12,reduc:16,refer:[0,14],referenc:15,reflect:[12,16],refresh:12,regex:[10,13],regex_battle_scen:10,regex_behavior:10,regex_coord_event_weath:10,regex_flag:10,regex_item:10,regex_map_typ:10,regex_movement_typ:10,regex_mus:10,regex_obj_event_gfx:10,regex_secret_bas:10,regex_sign_facing_direct:10,regex_speci:10,regex_trainer_typ:10,regex_var:10,regex_weath:10,region:[0,1,5,6,8,10,12,13,16],region_map:[10,11],region_map_sect:[10,11],regist:0,registeract:[12,16],registertoggleact:[12,16],registri:16,regress:16,regular:[6,10,12,13],rejoic:16,rel:[10,11,12,13,16],relat:[0,10,12],releas:[6,8,16],reli:10,reload:[12,13,16],reloc:16,remain:12,rememb:[2,16],remov:[12,13,15,16],renam:16,render:[12,16],reopen:16,reopen_on_launch:[],reorder:16,reorgan:16,replac:[2,11,12,13,16],repo:16,report:16,repositori:13,repres:[2,7,12,13],repsawn:13,requir:[4,5,10,12,13,16],reselect:16,reset:[11,14,16],resili:16,resiz:[2,6,16],resolut:16,resolv:16,resourc:[],respawn:[4,10,13],respect:[8,13,16],respond:16,rest:[12,13],restor:[13,14,16],restrict:11,result:8,retain:16,retriev:12,rgb:[12,16],right:[1,2,3,4,6,7,9,11,12,13,14,15,16],rival:4,rme:11,rom:8,rooftop:5,root:[10,11,13],rope:[1,5,12,13],rotat:[12,16],round:[12,16],rout:[2,3],row:[2,13,16],rrggbb:12,rubi:5,rule:[12,15],ruler:[0,16],run:[1,5,12,13,16],same:[2,4,6,8,12,13,14,15,16],save:[3,6,7,8,12,13,14,15,16],scale:[12,14,16],scenario:[15,16],scene:[5,10,12],scratch:[11,15],screen:[7,8,15,16],script:[0,9,10,13,16,17],scroll:[6,16],seamlessli:3,search:[10,13,16],second:[2,8,9,13],secondari:[1,6,10,12,13,15,16],secret:[0,10,13,16],secret_bas:[4,10],secretbas:15,section:[1,4,5,6,9,10,11],see:[1,4,6,7,8,9,12,13,16],seem:9,seen:16,segment:13,select:[0,3,4,7,8,9,11,12,13,14,15,16],selector:[2,6,11,16],self:5,semant:[13,16],sensibl:16,separ:[12,13],sequenti:13,session:16,set:[0,2,4,6,7,9,10,11,14,15,16],setallowbik:12,setallowescap:12,setallowrun:12,setbattlescen:12,setblock:12,setblocksfromselect:12,setborderdimens:12,setborderheight:12,setbordermetatileid:12,setbordervis:12,setborderwidth:12,setclippingrect:12,setcollis:12,setdimens:12,setelev:12,setfloornumb:12,setgridvis:12,setheight:12,sethorizontalscal:12,seti:12,setloc:12,setmaintab:12,setmapviewtab:12,setmetatileattribut:12,setmetatilebehavior:12,setmetatilebehaviornam:[12,16],setmetatileencountertyp:12,setmetatileid:12,setmetatilelabel:12,setmetatilelayeropac:12,setmetatilelayerord:12,setmetatilelayertyp:12,setmetatileterraintyp:12,setmetatiletil:[12,16],setopac:12,setposit:12,setprimarytileset:12,setprimarytilesetpalett:12,setprimarytilesetpalettepreview:12,setprimarytilesetpalettespreview:12,setrequiresflash:12,setrot:12,setscal:[12,16],setsecondarytileset:12,setsecondarytilesetpalett:12,setsecondarytilesetpalettepreview:12,setsecondarytilesetpalettespreview:12,setshowlocationnam:12,setsmartpathsen:12,setsong:12,settimeout:12,settranspar:12,settyp:12,setup:8,setverticalscal:12,setvis:12,setweath:12,setwhiteoutrespawnwarpandhealernpc:4,setwidth:12,setx:12,sever:[7,12,15],shape:12,share:16,shealloc:10,shift:[0,3,4,12,14,16],shoe:5,shortcut:[0,2,6,8,11,12,16],should:[2,4,6,7,8,11,12,13,16],shouldn:8,show:[1,5,6,8,9,12,13,14,15,16],show_cursor_til:[],show_player_view:[],showerror:12,showmessag:12,shown:12,showquest:12,showwarn:12,shrink:16,side:[2,3,6,8,9,15],sight:4,sign:[0,10,16],signific:16,signpost:[2,4],silenc:[13,16],similar:[2,3,7],simpl:[4,7],simpli:[3,4,6,9,11,15],simplifi:6,simultan:11,sinc:[3,8,12,15,16],singl:[7,9,11,12,16],situat:[9,16],size:[6,11,12,13,16],slider:[2,6,11,15,16],slightli:16,slot:[7,16],slow:[12,16],small:4,smaller:12,smart:[0,2,12,14,16],smetatileattrmask:[10,13],smooth:16,snap:6,some:[1,2,4,6,8,9,10,12,16],someth:[0,2,4,7,11],sometim:[15,16],somewhat:16,song:[5,10,12],sort:[1,9,16],sourc:[8,15],south:2,space:[13,16],span:11,spawn_:[10,16],speci:[7,10,13],special:[2,4,12,13],specif:[4,10,13,16],specifi:[4,10,12,13,16],specifieid:12,specifii:12,speed:16,spin:13,spinbox:11,spinner:[2,4,12,15,16],split:15,spot:4,sprint:1,sprite:[4,10,13,16],spritesheet:16,squar:[4,11,16],src:[4,10,11],ssecretbaseentrancemetatil:4,sspawnpoint:10,stai:16,stair:2,stand:[4,15],standard:4,start:[0,2,6,12,13],startup:16,state:12,statu:16,steal:16,step:12,stick:16,still:[13,16],stitch:16,stop:[12,16],store:[11,13,14,16],straight:[0,12,14,16],straightforward:7,string:[11,12,16],struct:[10,16],studio:17,stuff:[],successfulli:[8,12],suffici:[11,12],summar:9,support:[5,6,8,10,11,12,13,14,16],sure:[2,3,8],surf:2,surround:[6,9],swap:11,swhiteoutrespawnhealcentermapidx:10,swhiteoutrespawnhealernpcid:10,symbol:[10,13,16],symbol_attribute_t:10,symbol_facing_direct:10,symbol_heal_loc:10,symbol_heal_locations_typ:10,symbol_obj_event_gfx_point:10,symbol_pokemon_icon_t:10,symbol_spawn_map:10,symbol_spawn_npc:10,symbol_spawn_point:10,symbol_tilesets_prefix:10,symbol_wild_encount:10,sync:[3,16],syntax:[10,13],system:16,tab:[0,2,3,4,6,7,9,10,12,13,16],tabl:[10,12,13,15,16],tag:12,take:[6,7,8,9,11,12,13,16],taken:16,tall:[12,15],target:[4,12],technic:[4,12],templat:[12,16],temporarili:[6,12,16],terrain:[12,13],terraintyp:12,test:12,text:[2,4,9,10,12,13,15,16],text_editor_goto_lin:[],text_editor_open_directori:[],textbox:[],than:[6,12,16],thei:[1,3,4,5,6,9,10,12,13,14,15,16],them:[2,3,4,5,6,7,12,13,16],theme:16,therefor:[7,8],thi:[1,2,3,4,5,6,7,9,10,11,12,13,15,16],thing:[4,5,6,7,8,9],think:[6,8],those:[6,8,12],though:[6,16],three:[4,11,12,13],through:[2,3,16],tile:[0,2,4,8,9,10,11,12,13,16],tileend:12,tileid:12,tileindex:12,tilemap:[11,16,17],tiles_per_metatil:12,tilesest:13,tileset:[0,1,8,10,11,16],tileset_checkerboard_fil:[],tilesetnam:12,tilesets_graph:10,tilesets_graphics_asm:10,tilesets_have_callback:[],tilesets_have_is_compress:[],tilesets_head:10,tilesets_headers_asm:10,tilesets_metatil:10,tilesets_metatiles_asm:10,tilestart:12,time:[2,4,6,7,8,9,12,13,15,16],timelaps:16,tint:12,titl:12,todo:[],togeth:[3,4,6,12,14],toggl:[6,12,14,16],toggld:16,toggleabl:16,too:[2,16],tool:[0,1,2,8,11,12,16],toolbar:[6,8],toolbutton:[14,15],top:[2,3,4,10,11,12,13,15,16],total:[2,7,10],tpl:16,track:[],tradit:8,trainer:[4,10,16],trainer_sight_or_berry_tree_id:16,trainer_typ:[10,16],trainer_type_norm:4,transform:12,transit:[2,4],transpar:[2,12,13,16],treat:[13,16],tree:[4,6,16],trigger:[0,9,10,12,13,16],tripl:[13,16],turn:16,two:[3,6,9,11,13,15],type:[0,1,4,5,9,10,11,12,13,16],typic:[2,4],u16:10,ubuntu:16,unabl:2,unavail:4,uncheck:[11,12,13],uncommit:12,undefin:10,under:[2,10,11,12,13,16],underli:[12,16],underlin:12,underscor:[12,16],undertand:2,underw:16,undo:[0,2,4,8,11,12,14,16],undoabl:16,unexpect:16,unfortun:4,unhappi:11,uniq:7,uniqu:[4,11,13],unknown:16,unless:[10,12,13],unlik:2,unlock:4,unnecessari:16,unpredict:16,unreleas:0,unsav:16,until:[7,12],unus:[15,16],updat:[2,3,6,12,13,16],upon:[],upstream:16,url:16,usabl:8,usag:[2,15],use:[1,2,4,6,7,8,9,10,11,12,13,14,15,16],use_:10,use_custom_border_s:[6,12,16],use_encounter_json:[],use_poryscript:16,usecach:12,used:[2,3,4,5,6,9,10,12,13,14,15,16,17],useful:[3,4,5,6,12,15,16],user:[0,1,2,6,8,10,11,12,13,15,16],uses:[2,4,6,7,12,13,15,16],using:[2,4,6,8,10,12,13,14,15,16],usual:12,util:16,valid:[2,11,13,16],valu:[2,3,4,5,6,10,11,12,13,15,16],vanilla:[7,13],var_valu:16,vari:[],variabl:4,varieti:15,variou:[5,6,8,9,16],veri:[2,3,4,6,12],version:[2,4,5,6,8,12,13,16],vertic:[3,12,16],via:[6,12,16],video:17,view:[2,3,4,5,6,9,11,12,14,16],visibl:[4,6,12,16],vision:5,visual:[0,2,16],vscale:[12,16],wai:[3,4,6,12,13],wait:12,walk:[2,3,4,9],want:[7,11,12,13],warn:[4,12,13,16],warp:[0,9,13,15,16],wasn:16,watch:16,water:[12,15],waterfal:12,weather:[0,5,9,10,12,13,16],web:12,websit:16,were:[4,6,16],weren:16,west:[2,3],what:[0,2,4,5,6,9,11,13],wheel:6,when:[1,2,3,4,5,6,8,9,10,11,12,13,15,16],whenev:[2,6,12,15],where:[4,6,11,12,13,15,16],whether:[1,2,5,12,15,16],which:[1,2,3,5,6,7,9,11,12,13,15,16],whichev:6,white:[2,4,6],whose:[13,16],why:2,widget:16,width:[1,11,12,13,16],wiki:13,wild:[0,9,10,12,13,15,16],wild_encount:10,window:[0,1,4,5,6,7,8,11,12,13,15,16],window_geometri:[],window_st:[],within:[4,9,14,15],without:[6,11,12,16],woman:4,won:[2,12,16],word:12,work:[6,8,9,15,16],workflow:[6,8,12],would:[2,12,16],wouldn:16,wrap:6,write:[0,8,10,13,16],written:[13,16],wrong:16,wsl:16,xcoord:12,xdelta:12,xflip:[12,16],xoffset:[12,16],ycoord:12,ydelta:12,yes:10,yet:[12,16],yflip:[12,16],yoffset:[12,16],you:[0,1,2,3,4,5,6,7,8,9,11,12,13,14,15,16,17],your:[1,3,4,5,6,7,8,9,10,11,12,13,14],yourself:[10,14],zoom:[2,6,11,14,16]},titles:["Porymap Documentation","Creating New Maps","Editing Map Collisions","Editing Map Connections","Editing Map Events","Editing Map Headers","Editing Map Tiles","Editing Wild Encounters","Introduction","Navigation","Project Files","The Region Map Editor","Scripting Capabilities","Porymap Settings","Shortcuts","The Tileset Editor","Changelog","Related Projects"],titleterms:{"break":16,"default":[],"function":12,"import":15,"new":[1,7],Added:16,Adding:[4,7],The:[11,15],Use:[],about:8,action:12,addit:[],advanc:15,allow:[],api:12,attribut:[],background:11,base:4,behavior:15,bike:[],border:6,bucket:6,button:4,callback:12,capabl:12,chang:[6,15,16],changelog:16,clone:4,collis:2,configur:7,connect:3,constant:12,creat:1,custom:12,delet:4,dive:3,document:0,edit:[2,3,4,5,6,7,12],editor:[9,11,12,14,15],elev:[],emerg:3,enabl:[],encount:[7,15],entri:11,escap:[],event:[4,13],field:7,file:[10,13],fill:6,fix:16,floor:[],follow:3,from:15,game:[],gener:13,get:8,global:13,group:7,header:[5,12],heal:4,healspot:4,hidden:4,identifi:13,imag:[11,15],introduct:8,iscompress:[],item:4,itemfind:[],label:15,layer:15,layout:11,list:9,locat:4,main:[9,14],map:[1,2,3,4,5,6,9,11,12,13,14,15],mask:[],menu:15,metatil:[6,15],mirror:3,navig:9,npc:[],number:15,object:4,open:4,option:[1,6],other:15,output:[],overlai:12,paint:2,palett:15,path:6,pencil:6,pointer:6,porymap:[0,8,13],poryscript:[],posit:4,prefab:6,prefer:[],project:[10,13,17],properti:15,quantiti:[],redo:6,region:[9,11,14],regist:12,relat:17,repsawn:[],requir:[],ruler:4,run:[],script:[4,12],secret:4,select:[2,6],separ:[],set:[12,13],shift:6,shortcut:14,show:[],sign:4,size:[],smart:6,start:8,straight:6,tab:11,terrain:15,text:[],tile:[6,15],tileset:[6,9,12,13,14,15],tool:[4,6,15],trigger:4,tripl:[],type:[2,15],undo:6,unreleas:16,util:12,version:[],visual:6,warp:[3,4],weather:4,wild:7,window:[9,14],write:12}}) \ No newline at end of file +Search.setIndex({docnames:["index","manual/creating-new-maps","manual/editing-map-collisions","manual/editing-map-connections","manual/editing-map-events","manual/editing-map-header","manual/editing-map-tiles","manual/editing-wild-encounters","manual/introduction","manual/navigation","manual/project-files","manual/region-map-editor","manual/scripting-capabilities","manual/settings-and-options","manual/shortcuts","manual/tileset-editor","reference/changelog","reference/related-projects"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:54},filenames:["index.rst","manual/creating-new-maps.rst","manual/editing-map-collisions.rst","manual/editing-map-connections.rst","manual/editing-map-events.rst","manual/editing-map-header.rst","manual/editing-map-tiles.rst","manual/editing-wild-encounters.rst","manual/introduction.rst","manual/navigation.rst","manual/project-files.rst","manual/region-map-editor.rst","manual/scripting-capabilities.rst","manual/settings-and-options.rst","manual/shortcuts.rst","manual/tileset-editor.rst","reference/changelog.md","reference/related-projects.rst"],objects:{"":{onBlockChanged:[12,1,1,""],onBlockHoverChanged:[12,1,1,""],onBlockHoverCleared:[12,1,1,""],onBorderMetatileChanged:[12,1,1,""],onBorderResized:[12,1,1,""],onBorderVisibilityToggled:[12,1,1,""],onMainTabChanged:[12,1,1,""],onMapOpened:[12,1,1,""],onMapResized:[12,1,1,""],onMapShifted:[12,1,1,""],onMapViewTabChanged:[12,1,1,""],onProjectClosed:[12,1,1,""],onProjectOpened:[12,1,1,""],onTilesetUpdated:[12,1,1,""]},"constants.version":{major:[12,0,1,""],minor:[12,0,1,""],patch:[12,0,1,""]},constants:{base_game_version:[12,0,1,""],layers_per_metatile:[12,0,1,""],max_primary_metatiles:[12,0,1,""],max_primary_tiles:[12,0,1,""],max_secondary_metatiles:[12,0,1,""],max_secondary_tiles:[12,0,1,""],metatile_behaviors:[12,0,1,""],num_primary_palettes:[12,0,1,""],num_secondary_palettes:[12,0,1,""],tiles_per_metatile:[12,0,1,""]},map:{bucketFill:[12,1,1,""],bucketFillFromSelection:[12,1,1,""],commit:[12,1,1,""],getAllowBiking:[12,1,1,""],getAllowEscaping:[12,1,1,""],getAllowRunning:[12,1,1,""],getBattleScene:[12,1,1,""],getBlock:[12,1,1,""],getBorderDimensions:[12,1,1,""],getBorderHeight:[12,1,1,""],getBorderMetatileId:[12,1,1,""],getBorderWidth:[12,1,1,""],getCollision:[12,1,1,""],getDimensions:[12,1,1,""],getElevation:[12,1,1,""],getFloorNumber:[12,1,1,""],getHeight:[12,1,1,""],getLocation:[12,1,1,""],getMetatileAttributes:[12,1,1,""],getMetatileBehavior:[12,1,1,""],getMetatileBehaviorName:[12,1,1,""],getMetatileEncounterType:[12,1,1,""],getMetatileId:[12,1,1,""],getMetatileLabel:[12,1,1,""],getMetatileLayerType:[12,1,1,""],getMetatileTerrainType:[12,1,1,""],getMetatileTile:[12,1,1,""],getMetatileTiles:[12,1,1,""],getNumPrimaryTilesetMetatiles:[12,1,1,""],getNumPrimaryTilesetTiles:[12,1,1,""],getNumSecondaryTilesetMetatiles:[12,1,1,""],getNumSecondaryTilesetTiles:[12,1,1,""],getPrimaryTileset:[12,1,1,""],getPrimaryTilesetPalette:[12,1,1,""],getPrimaryTilesetPalettePreview:[12,1,1,""],getPrimaryTilesetPalettes:[12,1,1,""],getPrimaryTilesetPalettesPreview:[12,1,1,""],getRequiresFlash:[12,1,1,""],getSecondaryTileset:[12,1,1,""],getSecondaryTilesetPalette:[12,1,1,""],getSecondaryTilesetPalettePreview:[12,1,1,""],getSecondaryTilesetPalettes:[12,1,1,""],getSecondaryTilesetPalettesPreview:[12,1,1,""],getShowLocationName:[12,1,1,""],getSong:[12,1,1,""],getTilePixels:[12,1,1,""],getType:[12,1,1,""],getWeather:[12,1,1,""],getWidth:[12,1,1,""],magicFill:[12,1,1,""],magicFillFromSelection:[12,1,1,""],redraw:[12,1,1,""],setAllowBiking:[12,1,1,""],setAllowEscaping:[12,1,1,""],setAllowRunning:[12,1,1,""],setBattleScene:[12,1,1,""],setBlock:[12,1,1,""],setBlocksFromSelection:[12,1,1,""],setBorderDimensions:[12,1,1,""],setBorderHeight:[12,1,1,""],setBorderMetatileId:[12,1,1,""],setBorderWidth:[12,1,1,""],setCollision:[12,1,1,""],setDimensions:[12,1,1,""],setElevation:[12,1,1,""],setFloorNumber:[12,1,1,""],setHeight:[12,1,1,""],setLocation:[12,1,1,""],setMetatileAttributes:[12,1,1,""],setMetatileBehavior:[12,1,1,""],setMetatileBehaviorName:[12,1,1,""],setMetatileEncounterType:[12,1,1,""],setMetatileId:[12,1,1,""],setMetatileLabel:[12,1,1,""],setMetatileLayerType:[12,1,1,""],setMetatileTerrainType:[12,1,1,""],setMetatileTile:[12,1,1,""],setMetatileTiles:[12,1,1,""],setPrimaryTileset:[12,1,1,""],setPrimaryTilesetPalette:[12,1,1,""],setPrimaryTilesetPalettePreview:[12,1,1,""],setPrimaryTilesetPalettes:[12,1,1,""],setPrimaryTilesetPalettesPreview:[12,1,1,""],setRequiresFlash:[12,1,1,""],setSecondaryTileset:[12,1,1,""],setSecondaryTilesetPalette:[12,1,1,""],setSecondaryTilesetPalettePreview:[12,1,1,""],setSecondaryTilesetPalettes:[12,1,1,""],setSecondaryTilesetPalettesPreview:[12,1,1,""],setShowLocationName:[12,1,1,""],setSong:[12,1,1,""],setType:[12,1,1,""],setWeather:[12,1,1,""],setWidth:[12,1,1,""],shift:[12,1,1,""]},overlay:{addImage:[12,1,1,""],addMetatileImage:[12,1,1,""],addPath:[12,1,1,""],addRect:[12,1,1,""],addText:[12,1,1,""],addTileImage:[12,1,1,""],clear:[12,1,1,""],clearClippingRect:[12,1,1,""],createImage:[12,1,1,""],getHorizontalScale:[12,1,1,""],getOpacity:[12,1,1,""],getPosition:[12,1,1,""],getRotation:[12,1,1,""],getVerticalScale:[12,1,1,""],getVisibility:[12,1,1,""],getX:[12,1,1,""],getY:[12,1,1,""],hide:[12,1,1,""],move:[12,1,1,""],rotate:[12,1,1,""],setClippingRect:[12,1,1,""],setHorizontalScale:[12,1,1,""],setOpacity:[12,1,1,""],setPosition:[12,1,1,""],setRotation:[12,1,1,""],setScale:[12,1,1,""],setVerticalScale:[12,1,1,""],setVisibility:[12,1,1,""],setX:[12,1,1,""],setY:[12,1,1,""],show:[12,1,1,""]},utility:{error:[12,1,1,""],getBattleSceneNames:[12,1,1,""],getBorderVisibility:[12,1,1,""],getCustomScripts:[12,1,1,""],getGridVisibility:[12,1,1,""],getInputItem:[12,1,1,""],getInputNumber:[12,1,1,""],getInputText:[12,1,1,""],getLocationNames:[12,1,1,""],getMainTab:[12,1,1,""],getMapNames:[12,1,1,""],getMapTypeNames:[12,1,1,""],getMapViewTab:[12,1,1,""],getMetatileBehaviorNames:[12,1,1,""],getMetatileLayerOpacity:[12,1,1,""],getMetatileLayerOrder:[12,1,1,""],getPrimaryTilesetNames:[12,1,1,""],getSecondaryTilesetNames:[12,1,1,""],getSmartPathsEnabled:[12,1,1,""],getSongNames:[12,1,1,""],getTilesetNames:[12,1,1,""],getWeatherNames:[12,1,1,""],isPrimaryTileset:[12,1,1,""],isSecondaryTileset:[12,1,1,""],log:[12,1,1,""],registerAction:[12,1,1,""],registerToggleAction:[12,1,1,""],setBorderVisibility:[12,1,1,""],setGridVisibility:[12,1,1,""],setMainTab:[12,1,1,""],setMapViewTab:[12,1,1,""],setMetatileLayerOpacity:[12,1,1,""],setMetatileLayerOrder:[12,1,1,""],setSmartPathsEnabled:[12,1,1,""],setTimeout:[12,1,1,""],showError:[12,1,1,""],showMessage:[12,1,1,""],showQuestion:[12,1,1,""],showWarning:[12,1,1,""],warn:[12,1,1,""]}},objnames:{"0":["js","attribute","JavaScript attribute"],"1":["js","function","JavaScript function"]},objtypes:{"0":"js:attribute","1":"js:function"},terms:{"0e8ccfc4fd3544001f4c25fafd401f7558bdefba":16,"0x0":[13,16],"0x000":13,"0x014":13,"0x015":13,"0x01c":13,"0x01d":13,"0x1":[12,13],"0x10":12,"0x11":12,"0x1d4":13,"0x1d5":13,"0x1dc":13,"0x1dd":13,"0x1ff":13,"0x220":15,"0x3e00":13,"0x3ff":13,"0x4":[8,12],"0x60000000":13,"0x7000000":13,"0x8":12,"0x9":12,"0xc00":13,"0xd":12,"0xf000":13,"0xff":13,"2x2":13,"3x3":6,"4bpp":11,"82abc164dc9f6a74fdf0c535cc1621b7ed05318b":16,"8bpp":[11,16],"8x8":[12,15],"boolean":12,"byte":13,"case":[2,4,13],"const":12,"default":[4,6,7,9,10,11,12,13,14,16],"export":[12,15,16],"final":[8,12],"function":[4,8,11,13,16],"goto":4,"import":[2,6,13,16],"long":[2,12,16],"new":[0,2,3,4,6,9,10,11,12,13,14,15,16],"null":[13,16],"pok\u00e9":6,"pok\u00e9cent":4,"pok\u00e9mon":[4,6,9,10,13,16],"return":[4,12],"switch":[9,12,15,16],"true":[2,12,13],"try":[2,12],"var":[4,10],"while":[2,4,6,12,13,14,16],AND:4,Adding:0,For:[1,2,3,4,5,6,7,9,11,12,13,14,15,16],IDs:[10,16],Its:[8,16],MUS:10,NOT:12,One:[7,12],That:8,The:[0,1,2,4,5,6,7,8,9,10,12,13,16],Their:13,Then:[2,6,7,12],There:[4,8,11,12,15],These:[2,3,6,7,10,12,13,15],Use:[4,6,13],Used:[5,15],Useful:12,With:[4,12],YES:12,Yes:12,a0ba1b7c6353f7e4f3066025514c05b323a0123d:16,a1ea3b5e394bc115ba9b86348c161094a00dcca7:16,aarrggbb:12,abil:[2,4,12,16],abl:[2,4,11,12],about:[0,12,16],abov:[2,4,6,8,9,11,12,15,16],accept:[7,12],access:[4,12,13,16],accomod:16,accomplish:6,accord:[13,16],accordingli:16,accur:16,across:[13,15],act:16,action:[0,6,14,16],actionnam:12,activ:[4,7,12,16],actual:[4,12,16],ad365a35c1536740cbcbc10bee66e5dd908c39e7:16,adb0a444577b59eb02788c782a3d04bc285be0ba:16,add:[1,3,4,7,11,12,13,15,16],added:[12,16],addfilledrect:16,addimag:[12,16],adding:[7,16],addit:[5,8,10,12,13,15],addition:[4,6,12,13,16],addmetatileimag:12,addpath:12,addrect:[12,16],addtext:12,addtileimag:12,adher:16,adjac:[4,12],adjust:[6,7,15,16],adob:15,advanc:[2,8,16,17],advancemap:[13,16],affect:12,after:[2,4,6,8,10,12,16],again:[4,6],alia:11,all:[2,3,4,6,7,9,11,12,13,14,15,16],allow:[1,2,4,5,6,7,8,9,12,13,15,16],alon:12,along:2,alongsid:13,alphabet:16,alreadi:[12,14],also:[2,4,5,6,7,10,11,12,13,14,15,16],alter:7,altern:[1,4],altogeth:15,alwai:[2,4,16],amount:16,angl:12,ani:[1,2,4,6,9,11,12,13,15,16],anim:[4,12,16],anoth:[4,6,7,9,11,16],anyth:[4,6,12],api:[0,16],app:13,appdata:[13,14],appear:[4,6,9,11,12,15,16],append:[5,10],appli:[12,15,16],applic:[9,13,14,16],applymov:4,applynighttint:12,appropri:2,arbitrarili:16,area:[2,4,6,8,9,11,12,16],aren:[10,16],argument:[12,15,16],around:[4,6,9,11,16],arrai:[11,12],arriv:4,arrow:[4,16],asid:13,assign:[4,7,16],associ:[1,2,4,11,13,15],assum:[12,16],attempt:[15,16],attribut:[12,13,15,16],autcomplet:16,auto:16,autocomplet:16,automat:[3,4,5,12,13,15,16],avail:[4,6,7,8,9,11,13],awai:7,awar:6,axi:6,back:[6,16],background:[0,5,9,12,15],bad:16,bar:[12,16],base:[0,1,6,7,10,11,13,16],base_game_vers:[12,16],basement:5,basic:[2,6,8,9,12],batch:12,battl:[4,5,10,12],battlescen:12,bbg_event_player_facing_:10,bcoord_event_weather_:10,becaus:[2,4,9,12,13],becom:[13,16],been:[12,16],befor:[2,6,8,12,16],begin:[],behav:[4,12,16],behavior:[10,12,13,16],behind:[12,16],being:[2,8,13,16],bele:1,belong:5,below:[2,4,6,7,10,12,16],berri:4,better:16,between:[2,3,4,9,11,12,15,16],beyond:16,bflag_:10,bigger:6,bike:[1,5,12,13],bin:[10,13],binari:[8,11,15],bit:[12,13,15,16],bitem_:10,black:12,blob:[],block:[1,2,12,16],blue:4,bmap_battle_scene_:10,bmap_type_:10,bmb_:10,bmovement_type_:10,bobj_event_gfx_:10,boi:17,border:[0,1,4,10,12,13,16],bordercolor:[12,16],both:[3,6,13,15,16],bottom:[2,6,12,13,15,16],bound:[4,16],boundari:16,box:[4,7,10,11,12,13,15,16],bread:6,bridg:2,brief:4,briefli:9,bring:[4,6,7,9,11],browser:12,brush:12,bsecret_base_:10,bspecies_:10,btrainer_type_:10,bucket:[0,12,14],bucketfil:12,bucketfillfromselect:12,bug:16,build:[4,6,8,12],built:[6,16],bulk:16,bump:16,butter:6,button:[0,3,6,7,8,9,10,11,12,13,15,16],bvar_:10,bvd:[15,16],bweather_:10,c68ba9f4e8e260f2e3389eccd15f6ee5f4bdcd3:16,c73de8bed752ca538d90cfc93c4a9e8c7965f8c9:16,cach:12,calcul:[10,16],call:[6,12,16],callabl:12,callback:[13,16],can:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],cancel:[12,14],cannot:[1,4,5,14,16],capabl:[0,16],categori:15,caus:[12,16],cave:7,cdae0c1444bed98e652c87dc3e3edcecacfef8b:16,ceil:12,center:[1,4,6,9,16],certain:[4,10,12,15,16],cfg:[6,13,14,16],chain:6,chanc:7,chang:[0,1,3,4,7,8,9,11,12,13],changelog:0,charact:[4,16],check:[4,6,7,9,12,13,16],checkbox:[3,6,16],checkerboard:16,choos:[4,6,7,8,9,10,12],citi:[3,8],clear:[11,12,16],clearclippingrect:12,click:[1,2,3,4,6,7,8,9,11,12,14,16],cliff:2,clip:[12,16],clipboard:16,clockwis:12,clone:[0,13,16],close:[4,12,16],code:[4,12,13,15],collaps:[9,16],collect:5,collid:12,collis:[0,4,6,8,9,12,13,16],collision_opac:[],color:[12,15,16,17],column:[2,13],com:[0,13,16],combin:[2,15],combo:[4,16],combobox:[11,16],comma:13,command:[4,14,16],comment:16,commit:[12,13,16],commitchang:12,common:2,commonli:[2,16],compat:16,compil:8,complet:12,comprehens:[14,16],concept:2,config:[6,12,13,16],configur:[0,6,11,13,16],confirm:[12,13],conjunct:6,connect:[0,4,6,8,9,12,16],consecut:12,consid:13,consist:[12,13,16],constant:[10,11,15,16],constants_event_bg:10,constants_fieldmap:10,constants_flag:10,constants_glob:10,constants_heal_loc:10,constants_item:10,constants_map_group:10,constants_map_typ:10,constants_metatile_behavior:10,constants_metatile_label:10,constants_obj_ev:10,constants_obj_event_mov:10,constants_oppon:[],constants_pokemon:10,constants_region_map_sect:10,constants_secret_bas:10,constants_song:10,constants_trainer_typ:10,constants_var:10,constants_weath:10,construct:13,contain:[4,9,12,13,15,16],content:12,context:[9,15],contigu:[6,16],continu:[2,6],contrast:16,control:[2,4,5,8],conveni:[4,6,12,15,16],convert:[15,16],coord:12,coordin:[4,11,12,16],coorespond:16,copi:[6,7,15,16],corner:[3,12],correctli:[13,16],correspond:[11,13,16],corrupt:16,could:[12,16],count:[2,10,15,16],counterclockwis:12,coupl:11,cover:[4,9,15],crash:16,creat:[0,4,6,7,9,11,12,13,15,16],create_map_text_fil:[],createimag:[12,16],creation:6,critic:12,cross:8,crosshair:[],ctrl:[3,4,6,8,9,11,12,14,16],cumbersom:12,current:[2,4,6,7,8,9,11,12,13,14,15,16],cursor:[4,6,11,14,16],custom:[0,1,5,6,11,13,14,16],custom_script:[],cut:16,dai:[7,12],dark:16,data:[6,7,8,10,11,12,13,15,16],data_event_script:10,data_heal_loc:10,data_layouts_fold:10,data_map_fold:10,data_obj_event_gfx:10,data_obj_event_gfx_info:10,data_obj_event_gfx_point:10,data_obj_event_pic_t:10,data_pokemon_gfx:10,data_scripts_fold:10,data_tilesets_fold:10,date:16,daunt:9,deactiv:4,debug:12,decim:12,decompil:[8,16,17],decor:12,default_primary_tileset:[],default_secondary_tileset:[],defin:[6,11,12,13,15,16],define_attribute_behavior:10,define_attribute_encount:10,define_attribute_lay:10,define_attribute_terrain:10,define_heal_locations_prefix:10,define_map_dynam:10,define_map_empti:10,define_map_prefix:10,define_map_s:10,define_map_section_count:10,define_map_section_empti:10,define_map_section_prefix:10,define_mask_behavior:10,define_mask_collis:10,define_mask_elev:10,define_mask_lay:10,define_mask_metatil:10,define_max_level:10,define_metatile_label_prefix:10,define_metatiles_primari:10,define_min_level:10,define_obj_event_count:10,define_pals_primari:10,define_pals_tot:10,define_spawn_prefix:10,define_tiles_primari:10,define_tiles_tot:10,definit:13,degre:12,del:[14,16],delai:12,delaym:12,delet:[0,3,11,12,14,15,16],deltai:12,deltax:12,demand:12,demonstr:6,denot:2,depend:[1,6,12,13,16],depth:[15,16],describ:[4,7],descript:4,design:6,desir:[3,6,9],despit:16,destin:[3,4],detail:[4,6,9,11,12,13,16],detailedtext:12,detect:12,determin:[2,4,11,13,15],diagonist:12,dialog:[8,9,12,14,16],did:16,diff:16,differ:[1,2,4,6,9,11,12,13,15,16],difficulti:8,dig:[5,12,13],dimens:[6,10,11,12,13,16],direct:[2,3,4,6,10,13,16],directli:[4,12,13],directori:[12,16],disabl:[6,7,10,12,13,16],disallow:16,disappear:16,disassembl:17,discontin:[],disk:[7,12],displai:[1,4,6,7,8,11,12,13,15,16],disppear:[],dissect:4,distanc:[4,16],distinguish:11,dive:0,divid:13,document:[12,16],doe:[4,6,8,10,12,13],doesn:[2,6,12,13,16],doing:8,don:[3,16],done:[11,15],doubl:[3,4,9,11,16],down:[6,7,8,16],download:[8,12],drag:[3,4,6,11,14,16],draw:[4,8,11,12,14,15,16],drawn:[12,16],drop:[7,16],dropdown:[3,6,12,13,15,16],due:16,dummi:4,duplic:[4,14,16],dure:[2,4,16],dynam:[4,10],each:[2,4,5,6,7,9,10,11,12,13,15,16],easi:[1,4,6],easier:[6,11,15,16],easiest:3,east:[2,3],ecmascript:12,ecount:10,edg:12,edit:[0,8,9,10,11,13,14,15,16],editor:[0,4,8,13,16,17],effect:[13,15,16],either:[2,6,9,12,13,15,16],element:[12,16],elev:[1,2,4,12,13,16],ellips:16,ellipt:12,els:[2,4],elsewher:12,emerg:0,empti:[7,8,10,12,13,16],enabl:[3,6,10,12,13,16],enable_event_clone_object:[],enable_event_secret_bas:[],enable_event_weather_trigg:[],enable_floor_numb:[],enable_heal_location_respawn_data:[],enable_hidden_item_quant:[],enable_hidden_item_requires_itemfind:[],enable_map_allow_flag:[],enable_triple_layer_metatil:[12,16],enclos:12,encount:[0,10,12,13,16],encountertyp:12,end:[10,16],endless:12,enforc:[7,13,16],engin:[4,5],enhanc:12,ensur:4,enter:[1,2,4,5,9,10,11,12,14],entir:[6,11,12,15,16],entranc:4,entri:[0,12,16],equal:4,equival:8,eras:12,error:[12,16],escap:[1,5,12,13],essenti:12,etc:16,evalu:16,even:[2,6,12,14],evenli:13,event:[0,1,3,8,9,10,12,14,16],event_bg:10,event_object:10,event_object_mov:10,event_script:10,everi:[6,11,12,13,15],exactli:6,exampl:[1,2,3,4,5,6,11,12,15,16],except:[2,4],exchang:11,exclus:[4,5,15],execut:[4,12],exist:[1,4,6,8,10,11,12,13,16],exit:[4,12,13,16],expand:[5,9,16],expect:[10,13,16],expens:12,explain:4,explan:11,explanatori:5,explicitli:16,explor:2,express:[10,13,16],extend:[4,16],extens:[4,12,16],extra:16,extract:10,extrem:3,eyedrop:16,eyedropp:[6,14,15],face:[4,10,15,16],fail:[13,16],fake:12,fall:16,fals:12,familiar:8,fan:16,favor:16,featur:[2,3,8,9,11,16],feel:0,few:[4,6,8,9,16],field:[0,4,5,6,11,13,16],fieldmap:10,file:[0,3,4,6,8,9,11,12,15,16],filepath:[10,11,12,13,16],fill:[0,2,12,13,14,16],fillcolor:[12,16],filter:[9,16],find:[0,10,13,16],finish:[2,11],first:[2,4,6,7,8,9,11,12,13,16],fit:16,fix:6,flag:[4,10,16],flash:[5,12],flip:[11,12,16],floor:[1,5,12,13,16],floornumb:12,flow:[2,6],flower:[8,12],floweri:8,fly:[1,4],focu:16,folder:[1,8,9,10,13,16],follow:[0,6,8,12],font:12,forc:[12,13],forceredraw:12,fork:12,form:[12,15],format:[6,11,12,15,16,17],found:[4,8,10,13,15,16],four:[7,13],frame:[10,16],freeli:12,frlg:16,from:[1,2,4,6,7,8,9,10,11,12,13,14,16,17],front:[4,16],full:[12,16],fullest:9,func:12,functionnam:12,game:[2,4,5,6,7,8,9,11,12,13,16,17],gameplai:[2,4,9],gba:15,gen:[8,17],gener:[2,8,10,12,14],get:[0,6,10,12,16],getallowbik:12,getallowescap:12,getallowrun:12,getbattlescen:12,getbattlescenenam:12,getblock:12,getborderdimens:12,getborderheight:12,getbordermetatileid:12,getbordervis:12,getborderwidth:12,getcollis:12,getcustomscript:12,getdimens:12,getelev:12,getfloornumb:12,getgridvis:12,getheight:12,gethorizontalscal:12,geti:12,getinputitem:12,getinputnumb:12,getinputtext:12,getloc:12,getlocationnam:12,getmaintab:12,getmapnam:12,getmaptypenam:12,getmapviewtab:12,getmetatileattribut:12,getmetatilebehavior:12,getmetatilebehaviornam:[12,16],getmetatileencountertyp:12,getmetatileid:12,getmetatilelabel:12,getmetatilelayeropac:12,getmetatilelayerord:12,getmetatilelayertyp:12,getmetatileterraintyp:12,getmetatiletil:12,getnumprimarytilesetmetatil:12,getnumprimarytilesettil:12,getnumsecondarytilesetmetatil:12,getnumsecondarytilesettil:12,getopac:12,getposit:12,getprimarytileset:12,getprimarytilesetnam:12,getprimarytilesetpalett:12,getprimarytilesetpalettepreview:12,getprimarytilesetpalettespreview:12,getrequiresflash:12,getrot:12,getsecondarytileset:12,getsecondarytilesetnam:12,getsecondarytilesetpalett:12,getsecondarytilesetpalettepreview:12,getsecondarytilesetpalettespreview:12,getshowlocationnam:12,getsmartpathsen:12,getsong:12,getsongnam:12,gettilepixel:12,gettilesetnam:12,gettyp:12,getverticalscal:12,getvis:12,getweath:12,getweathernam:12,getwidth:12,getx:12,gif:[6,16],ginitialmovementtypefacingdirect:10,git:[4,8],github:[0,13,16],gitignor:13,give:[4,6,7,9,16],given:[7,12,15,16],global:[0,4,10,12],global_fieldmap:10,gmonicont:10,gobjecteventgraphicsinfopoint:10,goe:12,going:[4,14],good:[10,12],gpl:16,grai:15,graphic:[2,4,5,10,13,16],graphics_file_rul:15,grass:[2,8,12,15],grasstil:12,grayscal:16,great:8,green:[4,7],greet:8,grid:[6,12,14,16],group:[0,1,6,9,13,14,16],grow:16,gtileset_:10,gtileset_gener:13,gtileset_pallettown:13,gtileset_petalburg:13,guarante:[12,16],gwildmonhead:10,hack:[8,15],had:13,half:2,handl:16,happen:[4,12,16],hardcod:[4,16],hardwar:15,has:[2,3,4,5,9,11,12,14,15,16],have:[2,3,4,6,7,8,9,11,12,13,14,15,16],head:11,headbutt_mon:7,header:[0,9,10,13,16],heal:[0,1,10,13,16],heal_loc:[4,10],heal_location_:[10,16],healloc:10,healspot:0,height:[1,11,12,13,16],help:[6,15,16],here:[2,12,13,14,15],hex:[15,16],hexadecim:2,hidden:[0,6,10,12,13,16],hide:[1,5,12,16],hierarch:9,high:17,higher:12,highest:13,highli:8,highlight:16,higlight:11,histori:[2,12,14,16],hit:16,hold:[4,6,14,16],home:16,hop:2,horizont:[3,12,16],hous:16,hover:[6,16],how:[2,4,6,8,9,12,16],howev:[4,6,12],hscale:[12,16],html:12,http:[0,13,16],huderlem:[0,16],huge:16,ice:15,icon:[6,10,12,13,16],idea:10,ident:[2,6],identifi:10,ids:12,ignor:[8,16],illustr:[2,6],imag:[0,2,4,6,10,12,13,16],immedi:16,impass:[2,12],implement:7,implicitli:12,improperli:16,improv:[8,16],inanim:16,inc:[4,10,13,16],incbin_u16:13,incbin_u32:13,incbin_u8:13,includ:[2,4,6,7,9,10,11,13,15,16],inclus:12,incomapt:[],incompat:[6,16],incorrect:16,incorrectli:16,increment:12,independ:16,index:[7,12,15,16],indexof:12,indic:[6,12,15,16],individu:[6,12,15,16],indoor:1,info:12,inform:[12,13,16],informativetext:12,inherit:4,initi:[12,13,16],initial_facing_t:10,input:[12,16],insert:12,insid:[4,12],instal:8,instanc:[11,13],instead:[4,10,12,13,16],integ:[11,16],integr:[10,16],interact:[2,4,9,12,16],interchang:16,interest:12,interpret:16,interrupt:16,interv:12,introduc:16,introduct:0,invalid:16,investig:[],invis:[4,12],involv:4,iscompress:13,isprimarytileset:12,issecondarytileset:12,issu:16,item:[0,5,10,12,13,16],itemfind:[4,13,16],iter:16,its:[4,6,12,15,16],itself:12,jasc:[15,16],javascript:[12,16],json:[6,7,10,11,13,16],json_layout:10,json_map_group:10,json_region_map_entri:10,json_region_porymap_cfg:10,json_wild_encount:10,jump:16,junk:16,just:[1,2,6,7,15],kanto:16,keep:[3,5,16],kei:[6,14,16],keyboard:[11,12,14,16],keyword:12,known:4,label:[10,11,12,13,16],laid:6,land:[2,12],languag:17,larg:[6,16],larger:[6,9],last:[12,16],later:12,launch:[8,13,16],layer:[12,13,16],layers_per_metatil:12,layertyp:12,layout:[0,1,9,10,13,16],layouts_t:16,learn:[6,8,9],leav:[2,12],left:[2,4,6,8,9,11,12,13,14,15,16],length:12,let:[2,4,6,7,8,9,11,12,17],letter:12,level:[2,7,10,16,17],librari:[13,14],life:[4,6],like:[2,4,6,9,12,13,15,16],limit:[5,10,12,13,15,16],line:[4,6,13,16],linux:[8,16],list:[0,1,4,6,10,11,12,13,14,16],listen:17,littl:4,load:[4,8,9,12,13,16],local:4,locat:[0,1,5,6,8,10,11,12,13,16],lock:[4,6,16],log:[12,16],logic:12,longer:[4,16],look:[0,4,8,9,11],lose:16,lot:15,lower:[12,16],mac:[8,16],maco:[13,14,16],macro:[10,13,16],made:[7,12,13,16],magic:[12,14,16],magicfil:12,magicfillfromselect:12,mai:[1,2,4,7,13,15,16],main:[0,6,7,8,11,12,13,16],main_splitter_st:[],maintain:[2,10],major:[12,16],make:[2,4,6,8,11,12,13,15,16],makefil:15,manag:12,mani:[4,8,9,11,12,14,15,16],manipul:[7,12],manual:[0,12,15],map:[0,7,8,10,16,17],map_:10,map_dynam:16,map_group:10,map_groups_count:16,map_non:16,map_sort_ord:[],map_splitter_st:[],map_typ:10,map_type_indoor:5,mapgrid_collision_mask:[10,13],mapgrid_elevation_mask:[10,13],mapgrid_metatile_id_mask:[10,13],mapjson:16,mapnam:12,mapsec_:10,mapsec_non:11,mark:[4,12],mart:6,mask:[10,13,16],master:[],match:[4,6,13,16],math:12,max:[12,13,16],max_level:10,max_map_data_s:10,max_primary_metatil:12,max_primary_til:12,max_secondary_metatil:12,max_secondary_til:12,maximum:[7,10,12,13,16],mb_tall_grass:12,mean:[2,3,4,12],meant:17,measur:[4,16],memori:12,menu:[0,3,7,12,16],messag:[12,16],met:12,metatil:[0,1,2,4,8,9,10,12,13,14,16],metatile_:10,metatile_attr_behavior_mask:[10,13],metatile_attr_layer_mask:[10,13],metatile_attribut:13,metatile_attribute_behavior:10,metatile_attribute_encounter_typ:10,metatile_attribute_layer_typ:10,metatile_attribute_terrain:10,metatile_attributes_s:[],metatile_behavior:[10,12,15,16],metatile_behavior_mask:[],metatile_encounter_type_mask:[],metatile_general_grass:[],metatile_general_plain_grass:15,metatile_id:[],metatile_label:[10,15,16],metatile_layer_type_mask:[],metatile_secretbase_pc:15,metatile_terrain_type_mask:[],metatileid:12,metatiles_zoom:[],method:[6,16],middl:[6,12,14,15,16],might:[7,12],millisecond:12,mimic:16,min:[12,16],min_level:10,minimum:[7,10,12,16],minor:[12,16],mirror:0,miscellan:[5,12],mislead:16,miss:[0,16],mistak:[6,11],mode:[1,9,14,16],modif:2,modifi:[6,9,11,12,13,15,16],moment:12,monitor:16,monitor_fil:[],more:[4,6,8,9,11,12,13,14,15,16],most:[2,8,9,11,16],mostli:5,mountain:[2,6],mous:[4,6,11,12,16],mouseov:16,move:[2,3,4,5,12,14,16],movement:[4,10,16],much:8,multi:[2,16],multilin:16,multipl:[4,6,7,11,14,16],music:[5,9,10,16,17],must:[3,4,6,7,8,12,15],my_script:12,name:[1,4,5,6,7,9,10,11,12,13,15,16],nativ:[],navig:[0,3,4,7,8,11,16],nearli:2,necessari:[],need:[2,3,4,5,6,11,12,13,15,16],neg:[5,11,12,16],never:4,new_map_border_metatil:[],new_map_elev:[],new_map_metatil:[],newblock:12,newheight:12,newli:[12,16],newmetatileid:12,newtab:12,newwidth:12,next:[2,4,7,8,9,12,15,16],nice:12,night:12,nodej:12,nodep:8,non:[4,11,16],none:[10,12],normal:[4,6,12,13,15],north:2,notabl:[8,16],note:[5,10,12,13],noth:[4,12,16],notic:[11,12,16],now:[2,6,7,8,12,16],npc:[4,10,13],num_metatiles_in_primari:10,num_pals_in_primari:10,num_pals_tot:10,num_primary_palett:[12,16],num_secondary_palett:[12,16],num_til:15,num_tiles_in_primari:10,num_tiles_tot:10,number:[1,2,4,5,7,10,12,13,16],object:[0,2,6,9,10,12,13,16],object_ev:10,object_event_graph:10,object_event_graphics_info:[10,16],object_event_graphics_info_point:10,object_event_pic_t:10,object_event_templates_count:10,occur:[12,16],odd:12,off:[2,6,12,16],offici:16,offset:[3,11,16],old:[14,16],oldheight:12,oldtab:12,oldwidth:12,onblockchang:[12,16],onblockhoverchang:12,onblockhoverclear:12,onbordermetatilechang:12,onborderres:12,onbordervisibilitytoggl:12,onc:[4,6,12,16],one:[2,3,4,6,7,9,11,12,13,16],ones:16,onli:[2,3,4,6,7,9,10,12,13,15,16],onmaintabchang:12,onmapopen:12,onmapres:[12,16],onmapshift:12,onmapviewtabchang:12,onprojectclos:12,onprojectopen:12,ontilesetupd:12,onto:[2,6,9,11,12],opac:[12,16],opaqu:12,open:[0,3,6,7,8,9,11,12,13,14,15,16],oper:[9,12,15,16],oppon:[],optim:6,option:[0,2,4,9,10,11,12,13,14,15,16],order:[1,4,7,12,16],organ:9,origin:[4,12,13,16],other:[4,6,9,11,12,13,16,17],otherwis:[7,10],our:[7,8,12],out:[0,2,4,6,7,9,11,14,16],outdoor:1,outlin:[6,12,14,16],output:[10,13,15],outsid:[12,15,16],over:[2,4,5,6,9,16],overal:16,overhaul:16,overlai:16,overlap:13,overload:12,overrid:[10,13,16],overridden:[10,13],overview:12,overworld:[4,16],overwrit:[12,13,14],overwritten:12,own:[12,13],pad:16,paint:[0,6,8,9,11,12,14,16],pair:[12,15],pal:[11,15,16],palett:[0,10,11,12,16],paletteid:12,paletteindex:12,pane:[6,9,11,15,16],panel:[2,8,13,15,16],pars:16,part:[9,16],partial:[6,16],particular:2,particularli:4,passabl:12,past:16,patch:12,path:[0,2,10,11,12,13,14,16],pathwai:6,patient:9,pattern:[6,12],pencil:[0,4,8,14,16],per:[13,14,16],percent:12,perform:[6,12,16],perman:12,persist:16,petalburg:[3,8],pick:[4,15],picker:[6,16],pictur:[7,15,16],pink:4,pixel:[12,15,16],place:[4,6,8,11,16],placehold:16,plai:5,plain:[11,16],plain_grass:[],platform:[8,13,16],player:[1,2,3,4,6,9,11,14,15,16],pleas:0,plu:[3,4],png:[10,15,16],pointer:[0,4,14,16],pokecryst:17,pokeemerald:[4,6,8,10,11,12,13,16],pokefir:[4,5,6,8,11,12,13,15,16],pokemon:[1,7,9,10,12,13,16],pokemon_gfx:10,pokemon_icon:10,pokemon_icon_t:10,poker:17,pokerubi:[4,6,8,10,12,13,16],polish:17,pond:6,poor:16,pop:8,popul:[7,11,12,13,15],popular:17,popup:[1,5,11],pori:[4,10,13,16],port:16,portion:6,porycript:4,porymap:[1,3,4,6,7,9,10,11,12,14,15,16],porymap_config:10,poryscript:[13,16,17],posit:[0,6,11,12,13,16],possibl:[7,12,16],power:[6,12],pre:[6,16],predict:16,prefab:[0,12,13,16],prefabr:6,prefabs_filepath:6,prefabs_import_prompt:[],prefer:[4,13,14,16],prefix:[5,10,12,16],present:12,preserv:16,press:[3,4,6,8,9,16],pret:[8,13,14,16],pretti:7,pretty_cursor:[],prevblock:12,prevent:16,preview:[6,12],previou:[2,16],previous:[12,16],prevmetatileid:12,primari:[1,6,8,10,12,13,15,16],pro:15,probabl:[10,12],procedur:12,process:[2,4],program:17,project:[0,1,2,4,5,6,8,9,11,12,14,15,16],project_root:6,projectpath:12,prompt:[6,12,13,14,16],proper:16,properli:16,properti:[0,2,4,5,8,9,10,11,12,13,16],provid:[4,6,7,8,12,13,15,16],pull:16,purpos:[2,9],qt6:16,quantiti:[4,13],question:12,quick:6,quickli:9,radiu:[4,6],rais:16,randint:12,random:12,rang:[4,12,13],rate:[7,16],rather:[6,12,16],ratio:7,raw:12,rawvalu:12,reach:0,reactiv:16,read:[4,8,10,11,12,13,16],realist:15,reason:[7,13,15],receiv:4,recent:16,recent_map:[],recent_project:[],recommend:8,rectangl:[6,12,16],rectangular:12,red:[2,7,16],redo:[0,2,4,8,11,14,16],redraw:12,reduc:16,refer:[0,14],referenc:15,reflect:[12,16],refresh:12,regex:[10,13],regex_battle_scen:10,regex_behavior:10,regex_coord_event_weath:10,regex_flag:10,regex_item:10,regex_map_typ:10,regex_movement_typ:10,regex_mus:10,regex_obj_event_gfx:10,regex_secret_bas:10,regex_sign_facing_direct:10,regex_speci:10,regex_trainer_typ:10,regex_var:10,regex_weath:10,region:[0,1,5,6,8,10,12,13,16],region_map:[10,11],region_map_sect:[10,11],regist:0,registeract:[12,16],registertoggleact:[12,16],registri:16,regress:16,regular:[6,10,12,13],rejoic:16,rel:[10,11,12,13,16],relat:[0,10,12],releas:[6,8,16],reli:10,reload:[12,13,16],reloc:16,remain:[12,16],rememb:[2,16],remov:[12,13,15,16],renam:16,render:[12,16],reopen:16,reopen_on_launch:[],reorder:16,reorgan:16,replac:[2,11,12,13,16],repo:16,report:16,repositori:13,repres:[2,7,12,13],repsawn:13,requir:[4,5,10,12,13,16],reselect:16,reset:[11,14,16],resili:16,resiz:[2,6,16],resolut:16,resolv:16,resourc:[],respawn:[4,10,13],respect:[8,13,16],respond:16,rest:[12,13],restor:[13,14,16],restrict:11,result:8,retain:16,retriev:12,rgb:[12,16],right:[1,2,3,4,6,7,9,11,12,13,14,15,16],rival:4,rme:11,rom:8,rooftop:5,root:[10,11,13],rope:[1,5,12,13],rotat:[12,16],round:[12,16],rout:[2,3],row:[2,13,16],rrggbb:12,rubi:5,rule:[12,15],ruler:[0,16],run:[1,5,12,13,16],same:[2,4,6,8,12,13,14,15,16],save:[3,6,7,8,12,13,14,15,16],scale:[12,14,16],scenario:[15,16],scene:[5,10,12],scratch:[11,15],screen:[7,8,15,16],script:[0,9,10,13,16,17],scroll:[6,16],seamlessli:3,search:[10,13,16],second:[2,8,9,13],secondari:[1,6,10,12,13,15,16],secret:[0,10,13,16],secret_bas:[4,10],secretbas:15,section:[1,4,5,6,9,10,11],see:[1,4,6,7,8,9,12,13,16],seem:9,seen:16,segment:13,select:[0,3,4,7,8,9,11,12,13,14,15,16],selector:[2,6,11,16],self:5,semant:[13,16],sensibl:16,separ:[12,13],sequenti:13,session:16,set:[0,2,4,6,7,9,10,11,14,15,16],setallowbik:12,setallowescap:12,setallowrun:12,setbattlescen:12,setblock:12,setblocksfromselect:12,setborderdimens:12,setborderheight:12,setbordermetatileid:12,setbordervis:12,setborderwidth:12,setclippingrect:12,setcollis:12,setdimens:12,setelev:12,setfloornumb:12,setgridvis:12,setheight:12,sethorizontalscal:12,seti:12,setloc:12,setmaintab:12,setmapviewtab:12,setmetatileattribut:12,setmetatilebehavior:12,setmetatilebehaviornam:[12,16],setmetatileencountertyp:12,setmetatileid:12,setmetatilelabel:12,setmetatilelayeropac:12,setmetatilelayerord:12,setmetatilelayertyp:12,setmetatileterraintyp:12,setmetatiletil:[12,16],setopac:12,setposit:12,setprimarytileset:12,setprimarytilesetpalett:12,setprimarytilesetpalettepreview:12,setprimarytilesetpalettespreview:12,setrequiresflash:12,setrot:12,setscal:[12,16],setsecondarytileset:12,setsecondarytilesetpalett:12,setsecondarytilesetpalettepreview:12,setsecondarytilesetpalettespreview:12,setshowlocationnam:12,setsmartpathsen:12,setsong:12,settimeout:12,settranspar:12,settyp:12,setup:8,setverticalscal:12,setvis:12,setweath:12,setwhiteoutrespawnwarpandhealernpc:4,setwidth:12,setx:12,sever:[7,12,15],shape:12,share:16,shealloc:10,shift:[0,3,4,12,14,16],shoe:5,shortcut:[0,2,6,8,11,12,16],should:[2,4,6,7,8,11,12,13,16],shouldn:8,show:[1,5,6,8,9,12,13,14,15,16],show_cursor_til:[],show_player_view:[],showerror:12,showmessag:12,shown:12,showquest:12,showwarn:12,shrink:16,side:[2,3,6,8,9,15],sight:4,sign:[0,10,16],signific:16,signpost:[2,4],silenc:[13,16],similar:[2,3,7],simpl:[4,7],simpli:[3,4,6,9,11,15],simplifi:6,simultan:11,sinc:[3,8,12,15,16],singl:[7,9,11,12,16],situat:[9,16],size:[6,11,12,13,16],slider:[2,6,11,15,16],slightli:16,slot:[7,16],slow:[12,16],small:4,smaller:12,smart:[0,2,12,14,16],smetatileattrmask:[10,13],smooth:16,snap:6,some:[1,2,4,6,8,9,10,12,16],someth:[0,2,4,7,11],sometim:[15,16],somewhat:16,song:[5,10,12],sort:[1,9,16],sourc:[8,15],south:2,space:[13,16],span:11,spawn_:[10,16],speci:[7,10,13],special:[2,4,12,13],specif:[4,10,13,16],specifi:[4,10,12,13,16],specifieid:12,specifii:12,speed:16,spin:13,spinbox:11,spinner:[2,4,12,15,16],split:15,spot:4,sprint:1,sprite:[4,10,13,16],spritesheet:16,squar:[4,11,16],src:[4,10,11],ssecretbaseentrancemetatil:4,sspawnpoint:10,stai:16,stair:2,stand:[4,15],standard:4,start:[0,2,6,12,13],startup:16,state:12,statu:16,steal:16,step:12,stick:16,still:[13,16],stitch:16,stop:[12,16],store:[11,13,14,16],straight:[0,12,14,16],straightforward:7,string:[11,12,16],struct:[10,16],studio:17,stuff:[],successfulli:[8,12],suffici:[11,12],summar:9,support:[5,6,8,10,11,12,13,14,16],sure:[2,3,8],surf:2,surround:[6,9],swap:11,swhiteoutrespawnhealcentermapidx:10,swhiteoutrespawnhealernpcid:10,symbol:[10,13,16],symbol_attribute_t:10,symbol_facing_direct:10,symbol_heal_loc:10,symbol_heal_locations_typ:10,symbol_obj_event_gfx_point:10,symbol_pokemon_icon_t:10,symbol_spawn_map:10,symbol_spawn_npc:10,symbol_spawn_point:10,symbol_tilesets_prefix:10,symbol_wild_encount:10,sync:[3,16],syntax:[10,13],system:16,tab:[0,2,3,4,6,7,9,10,12,13,16],tabl:[10,12,13,15,16],tag:12,take:[6,7,8,9,11,12,13,16],taken:16,tall:[12,15],target:[4,12],technic:[4,12],templat:[12,16],temporarili:[6,12,16],terrain:[12,13],terraintyp:12,test:12,text:[2,4,9,10,12,13,15,16],text_editor_goto_lin:[],text_editor_open_directori:[],textbox:[],than:[6,12,16],thei:[1,3,4,5,6,9,10,12,13,14,15,16],them:[2,3,4,5,6,7,12,13,16],theme:16,therefor:[7,8],thi:[1,2,3,4,5,6,7,9,10,11,12,13,15,16],thing:[4,5,6,7,8,9],think:[6,8],those:[6,8,12],though:[6,16],three:[4,11,12,13],through:[2,3,16],tile:[0,2,4,8,9,10,11,12,13,16],tileend:12,tileid:12,tileindex:12,tilemap:[11,16,17],tiles_per_metatil:12,tilesest:13,tileset:[0,1,8,10,11,16],tileset_checkerboard_fil:[],tilesetnam:12,tilesets_graph:10,tilesets_graphics_asm:10,tilesets_have_callback:[],tilesets_have_is_compress:[],tilesets_head:10,tilesets_headers_asm:10,tilesets_metatil:10,tilesets_metatiles_asm:10,tilestart:12,time:[2,4,6,7,8,9,12,13,15,16],timelaps:16,tint:12,titl:12,todo:[],togeth:[3,4,6,12,14],toggl:[6,12,14,16],toggld:16,toggleabl:16,too:[2,16],tool:[0,1,2,8,11,12,16],toolbar:[6,8],toolbutton:[14,15],top:[2,3,4,10,11,12,13,15,16],total:[2,7,10],tpl:16,track:[],tradit:8,trainer:[4,10,16],trainer_sight_or_berry_tree_id:16,trainer_typ:[10,16],trainer_type_norm:4,transform:12,transit:[2,4],transpar:[2,12,13,16],treat:[13,16],tree:[4,6,16],trigger:[0,9,10,12,13,16],tripl:[13,16],turn:16,two:[3,6,9,11,13,15],type:[0,1,4,5,9,10,11,12,13,16],typic:[2,4],u16:10,ubuntu:16,unabl:2,unavail:4,unchang:16,uncheck:[11,12,13],uncommit:12,undefin:10,under:[2,10,11,12,13,16],underli:[12,16],underlin:12,underscor:[12,16],undertand:2,underw:16,undo:[0,2,4,8,11,12,14,16],undoabl:16,unexpect:16,unfortun:4,unhappi:11,uniq:7,uniqu:[4,11,13],unknown:16,unless:[10,12,13],unlik:2,unlock:4,unnecessari:16,unpredict:16,unreleas:0,unsav:16,until:[7,12],unus:[15,16],updat:[2,3,6,12,13,16],upon:[],upstream:16,url:16,usabl:8,usag:[2,15],use:[1,2,4,6,7,8,9,10,11,12,13,14,15,16],use_:10,use_custom_border_s:[6,12,16],use_encounter_json:[],use_poryscript:16,usecach:12,used:[2,3,4,5,6,9,10,12,13,14,15,16,17],useful:[3,4,5,6,12,15,16],user:[0,1,2,6,8,10,11,12,13,15,16],uses:[2,4,6,7,12,13,15,16],using:[2,4,6,8,10,12,13,14,15,16],usual:12,util:16,valid:[2,11,13,16],valu:[2,3,4,5,6,10,11,12,13,15,16],vanilla:[7,13],var_valu:16,vari:[],variabl:4,varieti:15,variou:[5,6,8,9,16],veri:[2,3,4,6,12],version:[2,4,5,6,8,12,13,16],vertic:[3,12,16],via:[6,12,16],video:17,view:[2,3,4,5,6,9,11,12,14,16],visibl:[4,6,12,16],vision:5,visual:[0,2,16],vscale:[12,16],wai:[3,4,6,12,13],wait:12,walk:[2,3,4,9],want:[7,11,12,13],warn:[4,12,13,16],warp:[0,9,13,15,16],wasn:16,watch:16,water:[12,15],waterfal:12,weather:[0,5,9,10,12,13,16],web:12,websit:16,were:[4,6,16],weren:16,west:[2,3],what:[0,2,4,5,6,9,11,13],wheel:6,when:[1,2,3,4,5,6,8,9,10,11,12,13,15,16],whenev:[2,6,12,15],where:[4,6,11,12,13,15,16],whether:[1,2,5,12,15,16],which:[1,2,3,5,6,7,9,11,12,13,15,16],whichev:6,white:[2,4,6,16],whose:[13,16],why:2,widget:16,width:[1,11,12,13,16],wiki:13,wild:[0,9,10,12,13,15,16],wild_encount:10,window:[0,1,4,5,6,7,8,11,12,13,15,16],window_geometri:[],window_st:[],within:[4,9,14,15],without:[6,11,12,16],woman:4,won:[2,12,16],word:12,work:[6,8,9,15,16],workflow:[6,8,12],would:[2,12,16],wouldn:16,wrap:6,write:[0,8,10,13,16],written:[13,16],wrong:16,wsl:16,xcoord:12,xdelta:12,xflip:[12,16],xoffset:[12,16],ycoord:12,ydelta:12,yes:10,yet:[12,16],yflip:[12,16],yoffset:[12,16],you:[0,1,2,3,4,5,6,7,8,9,11,12,13,14,15,16,17],your:[1,3,4,5,6,7,8,9,10,11,12,13,14],yourself:[10,14],zoom:[2,6,11,14,16]},titles:["Porymap Documentation","Creating New Maps","Editing Map Collisions","Editing Map Connections","Editing Map Events","Editing Map Headers","Editing Map Tiles","Editing Wild Encounters","Introduction","Navigation","Project Files","The Region Map Editor","Scripting Capabilities","Porymap Settings","Shortcuts","The Tileset Editor","Changelog","Related Projects"],titleterms:{"break":16,"default":[],"function":12,"import":15,"new":[1,7],Added:16,Adding:[4,7],The:[11,15],Use:[],about:8,action:12,addit:[],advanc:15,allow:[],api:12,attribut:[],background:11,base:4,behavior:15,bike:[],border:6,bucket:6,button:4,callback:12,capabl:12,chang:[6,15,16],changelog:16,clone:4,collis:2,configur:7,connect:3,constant:12,creat:1,custom:12,delet:4,dive:3,document:0,edit:[2,3,4,5,6,7,12],editor:[9,11,12,14,15],elev:[],emerg:3,enabl:[],encount:[7,15],entri:11,escap:[],event:[4,13],field:7,file:[10,13],fill:6,fix:16,floor:[],follow:3,from:15,game:[],gener:13,get:8,global:13,group:7,header:[5,12],heal:4,healspot:4,hidden:4,identifi:13,imag:[11,15],introduct:8,iscompress:[],item:4,itemfind:[],label:15,layer:15,layout:11,list:9,locat:4,main:[9,14],map:[1,2,3,4,5,6,9,11,12,13,14,15],mask:[],menu:15,metatil:[6,15],mirror:3,navig:9,npc:[],number:15,object:4,open:4,option:[1,6],other:15,output:[],overlai:12,paint:2,palett:15,path:6,pencil:6,pointer:6,porymap:[0,8,13],poryscript:[],posit:4,prefab:6,prefer:[],project:[10,13,17],properti:15,quantiti:[],redo:6,region:[9,11,14],regist:12,relat:17,repsawn:[],requir:[],ruler:4,run:[],script:[4,12],secret:4,select:[2,6],separ:[],set:[12,13],shift:6,shortcut:14,show:[],sign:4,size:[],smart:6,start:8,straight:6,tab:11,terrain:15,text:[],tile:[6,15],tileset:[6,9,12,13,14,15],tool:[4,6,15],trigger:4,tripl:[],type:[2,15],undo:6,unreleas:16,util:12,version:[],visual:6,warp:[3,4],weather:4,wild:7,window:[9,14],write:12}}) \ No newline at end of file From 236ad9b73c220008623089df506c2c51b962e568 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Tue, 11 Jun 2024 12:26:34 -0400 Subject: [PATCH 19/26] Fix Add Region Map button --- src/ui/regionmapeditor.cpp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/ui/regionmapeditor.cpp b/src/ui/regionmapeditor.cpp index 220f9cca..92da19c2 100644 --- a/src/ui/regionmapeditor.cpp +++ b/src/ui/regionmapeditor.cpp @@ -298,7 +298,7 @@ bool RegionMapEditor::buildConfigDialog() { form.addRow(addMapButton); // allow user to add region maps - connect(addMapButton, &QPushButton::clicked, [this, regionMapList] { + connect(addMapButton, &QPushButton::clicked, [this, regionMapList, &updateJsonFromList] { poryjson::Json resultJson = configRegionMapDialog(); poryjson::Json::object resultObj = resultJson.object_items(); @@ -310,6 +310,7 @@ bool RegionMapEditor::buildConfigDialog() { newItem->setText(resultObj["alias"].string_value()); newItem->setData(Qt::UserRole, resultStr); regionMapList->addItem(newItem); + updateJsonFromList(); }); QPushButton *delMapButton = new QPushButton("Delete Selected Region Map"); From 0954fe26ff603fbf26a0c01526bcf03343353a14 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Mon, 17 Jun 2024 11:26:45 -0400 Subject: [PATCH 20/26] Fix confusing error logging during region map setup --- include/ui/regionmapeditor.h | 5 +++++ src/mainwindow.cpp | 7 +++---- src/ui/regionmapeditor.cpp | 38 +++++++++++++++--------------------- 3 files changed, 24 insertions(+), 26 deletions(-) diff --git a/include/ui/regionmapeditor.h b/include/ui/regionmapeditor.h index 3cbc2515..ef72b5ee 100644 --- a/include/ui/regionmapeditor.h +++ b/include/ui/regionmapeditor.h @@ -27,6 +27,7 @@ public: ~RegionMapEditor(); bool load(bool silent = false); + bool setupErrored() const { return setupError; } void onRegionMapTileSelectorSelectedTileChanged(unsigned id); void onRegionMapTileSelectorHoveredTileChanged(unsigned id); @@ -53,9 +54,13 @@ private: RegionMap *region_map = nullptr; tsl::ordered_map region_maps; + QString configFilepath; + QString mapSectionFilepath; + poryjson::Json rmConfigJson; bool configSaved = false; + bool setupError = false; QUndoGroup history; diff --git a/src/mainwindow.cpp b/src/mainwindow.cpp index 6f3b87d7..ae498fb4 100644 --- a/src/mainwindow.cpp +++ b/src/mainwindow.cpp @@ -2960,15 +2960,14 @@ bool MainWindow::initRegionMapEditor(bool silent) { this->regionMapEditor = new RegionMapEditor(this, this->editor->project); bool success = this->regionMapEditor->load(silent); if (!success) { - delete this->regionMapEditor; - this->regionMapEditor = nullptr; - if (!silent) { + if (!silent && this->regionMapEditor->setupErrored()) { QMessageBox msgBox(this); - QString errorMsg = QString("There was an error opening the region map data. Please see %1 for full error details.\n\n%3") + QString errorMsg = QString("There was an error opening the region map data. Please see %1 for full error details.\n\n%2") .arg(getLogPath()) .arg(getMostRecentError()); msgBox.critical(nullptr, "Error Opening Region Map Editor", errorMsg); } + delete this->regionMapEditor; return false; } diff --git a/src/ui/regionmapeditor.cpp b/src/ui/regionmapeditor.cpp index 92da19c2..16ea4a5a 100644 --- a/src/ui/regionmapeditor.cpp +++ b/src/ui/regionmapeditor.cpp @@ -28,6 +28,8 @@ RegionMapEditor::RegionMapEditor(QWidget *parent, Project *project) : { this->ui->setupUi(this); this->project = project; + this->configFilepath = QString("%1/%2").arg(this->project->root).arg(projectConfig.getFilePath(ProjectFilePath::json_region_porymap_cfg)); + this->mapSectionFilepath = QString("%1/%2").arg(this->project->root).arg(projectConfig.getFilePath(ProjectFilePath::json_region_map_entries)); this->initShortcuts(); this->restoreWindowState(); } @@ -110,12 +112,10 @@ void RegionMapEditor::applyUserShortcuts() { bool RegionMapEditor::loadRegionMapEntries() { this->region_map_entries.clear(); - QString regionMapSectionFilepath = QString("%1/%2").arg(this->project->root).arg(projectConfig.getFilePath(ProjectFilePath::json_region_map_entries)); - ParseUtil parser; QJsonDocument sectionsDoc; - if (!parser.tryParseJsonFile(§ionsDoc, regionMapSectionFilepath)) { - logError(QString("Failed to read map data from %1").arg(regionMapSectionFilepath)); + if (!parser.tryParseJsonFile(§ionsDoc, this->mapSectionFilepath)) { + logError(QString("Failed to read map data from %1").arg(this->mapSectionFilepath)); return false; } @@ -140,11 +140,9 @@ bool RegionMapEditor::loadRegionMapEntries() { } bool RegionMapEditor::saveRegionMapEntries() { - QString regionMapSectionFilepath = QString("%1/%2").arg(this->project->root).arg(projectConfig.getFilePath(ProjectFilePath::json_region_map_entries)); - - QFile sectionsFile(regionMapSectionFilepath); + QFile sectionsFile(this->mapSectionFilepath); if (!sectionsFile.open(QIODevice::WriteOnly)) { - logError(QString("Error: Could not open %1 for writing").arg(regionMapSectionFilepath)); + logError(QString("Could not open %1 for writing").arg(this->mapSectionFilepath)); return false; } @@ -477,6 +475,7 @@ bool RegionMapEditor::setup() { if (!newMap->loadMapData(o)) { delete newMap; // TODO: consider continue, just reporting error loading single map? + this->setupError = true; return false; } @@ -499,26 +498,21 @@ bool RegionMapEditor::setup() { if (!region_maps.empty()) { setRegionMap(region_maps.begin()->second); } + this->setupError = false; return true; } bool RegionMapEditor::load(bool silent) { // check for config json file - QString jsonConfigFilepath = this->project->root + "/" + projectConfig.getFilePath(ProjectFilePath::json_region_porymap_cfg); - bool badConfig = true; - - if (QFile::exists(jsonConfigFilepath)) { - logInfo("Region map configuration file found."); + if (QFile::exists(this->configFilepath)) { ParseUtil parser; OrderedJson::object obj; - if (parser.tryParseOrderedJsonFile(&obj, jsonConfigFilepath)) { + if (parser.tryParseOrderedJsonFile(&obj, this->configFilepath)) { this->rmConfigJson = OrderedJson(obj); this->configSaved = true; } badConfig = !verifyConfig(this->rmConfigJson); - } else { - logWarn("Region Map config file not found."); } if (badConfig) { @@ -534,14 +528,15 @@ bool RegionMapEditor::load(bool silent) { if (warning.exec() == QMessageBox::Ok) { // there is a separate window that allows to load multiple region maps, if (!buildConfigDialog()) { - logError("Region map loading interrupted [user]"); + // User canceled config set up return false; } } else { - // do not open editor - logError("Region map loading interrupted [user]"); + // User declined config set up return false; } + } else { + logInfo("Successfully loaded region map configuration file."); } return setup(); @@ -583,10 +578,9 @@ void RegionMapEditor::saveConfig() { mapsObject["region_maps"] = mapArray; OrderedJson newConfigJson(mapsObject); - QString filepath = QString("%1/%2").arg(this->project->root).arg(projectConfig.getFilePath(ProjectFilePath::json_region_porymap_cfg)); - QFile file(filepath); + QFile file(this->configFilepath); if (!file.open(QIODevice::WriteOnly)) { - logError(QString("Error: Could not open %1 for writing").arg(filepath)); + logError(QString("Could not open %1 for writing").arg(this->configFilepath)); return; } OrderedJsonDoc jsonDoc(&newConfigJson); From 4a79114b98ec7d07c1a4f286f48baec73581afc7 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Mon, 17 Jun 2024 11:38:01 -0400 Subject: [PATCH 21/26] Fix crash if region map tileset is missing --- src/core/regionmap.cpp | 10 ++++++++-- src/ui/regionmapeditor.cpp | 10 ---------- 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/src/core/regionmap.cpp b/src/core/regionmap.cpp index 68da1fa7..9c66860b 100644 --- a/src/core/regionmap.cpp +++ b/src/core/regionmap.cpp @@ -79,14 +79,20 @@ bool RegionMap::loadTilemap(poryjson::Json tilemapJson) { this->palette_path = tilemapObject["palette"].string_value(); } + QFileInfo tilesetFileInfo(fullPath(this->tileset_path)); + if (!tilesetFileInfo.exists() || !tilesetFileInfo.isFile()) { + logError(QString("Failed to open region map tileset file '%1'.").arg(tileset_path)); + return false; + } + QFile tilemapFile(fullPath(this->tilemap_path)); if (!tilemapFile.open(QIODevice::ReadOnly)) { - logError(QString("Failed to open region map tilemap file %1.").arg(tilemap_path)); + logError(QString("Failed to open region map tilemap file '%1'.").arg(tilemap_path)); return false; } if (tilemapFile.size() < tilemapBytes()) { - logError(QString("The region map tilemap at %1 is too small.").arg(tilemap_path)); + logError(QString("The region map tilemap at '%1' is too small.").arg(tilemap_path)); return false; } diff --git a/src/ui/regionmapeditor.cpp b/src/ui/regionmapeditor.cpp index 16ea4a5a..ee491a3e 100644 --- a/src/ui/regionmapeditor.cpp +++ b/src/ui/regionmapeditor.cpp @@ -402,16 +402,6 @@ bool RegionMapEditor::verifyConfig(poryjson::Json cfg) { logError("Region map config json has no map list."); return false; } - - OrderedJson::array arr = obj["region_maps"].array_items(); - - for (auto ref : arr) { - RegionMap tempMap(this->project); - if (!tempMap.loadMapData(ref)) { - return false; - } - } - return true; } From 1c2be70ff0215112718196031ba70787a0831302 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Mon, 17 Jun 2024 12:11:55 -0400 Subject: [PATCH 22/26] Allow users to fix faulty region map settings --- include/mainwindow.h | 1 + include/ui/regionmapeditor.h | 2 ++ src/core/regionmap.cpp | 2 +- src/mainwindow.cpp | 35 ++++++++++++++++++++++++++++------- src/ui/regionmapeditor.cpp | 10 ++++++++-- 5 files changed, 40 insertions(+), 10 deletions(-) diff --git a/include/mainwindow.h b/include/mainwindow.h index f3aa9375..7fda1b09 100644 --- a/include/mainwindow.h +++ b/include/mainwindow.h @@ -388,6 +388,7 @@ private: void initTilesetEditor(); bool initRegionMapEditor(bool silent = false); + bool askToFixRegionMapEditor(); void initShortcutsEditor(); void initCustomScriptsEditor(); void connectSubEditorsToShortcutsEditor(); diff --git a/include/ui/regionmapeditor.h b/include/ui/regionmapeditor.h index ef72b5ee..3d889f88 100644 --- a/include/ui/regionmapeditor.h +++ b/include/ui/regionmapeditor.h @@ -42,6 +42,8 @@ public: void resizeTilemap(int width, int height); + bool reconfigure(); + QObjectList shortcutableObjects() const; public slots: diff --git a/src/core/regionmap.cpp b/src/core/regionmap.cpp index 9c66860b..45fc1141 100644 --- a/src/core/regionmap.cpp +++ b/src/core/regionmap.cpp @@ -303,7 +303,7 @@ bool RegionMap::loadLayout(poryjson::Json layoutJson) { } setLayout("main", layout); } else { - logError("Region map layout is not readable."); + logError(QString("Failed to read region map layout from '%1'.").arg(this->layout_path)); return false; } } diff --git a/src/mainwindow.cpp b/src/mainwindow.cpp index ae498fb4..0b92c1c9 100644 --- a/src/mainwindow.cpp +++ b/src/mainwindow.cpp @@ -2958,14 +2958,12 @@ void MainWindow::on_pushButton_CreatePrefab_clicked() { bool MainWindow::initRegionMapEditor(bool silent) { this->regionMapEditor = new RegionMapEditor(this, this->editor->project); - bool success = this->regionMapEditor->load(silent); - if (!success) { + if (!this->regionMapEditor->load(silent)) { + // The region map editor either failed to load, + // or the user declined configuring their settings. if (!silent && this->regionMapEditor->setupErrored()) { - QMessageBox msgBox(this); - QString errorMsg = QString("There was an error opening the region map data. Please see %1 for full error details.\n\n%2") - .arg(getLogPath()) - .arg(getMostRecentError()); - msgBox.critical(nullptr, "Error Opening Region Map Editor", errorMsg); + if (this->askToFixRegionMapEditor()) + return true; } delete this->regionMapEditor; return false; @@ -2974,6 +2972,29 @@ bool MainWindow::initRegionMapEditor(bool silent) { return true; } +bool MainWindow::askToFixRegionMapEditor() { + QMessageBox msgBox; + msgBox.setIcon(QMessageBox::Critical); + msgBox.setText(QString("There was an error opening the region map data. Please see %1 for full error details.").arg(getLogPath())); + msgBox.setDetailedText(getMostRecentError()); + msgBox.setStandardButtons(QMessageBox::Ok); + msgBox.setDefaultButton(QMessageBox::Ok); + auto reconfigButton = msgBox.addButton("Reconfigure", QMessageBox::ActionRole); + msgBox.exec(); + if (msgBox.clickedButton() == reconfigButton) { + if (this->regionMapEditor->reconfigure()) { + // User fixed error + return true; + } + if (this->regionMapEditor->setupErrored()) { + // User's new settings still fail, show error and ask again + return this->askToFixRegionMapEditor(); + } + } + // User accepted error + return false; +} + void MainWindow::closeSupplementaryWindows() { delete this->tilesetEditor; delete this->regionMapEditor; diff --git a/src/ui/regionmapeditor.cpp b/src/ui/regionmapeditor.cpp index ee491a3e..0f75a730 100644 --- a/src/ui/regionmapeditor.cpp +++ b/src/ui/regionmapeditor.cpp @@ -599,6 +599,11 @@ void RegionMapEditor::on_actionSave_All_triggered() { } void RegionMapEditor::on_action_Configure_triggered() { + reconfigure(); +} + +bool RegionMapEditor::reconfigure() { + this->setupError = false; if (this->modified()) { QMessageBox warning; warning.setIcon(QMessageBox::Warning); @@ -609,15 +614,16 @@ void RegionMapEditor::on_action_Configure_triggered() { if (warning.exec() == QMessageBox::Ok) { if (buildConfigDialog()) { - reload(); + return reload(); } } } else { if (buildConfigDialog()) { - reload(); + return reload(); } } + return false; } void RegionMapEditor::displayRegionMap() { From 79955715dd36051a31cdaf414465cc516b2ef446 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Mon, 17 Jun 2024 14:32:02 -0400 Subject: [PATCH 23/26] Fix crash if region map tileset file is too small --- src/core/regionmap.cpp | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/core/regionmap.cpp b/src/core/regionmap.cpp index 45fc1141..7dbd4c5f 100644 --- a/src/core/regionmap.cpp +++ b/src/core/regionmap.cpp @@ -79,12 +79,17 @@ bool RegionMap::loadTilemap(poryjson::Json tilemapJson) { this->palette_path = tilemapObject["palette"].string_value(); } - QFileInfo tilesetFileInfo(fullPath(this->tileset_path)); - if (!tilesetFileInfo.exists() || !tilesetFileInfo.isFile()) { + QImage tilesetFile(fullPath(this->tileset_path)); + if (tilesetFile.isNull()) { logError(QString("Failed to open region map tileset file '%1'.").arg(tileset_path)); return false; } + if (tilesetFile.width() < 8 || tilesetFile.height() < 8) { + logError(QString("Region map tileset file '%1' must be at least 8x8.").arg(tileset_path)); + return false; + } + QFile tilemapFile(fullPath(this->tilemap_path)); if (!tilemapFile.open(QIODevice::ReadOnly)) { logError(QString("Failed to open region map tilemap file '%1'.").arg(tilemap_path)); From 06b6651e46cd5e52cd327d7b1e1bb8cf910d5edf Mon Sep 17 00:00:00 2001 From: GriffinR Date: Mon, 17 Jun 2024 14:32:19 -0400 Subject: [PATCH 24/26] Update changelog --- CHANGELOG.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a6d13ce3..9c9977a1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,10 @@ 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. It also includes changes to the scripting API that may change the behavior of existing porymap scripts. If porymap is used with a project or API script that is not up-to-date with the breaking changes, then porymap will likely break or behave improperly. ## [Unreleased] -Nothing, yet. +### Fixed +- Fix `Add Region Map...` not updating the region map settings file. +- Fix some crashes on invalid region map tilesets. +- Improve error reporting for invalid region map editor settings. ## [5.4.1] - 2024-03-21 ### Fixed From 3af14307d3fc785e8e27bf2a1632d2cdc7d2cbab Mon Sep 17 00:00:00 2001 From: GriffinR Date: Mon, 17 Jun 2024 14:47:19 -0400 Subject: [PATCH 25/26] Bump macOS Qt version --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 55edb7b6..9c997ad1 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -58,7 +58,7 @@ jobs: - name: Install Qt uses: jurplel/install-qt-action@v3 with: - version: '6.2.*' + version: '6.5.*' cached: ${{ steps.cache-qt.outputs.cache-hit }} - name: Configure From b28d4085eca017ee22afb4fa8b720de6c7d8d8c4 Mon Sep 17 00:00:00 2001 From: GriffinR Date: Wed, 26 Jun 2024 14:51:41 -0400 Subject: [PATCH 26/26] Disable update promoter on Windows --- src/mainwindow.cpp | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/mainwindow.cpp b/src/mainwindow.cpp index 6f3b87d7..487c3e5c 100644 --- a/src/mainwindow.cpp +++ b/src/mainwindow.cpp @@ -43,7 +43,9 @@ // We only publish release binaries for Windows and macOS. // This is relevant for the update promoter, which alerts users of a new release. -#if defined(Q_OS_WIN) || defined(Q_OS_MACOS) +// TODO: Currently the update promoter is disabled on our Windows releases because +// the pre-compiled Qt build doesn't link OpenSSL. Re-enable below once this is fixed. +#if /*defined(Q_OS_WIN) || */defined(Q_OS_MACOS) #define RELEASE_PLATFORM #endif