v21.1 [v20.1\v21.1] Arcky's Region Map v3.0.0

Update 8/10/2024: The Arcky's Utilities plugin has been updated to v1.0.6 as it fixed a few things that were changed in the Region Map plugin.

Attention: This plugin (update) no longer supports v20.1 of essentials, you'll run into crashes if you try to install it (just stick with v2.7.0)!

Attention: This plugin (update) requires Arcky's Utilities v1.0.6 or higher to function correctly. Once you've installed this, start a new save to avoid malfunction.
This plugin (update) also requires a complete fresh install of the Plugin folder. Please follow the instructions on the guide on how to update correctly and prevent any issues. This update does not come with any new Graphics or hasn't change anything on that part.

Prepare for the biggest update log that you have ever seen:

Bug Fixes:

• Fixed a bug with the zoom feature that when you spam the zoom trigger, the map moves slightly.
• Fixed location searching is still possible and malfunctioning while zooming is active.
• Fixed extended preview showing 1/0 pages when ExcludeMapWithNoData setting is set to true.
• Fixed a crash that happened when you don't have Lin's Weather System Plugin installed (patched 8/10/24)

Improvements:

• The Region Map Extras are now used from the plugin settings instead of the essentials settings in the pokedex (for some reason this was never set that way while the regular region map was using the setting for the plugin itself already).

Well don't worry I'm not going to list it here, you can check all changes on the gitbook guide.

If you encounter any issues, you know where to find me :P

That's all, enjoy the new update :)

Attention: This plugin (update) requires Arcky's Utilities v1.0.4 or higher to function correctly. Once you've installed this, start a new save to avoid malfunction.

Bug Fixes:

• Fixed missing Graphic issue when the CHANGE_ENC_BOX_ON_ENCOUNTER_TYPE Setting is set to false.
• Fixed the Cursor when the CURSOR_MAP_OFFSET Setting is set to false.
• Fixed the Cursor when the REGION_MAP_BEHIND_UI Setting is set to true.
• Fixed the Cursor when combining the CURSOR_MAP_OFFSET and REGION_MAP_BEHIND_UI Settings in all possible ways (4 possibilities).
• Fixed a crash on the Extended Location Preview when there's no Data for a Location.
• Fixed a crash on the Extended Location Preview when the PROGRESS_COUNTER Setting is set to false. (This now disables the Extended Location Preview.)

Improvements:

• Added a flag "EnExtPrev" which allows this map to be an Exception on the new Setting below (EXCLUDE_MAPS_WITH_NO_DATA) when it's set to true. Otherwise this flag has no effect. (This flag is set for a Game Map in the map_metadata.txt PBS file.)
• Added a flag "DisExtPrev" which allows you to disable the Extended Location Preview for a specific Game Map. (This is basically the manual way of what the EXCLUDE_MAPS_WITH_NO_DATA does.) (And just like with the "EnExtPrev" flag, you set this flag for a Game Map in the map_metadata.txt PBS file.)
• Renamed the PROGRESS_COUNT_VISITEDLOCATIONS Setting to PROGRESS_COUNT_VISITED_LOCATIONS.
• Changed the position of the Arrow Graphics on the Area Page in the Pokédex. Yes, something may improve here too. :)
• Change the SE (Sound Effect) that plays when Activation the Scrolling on the Area Page in the Pokédex. It now won't play when you can't Activate the Scrolling for the Region Map.

New Feature:

• Region Map Zooming: This is enabled by default and the Script will detect if you can Zoom out or not. See the new Settings below for those I've added.

New Settings:

