Casper Gaming Developer Corner
Casper Gaming Developer Corner

Documentation

Back to Plugin

Terms of Use
Become a Patron
Discuss / Support
Quick InfoVersion: Alpha R4
Made for RPG Maker MZ 1.9.0
Main FeaturesMAP SCENE
Open a scene with a world map that can display icons and other important information in a way that can easily convey location-based info. Show where the player is on the map. Change what displays on the map over time as the story progresses.
Minor FeaturesMAP TRACKING
Where should the player icon be positioned while walking around the world map? Introducing the map tracking feature! Each world map parameter comes with the option to have a corresponding RPG Maker Map ID that will instead cause the player icon to be positioned by their x/y coordinates on the map.

So, for example, if the player is standing right in the middle of the world map in game, when they open the world map scene it will show their icon right in the middle of the map. You can also set bounds for the map, such as minimum X/Y and maximum X/Y in case your map includes details outside the playable area.

While not on the map in game, the player's icon will instead be positioned on the map scene by map data via note tag.
Note TagsTo determine which map displays (other than when forced to show a map via plugin command or script call), use the following note tag in map properties:
<cgmzwm:id>
You would replace id with the World Map id. For example if you wanted to show your map with id "world" you would do:
<cgmzwm:world>

To determine which player icon display is used (the location of the player icon on the map), you can use a similar note tag in the map properties:
<cgmzwmpos:id>
You would replace id with the Player Icon Display id, for example if your id for the player icon display you wanted to use was "outside" you would do:
<cgmzwmpos:outside>
JavaScriptTo call the world map scene using JavaScript, use the following code:
SceneManager.push(CGMZ_Scene_WorldMap);

You can also force the scene to show a specific map by adding a second line:
SceneManager.prepareNextScene("YourMapIdHere");
Note that the map id is the id set in the plugin parameters, not the numerical id assigned to a map within the RPG Maker editor.
Integrations[CGMZ] Actor Upgrade
This plugin makes use of the icon associated with an actor via this plugin, to set it up make sure you have [CGMZ] Actor Upgrade installed and set the player icon to 0. Then, it will use the icon of the lead actor.
Plugin CommandsThis plugin supports the following plugin commands:
Call Scene - This calls the world map scene, optionally force it to display a specific map

Change Player Visibility - Change player icon visibility on the map

Change Player Icon - Change the player icon image on the map

Create Marker - Create a new map marker

Edit Marker - Position - Edit an existing marker's x/y coordinates

Edit Marker - Visibility - Edit an existing marker's visibility

Delete Marker - Remove an existing marker from game data
Saved GamesThis plugin is partially compatible with saved games. This means you can:

✓ Add this plugin to a saved game and it will work as expected.
✘ Modifying plugin parameters is not fully supported. The following will not work correctly in previously saved games: You cannot modify or remove map or marker data from saved games, as these are part of save data. You can add new maps or marker data. Other parameters can be modified or removed with no impact to saved games.
✓ Remove the plugin with no issue to save data.
Filename

The filename for this plugin MUST remain CGMZ_WorldMap.js. This is what it comes as when downloaded. The filename is used to load parameters and execute plugin commands. If you change it, things will begin behaving incorrectly and your game will probably crash. Please do not rename the js file.

Known Issues

This plugin currently has no known issues that need to be fixed. If you believe you have encountered a bug, please report it to Casper Gaming.

Compatibility

This plugin currently has no known compatibility issues with other RMMZ plugins. If you believe you have encountered a conflict, please report it to Casper Gaming.

Version HistoryVersion AlphaR2
  • Added custom images as a map marker option
  • Added options to animate custom image map markers
  • Added blink effect to map markers
  • Added float effect to map markers
Version AlphaR3
  • Added mouse and player coordinate options
  • Fix bug with tint screen also affecting world map
  • Fix bug with marker changes being overwritten in saved games
Version AlphaR4
  • Added map links for zooming in and out to different map levels
  • Added player icon anchor option
  • Fix bug with player icon tracking when map bounds were not 0

Back to Plugin