Minimap Plugin

じ☆ve冰风

Hi there! This is my first (Technically second since I re-wrote the older code), plugin for RPG Maker MV. I've been working a lot on it and have improved it since its original release, thus I give you this Minimap Plugin. I will say this for people who make plugins, you might not wanna read my code... while the performance is about as optimized as I can get it, reducing the amount of looping required by storing things in arrays and only drawing the map once, etc, the code might look a bit messy, so if you're picky about that try to avoid looking at my code  



        Download:


        Bug was fixed which hid the minimap. View attachment UPP_MINIMAP.js

        FEATURES

• Automatic mini-map drawing (optional), draws the map based on the collision map.
  
• Optional Region drawing for height-map effects or various other mini-map art.
  
• Event Display for events that have the note-tag <mm_setColor: color>
  
• Option to change the way the player or events are drawn, from square to circle shape
  
• Events can have a beacon effect applied to them via a plugin command.
  
• Endless event colors, as each events color is set via the note tag, but you're also able to change an events color via plugin command as well. 
  
• Pressing Q (Customizable) will toggle the zoom mode based on your settings.
  
• Optional border drawing around the minimap for decoration, it uses the window border.
  
• Optional display name for the area using the note tag <mm_areaname: Name> in the map properties.
  
• Option to change display name via plugin command
  
• Font color and size can be set via the settings.
  

        Screenshot:
         

Spoiler













        Help:

                Code:       

1. This plugin will display a  mini-map for your game.
3. Custom Name Location - This parameter lets you define the
4. location of the minimaps name display.
6. Possible locations:
7. ABOVE, TOP, MID, BOTTOM, BELOW, ABOVERIGHT, TOPRIGHT, MIDRIGHT,
8. BOTTOMRIGHT, BELOWRIGHT, ABOVELEFT, TOPLEFT, MIDLEFT,
9. BOTTOMLEFT, BELOWLEFT
11. NOTE TAGS
12. In map properties, if you add <mm_areaname: Name> to the notes (Where
13. Name is the name of the area), you'll set the display name for the
14. mini map.
16. If you want an event to be displayed on the minimap, you can type
17. this in the events note tag.
18. <mm_setColor: rgba(0, 255, 0, 0.8)>
19. Alternatively, you can use rgb and hex as a color source as well.
21. PLUGIN COMMANDS
22. upp_minimap - set values to show / hide to hide or show the minimap.
23. || Example:
24. ||  upp_minimap show
26. upp_m_useCM - This decides rather or not to use the default
27.                                 Collision Mapping or strictly use region drawing.
28. || Example:
29. ||  upp_m_useCM true
31. || Example:
32. ||  upp_m_hideEventDrawing 1
34. upp_m_showplayer - set values to true / false to hide or show the player.
35. || Example:
36. ||  upp_m_showplayer true
38. upp_m_showEvents - set values to true / false to hide or show the events.
39. || Example:
40. ||  upp_m_showEvents true
42. upp_m_border - set values to true / false to hide or show the border
43. || Example:
44. ||  upp_m_border true
46. upp_m_name - Setting this to true/false will show or hide the minimap
47. display name, however, using the set option, you can change the area
48. name display.
49. || Example:
50. ||  upp_m_border true
51. ||  upp_m_border set Map Name
53. upp_m_setScale - sets the minimap size.
54. || Example:
55. ||  upp_m_setScale 5
57. upp_m_setZoom - sets the minimap zoom size.
58. || Example:
59. ||  upp_m_setZoom 10
61. upp_m_changeImpassColor - Changes the impassable tile color.
62. || Example:
63. ||  upp_m_changeImpassColor #11aaff
64. ||  upp_m_changeImpassColor rgb(25, 150, 255)
65. ||  upp_m_changeImpassColor rgba(25, 150, 255, 0.5);
67. upp_m_changePassColor - Changes the passable tile color.
68. || Example:
69. ||  upp_m_changePassColor #11aaff
70. ||  upp_m_changePassColor rgb(25, 150, 255)
71. ||  upp_m_changePassColor rgba(25, 150, 255, 0.5);
73. upp_m_relocate - Relocates the minimap.
74. || Example:
75. ||  upp_m_relocate 24 24
77. upp_m_namePosition - Changes where the minimap name is drawn.
78. || Example:
79. ||  upp_m_namePosition TOP
81. upp_m_nameOffset - Changes the map names X/Y Offset.
82. || Example:
83. ||  upp_m_nameOffset 24 24
85. upp_m_nameBGColor - Changes the BG color of the name window.
86. || Example:
87. ||  upp_m_nameBGColor #11aaff;
88. ||  upp_m_nameBGColor rgb(25, 150, 255);
89. ||  upp_m_nameBGColor rgba(25, 150, 255, 0.5);
91. upp_m_setRegion - Changes the color of the specified region ID.
92. || Example:
93. ||  upp_m_setRegion 1 color #11aaff;
94. ||  upp_m_setRegion 1 color rgb(25, 150, 255);
95. ||  upp_m_setRegion 1 color rgba(25, 150, 255, 0.5);
97. upp_m_regionClear - you can clear a range of regions, clear a
98.                                           single region, or clear all the regions to
99.                                           stop them from being drawn on the minimap.
100. || Example:
101. ||  upp_m_regionClear single 1
102. ||  upp_m_regionClear range 1 4
103. ||  upp_m_regionClear all
105. upp_m_hideEventDrawing - Hides the event from the minimap by setting
106.                                                    its color to rgba(0, 0, 0, 0).
107. || Example:
108. ||  upp_m_hideEventDrawing 1
111. upp_m_playerCircle - Setting this to true/false will set if the player
112.                                            icon is a circle or a square.
113. || Example:
114. ||  upp_m_playerCircle true
116. upp_m_eventCircle - Same thing as upp_m_playerCircle, only with events.
118. upp_m_setBeacon - Use this to turn an event into a blinking beacon.
119.                   Order: upp_m_setBeacon eventId show expand_speed
120.                   start_opacity opacity_fade_speed delay
121. || Example:
122. ||  upp_m_setBeacon 2 true 0.2 255 4 60
124. upp_m_changePlayerColor - Changes the color of the player indicator.
125. || Example:
126. ||  upp_m_changePlayerColor rgba(150, 255, 255, 0.5)
128. upp_m_changeEventColor - Changes the color of the event.
129. || Example:
130. ||  upp_m_changeEventColor 1 rgba(150, 255, 255, 0.5)
132. REGION COLORS:
133. By default, the region colors are set to NONE which makes the map
134. not render them. Simply change NONE to a hex color, rgb, or rgba.
135. Example: rgba(0, 0, 0, 0.5)
137. There are a total of 255 regions, so be sure to use ones that you
138. aren't already using for other scripts, or at least find a way to
139. make them co-exist if you want to add a little extra detail to your
140. mini-maps.

复制代码

        NOTE:
        Please report any bugs you happen to find. Hopefully I'll be able to fix them, I'm still kind of fresh to making Plugins, but I have some tiny experience in javascript.


本贴来自国际rpgmaker官方论坛作者:TheUnproPro处,因国际论坛即将永久关站,为了存档多年珍贵资料,署名转载到本论坛存档,由于官方帖子为英文原帖，需要中文翻译请点击论坛顶部切换语言为中文就可以将帖子翻译成中文浏览,方便大家随时查看,原文地址：https://forums.rpgmakerweb.com/threads/minimap-plugin.66443/