• Added a new Setting (EXCLUDE_MAPS_WITH_NO_DATA) which allows you to filter out the Game Maps that would show "No Data for this Location" on the Extended Location Preview.
• Added a new Setting (DISABLE_PROGRESS_COUNTER_PERCENTAGE) which allows you to disable the Percentage shown on the Region Map (next to the Region/District Name).
• Added a new Setting (DISABLE_EXTENDED_PREVIEW_PERCENTAGE) which allows you to disable the Percentage shown on the Extended Location Preview (next to the Location's Name).
• Added a new Setting (USE_REGION_MAP_ZOOM) w hich allows you to enable or disable the Region Map Zoom feature.
• Added a new Setting (ZOOM_SPEED) which allows you to change the Speed of the Zoom in/out animation.
• Added a new Setting (TOGGLE_ZOOM_BUTTON) which allows you to set which button needs to be pressed to go in "Zoom Mode" which then enables Zooming.
• Added a new Setting (ZOOM_IN_BUTTON) which allows you to set which button needs to be pressed to Zoom in.
• Added a new Setting (ZOOM_OUT_BUTTON) which allows you to set which button needs to be pressed to Zoom out.

I hope you'll enjoy the new Region Map Zoom feature and are looking forward to the future Features this plugin is yet to bring.

For the next update of this Plugin, it could be that it's going to be v3.0.0 because I really need to reorginize the script files in the plugin. But don't worry about this now as I'll provide clear instructions on how to update it properly and avoid issues.

Attention: This plugin (update) requires Arcky's Utilities v1.0.3 or higher to function correctly. Once you've installed this, start a new save to avoid malfunction.

Bug Fixes:

• Fixed a crash when disabling the Roaming Icons (Roaming Mode) Setting on the Region Map.
• Fixed a bug when the REGION_MAP_BEHIND_UI Setting is turned on and you use the Mouse to choose a Location (to change the Cursor's postion), it would give you the wrong Location Info.
• Fixed an issue with the Arrow Graphics not updating properly when moving the Region Map using the Mouse.

Improvements:

• You can now have ' in your Location Names. It'll be ignored by the Script so the Location Preview still works as it should for that point. (You can't include ' in constant names anyway in the 000_RegionMap_LocationInfo Setup but you can for the Location Names in townmap.txt PBS file.)
• For the BUTTON_BOX_POSITION Setting, it is now possible to give it a value of nil which will disable the Button Preview completely.

New Settings:

• Added a new Setting (COUNT_ITEMS_TO_MAIN_MAP) which allow you to link multiple maps together to the "main map" so the total amount of items shown on the main map includes those of the linked maps as well.
• Added a new Setting (USE_SPRITES_FOR_UNSEEN_SPECIES) which allows you to have the Unseen Species Icons be shown with a black overlay instead of the ? icon in the Extended Preview.
• Added a new Setting (UNSEEN_SPECIES_COLOR) which allows you to change the overlay color (related to the setting above) of Unseen Species Icons in the Extended Preview.
• Added a new Setting (UNCAUGHT_SPECIES_TONE) which allows you to change the tone of Uncaught Species Icons in the Extended Preview.

The next update should be v2.7.0 including a new feature unless more hidden bugs and small improvements pop up in the meantime. Thank you all for reporting these bugs and suggesting these improvements as well.

Attention: This plugin (update) now requires Arcky's Utilities v1.0.3 or higher to function correctly from now on. Once you've installed this, start a new save to avoid malfunction.

This update also comes with a new Graphic, make sure to install those! (Check the Regions/Region Decoration folder)

Bug Fix:

• Fixed a bug when no MapPosition is defined (yet) and you're using the Item Progress Counter feature, it would crash the game. (This is actually a fix from the Arcky's Utilities Plugin but it's the Region Map Plugin that caused the crash.

New Setting:

• Added a new Setting (REGION_MAP_DECORATION) that allows you to add Decoration Graphics on top of your Region Map. These Graphics will render above the Highlight Images (if used). You can hide each Graphic by using a Switch. (So for example if you want some clouds to appear above an hidden Location, set it to the same switch and the clouds will dissapear while the hidden Location will appear. (suggested by @ProChamCham. This update comes with an example Graphic for these Decoration Graphics so you can use it as a reference.

I know it's a small update but the new feature can do a lot for being this small.

Attention: This plugin (update) now requires Arcky's Utilities v1.0.2 or higher to function correctly from now on. Once you've installed this, start a new save to avoid malfunction.

This update also comes with new Graphics including a new Custom and Special Theme, make sure to install those!

Bug Fixes:

• Fixed Location Searcher and Quick Fly updating the Cursor incorrectly when the setting REGION_MAP_BEHIND_UI is set to true.
• Fixed an eventual crash in the Pokedex in case the mapPosition would not have been defined for the Species Location.

Improvements:

• In the Encounter Table, it'll show the last Seen Form on each Species.

New Settings:

• Added a new Setting to Fix the Wild, Trainer and Item Text's position when the Special UI is used.
• Added 2 new Settings (EXTENDED_TEXT_MAIN_WILD_X and EXTENDED_TEXT_MAIN_WILD_Y) to change the X and Y positions of the Wild Counter Text.
• Added 2 new Settings (EXTENDED_TEXT_MAIN_TRAINER_X and EXTEND_TEXT_MAIN_TRAINER_Y) to change the X and Y position of the Trainer Counter Text.
• Added 2 new Settings (EXTENDED_TEXT_MAIN_ITEM_X and EXTENDED_TEXT_MAIN_ITEM_Y) to change the X and Y position of the Item Counter Text.
• Added 2 new Settings (EXTENDED_TEXT_MAIN_BASE and EXTENDED_TEXT_MAIN_SHADOW) to change the Color of the Wild, Trainer and Item Counter Text.
• Added a new Setting ENCOUNTER_TYPES to list and add your custom Encounter Types and choose how you want them to be displayed in the Extended Location Preview.
• Added a new Setting CHANGE_EXT_BOX_ON_ENCOUNTER_TYPE to allow you to make the mapExtBoxMain.png Graphic change depending on the Encounter Type currently displayed in the Extended Location Preivew.
• Added a new Setting CHANGE_ENC_BOX_ON_ENCOUNTER_TYPE to allow you to make the mapEncBox.png Grahic change depending on the Encounter Type currently displayed in the Extended Location Preview.
• Added 2 new Settings (EXTENDED_TEXT_SUB_X and EXTENDED_TEXT_SUB_Y) to change the X and Y position of the Species Info Text (only the Info on the first page when viewing a species' info).
• Added 2 new Settings (EXTENDED_TEXT_SUB_BASE and EXTENDED_TEXT_SUB_SHADOW) to change the Color of the Species Info Text (both Species' info pages).
• Added a new Setting USE_SPECIAL_UI to either use the Special UI or use the default or PokeGear ones (or your own).
• Added a new Setting PROGRESS_SWITCHES which allow you to link a switch to each District, if used, that will be set to ON when the respective District is at 100% using the switchesForDistricts method in an event before checking if the linked switches

Attention: This plugin now requires Arcky's Utilities to function correctly from now on. Once you've installed this, start a new save to avoid malfunction.
This update also comes with this update comes with Graphics that have been moved, it'll say they are missing otherwise!

Bug Fixes:

• When all Counters are disabled, the Extended Preview will not be available.
• When one or more (not all) individual Counters are disabled, the text won't show when there would be no Wild Pokémon, Trainer or Items on a map.
• Fixed innacurate counting of defeatable Trainers on a map.

Improvements:

• Quest Icons can now be customized and update on selecting a Quest.
• Pokémon in the Encounter List are now sorter by (regional) dex number.
• Weather Icons have been moved from UI/WeatherPreview folder to Icons folder (the one inside RegionMap or Town Map).

Also from now on I won't be testing new updates in v20.1 anymore. Only if it are really big issues, I'll include the fixes in future updates of the plugin. v22 is coming soon so managing a plugin on 3 versions is a bit too much.

Remember to also start a new save before trying this new update. (It might probably ask unless you have my Poke Mart Plugin installed).

Attention: This plugin now requires Arcky's Utilities to function correctly from now on. Once you've installed this, start a new save to avoid malfunction.
This update also comes with new Graphics, make sure to install those!

Bug Fixes:

• Fixed an issue with the Trainer and Item trackers.
• Fixed a crash with the highlight being nil when changing Region.
• Fixed a crash with roaming positions when turning switch on when the roaming pokemon was already caught/defeated.

Improvements:

• Improved the way on how the script checks for visited locations.

New Features:

Extended Location Preview allows you to view more detailed information about the location on the Region Map. This goes along with the Location Preview so make sure you've got that setup correctly first. Follow the update guide on what this new features offers.

New Settings:

• Added Settings to set the buttons for each new function inside the Extended Location Preview

Remember to also start a new save before trying this new update. (It might probably ask unless you have my Poke Mart Plugin installed).

Bug fixes:

• Fixed a crash when the available actions would happen to be 0 (this should normally never be the case though)
• Fixed a crash with the itemTracker that would crash the game when using the BW key item plugin.
• Fixed the Item Counter so it counts items given by a script command as well and not only those given by a conditional command.

v2.6.0 will be out probably at the end of next week so I hope you're looking forward to it :)

Bug Fixes:

• Fixed a crash when confirming to fly to the chosen location using the mouse.
• Fixed the text "Change Region" on the Fly Map (field move) while you can't change the Region there.
• Fixed the District Name Feature not being used when the Progress Counter is turned off.

New Settings:

• Added 4 New Settings, to turn on/off each individual Counter used by the Progress Counter Feature (these are the Item, Trainer, Wild Pokémon and Visited Location Counters).

New Feature:

It's now possible to have the Region Map Image change depending on the time in game. (Feature suggested by ProChamCham).
Possible Times are:

• Morning
• Day
• Afternoon
• Evening
• Night

When there's no Morning, Afternoon or Evening variant, it'll use the Day variant instead.
When there's no Night variant, it'll use the Day variant instead.
When there's no Day variant, it'll use the Default one instead.
When there's none at all, it'll use the default one (so better keep that one as well).
In the town_map.txt PBS, keep the name there as the default variant (for example "mapRegion0.png").
If you do not wish to use this feature, you can just ignore the console message, the map should load just fine as long as the default one is still available.

I'm currently working on a new Plugin so I wanted to release this update first so I could focus on this new Plugin until it's finished. Also I'm working on a guide for this Plugin, it should be ready sometime soon (can't say when though).

Bug Fixes:

• Fixed a crash with the Trainer Counter script.

Improvements:

• Reworked the 000_RegionMap_Settings.rb file completely to make it more orginized (no settings have been renamed).

New Feature:

• Added Mouse Support which allows you to select a location, move the map and interact with a location (like opening a Location, Quest or Berry Preview or Select that location to fly to).

If you still encounter issues with the Progress Counter, let me know and I'll try my best to help you fixing it.
(Also I don't know what happened but I released this update already an hour ago and it went bye-bye).