Game Version Display Plugin

じ☆ve冰风

Version Display v1.02
Author: Michael Morris @Blue Booth Studios


Introduction
While a small plugin, this helps give your title screen a more professional look, and helps with debugging your title.  Version Display allows you to include your version number on your title screen.  In addition, the variable is exposed via script, so you can access it from anywhere in your project (in case you want to display version elsewhere).

As an additional service, the current game version is saved to a separate variable (also exposed) called "saveVersion" when the game is saved.  So, say a user is playing version 1.0.4 of your game, and saves the game.  They quit, and download an update to your game (think beta-testers or public-release).  They restart the game with the new patch - and the game version displays 1.0.5.  Their save version is still 1.0.4, and in the case an error occurs due to version changes, scripting access is exposed to make comparing these two variables trivial.

You must update your game version in plugin parameters manually - versioning varies between developers, and so do the number of changes between versions.  Once the change is made in plugin parameters it is universal for all new instances of play.

A number of customization parameters are available.

Features
- Adds a version display number to the title screen - used for tracking your game version, not for tracking the running version of RMMV.

- Version and saveVersion variables exposed to script access to fit any number of additional display options (i.e. on your save files, main menus, etc.).

- Version and saveVersion are tracked separately to identify potential version conflicts.

- A number of customization options are available so the version text will fit your games aesthetic.

- Fast. No performance drop was noted during tests.

- Now properly supports multiple resolutions.  Width value now available as plugin parameter.

How to Use
- Copy script into your game js/plugins directory.
- Import and configure plugin.  You must update your version plugin parameter manually!

Spoiler                Code:       

1. //=============================================================================
2. // Bluebooth Plugins - Version Display
3. // BBS_VersionDisplay.js
4. //=============================================================================
6. //=============================================================================
7. /*:
8. * @title Version Display
9. * @author Michael Morris (https://www.patreon.com/bluebooth)
10. * @date May 29, 2017
11. * @filename BBS_VersionDisplay.js
12. * If you enjoy my work, consider supporting me on Patreon!
13. *
14. * https://www.patreon.com/bluebooth
15. *
16. * @plugindesc v1.02 Adds display of the game version to the title screen.
17. * Special Thanks to Tsukihime for all the help.
18. * Special Thanks to 'Ramza' Michael Sweeney for all the support.
19. *
20. * ============================================================================
21. * Parameters
22. * ============================================================================
23. *
24. * @param Game Version Number
25. * @desc Game Version. Recommend using format [MILESTONE].[MAJOR].[MINOR]
26. * Default: 1.0.0
27. * @default 1.0.0
28. *
29. * @param Game Version Font
30. * @desc Font face for the version number. Leave blank to use standard. See help.
31. * @default
32. *
33. * @param Version Font Size
34. * @desc Font size for the version number in the details window.
35. * Default: 20
36. * @default 20
37. *
38. * @param Show Version Number?
39. * @desc true to show version number, false to hide.  Useful if you want to store version
40. * number without showing it.
41. * Default: true
42. * @default true
43. *
44. * @param Version Text Color
45. * @desc Version font color. Use system color name.
46. * Leave blank to use standard color.
47. * @default white
48. *
49. * @param Version Outline Color
50. * @desc Version text outline color. Use system color name.
51. * Leave blank to use standard.
52. * @default black
53. *
54. * @param Version Outline Width
55. * @desc Version text outline width. Use system color number, or leave blank
56. * blank to use standard.
57. * @default 8
58. *
59. * @param Title Italic
60. * @desc Version font in Italics?      YES: true      NO: false
61. * Default: false
62. * @default false
63. *
64. * @param Version Text Max Width
65. * @desc Max width for the game version number label.  Can contain formulae!
66. * Default Graphics.width / 3
67. * @default Graphics.width / 3
68. *   
69. * ============================================================================
70. * Terms of Use
71. * ============================================================================
72. *  - Free for use in non-commercial projects and commercial products with credits
73. *
74. * @help
75. * ============================================================================
76. * Description
77. * ============================================================================
78. *
79. * Adds the display of a customized version number to the Title Scene.  Exposes
80. * a variable to get version number at any time in play.
81. *
82. * Use script: $gameSystem.getVersion();
83. *
84. * ============================================================================
85. * Change Log
86. * ============================================================================
87. * 1.02 - Fixed display bug pointed out by Michael 'Ramza' Sweeney when using
88. *          different resolutions.
89. * 1.01 - Plugin finished.
90. *
91. */
92. //=============================================================================
94. //=============================================================================
95. var Imported = Imported || {} ;
96. var BBS = BBS || {};
97. Imported.VersionDisplay = 1;
98. BBS.VersionDisplay = BBS.VersionDisplay || {};
100. (function() {
101.   
102.        //=============================================================================
103.     // Parameter Variables
104.     //=============================================================================
105.     var parameters = PluginManager.parameters('BBS_VersionDisplay');
106.     var pVersionNumber            = String(parameters['Game Version Number'] || '1.0.0');
107.     var pVersionFont            = String(parameters['Game Version Font'] || '').trim();
108.     var pFontSize                 = Number(parameters['Version Font Size'] || 20);
109.     var pShowVersionNumber        = eval(String(parameters['Show Version Number?'] || 'true'));
110.   
111.     var pVersionTextColor        = String(parameters['Version Text Color'] || 'white');
112.     var pVersionOutlineColor    = String(parameters['Version Outline Color'] || 'black');
113.     var pVersionOutlineWidth    = Number(parameters['Version Outline Width'] || 8);
114.     var pVersionItalic             = eval(String(parameters['Title Italic'] || 'false'));
115.     var pVersionWidth            = String(parameters['Version Text Max Width'] || 'Graphics.width / 3');
116.   
117.     var _version = pVersionNumber;                // Track the current version of the game.
118.     var _saveVersion = pVersionNumber;            // Track the version of the game last saved.  This can be different from current game version.
119.     var _defaultVersion = "version 1.0.0";        // Value to use when no _version is found.
120.   
121.     //=============================================================================
122.     // Game_System
123.     //=============================================================================
124.     Game_System.prototype.getVersion = function() {
125.         return _version;
126.     };
127.   
128.     Game_System.prototype.getSaveVersion = function() {
129.         return _saveVersion;
130.     };
131.   
132.     //=============================================================================
133.     // Scene_Title
134.     //=============================================================================
135.     var BBS_VD_Scene_Title_createForeground = Scene_Title.prototype.createForeground;
136.     Scene_Title.prototype.createForeground = function() {
137.         BBS_VD_Scene_Title_createForeground.call(this);
138.         if (pShowVersionNumber) {
139.             this.drawGameVersion();
140.         }
141.     };
143.     Scene_Title.prototype.drawGameVersion = function() {
144.         var x = Graphics.width - (Graphics.width / 3) - 18;
145.         var y = Graphics.height - 50;
146.         var maxWidth = eval(pVersionWidth); //Graphics.width / 3;
147.       
148.         // Handle customization options.
149.         this._gameTitleSprite.bitmap.fontSize = pFontSize;
150.         this._gameTitleSprite.bitmap.fontItalic = pVersionItalic;
151.       
152.         if(pVersionFont !== '') {
153.             this._gameTitleSprite.bitmap.fontFace = pVersionFont;
154.         }
155.         if(pVersionTextColor !== '') {
156.             this._gameTitleSprite.bitmap.textColor = pVersionTextColor;
157.         }
158.         if(pVersionOutlineColor !== '') {
159.             this._gameTitleSprite.bitmap.outlineColor = pVersionOutlineColor;
160.         }
161.         if(pVersionOutlineWidth !== '') {
162.             this._gameTitleSprite.bitmap.outlineWidth = pVersionOutlineWidth;
163.         }
164.       
165.         // And finally... draw
166.         this._gameTitleSprite.bitmap.drawText(pVersionNumber, x, y, maxWidth, 48, 'right');
167.     };
168.   
169.     //=============================================================================
170.     // ConfigManager
171.     //=============================================================================
172.     var bbs_vd_Configmanager_makeData = ConfigManager.makeData;
173.     ConfigManager.makeData = function() {
174.         var config = bbs_vd_Configmanager_makeData.call(this);
175.         config.saveVersion = _saveVersion;
176.         return config;
177.     };
179.     var bbs_vd_Configmanager_applyData = ConfigManager.applyData;
180.     ConfigManager.applyData = function(config) {
181.         bbs_vd_Configmanager_applyData.call(this, config);
182.         _saveVersion = this.readSaveVersion(config, 'saveVersion');
183.     };
184.   
185.     ConfigManager.readSaveVersion = function(config, name) {
186.         var value = config[name];
187.         if (value !== undefined) {
188.             return value;
189.         } else {
190.             return _defaultVersion;
191.         }
192.     };
193.   
194. })(BBS.VersionDisplay);
195. //=============================================================================
196. // End of File
197. //=============================================================================

复制代码

Requirements
None known.

Screenshots
Coming soon!


Demo
N/A

Script


Change Log
1.02
- Fixed display bug pointed out by Michael 'Ramza' Sweeney when using
    different resolutions.
- Width now plugin parameter.

1.01
- Plugin finished.


Known Bugs / TODO
Suggestions, bug reports, and feature requests are welcomed!


Compatibility Issues
None known.


Credit and Thanks
- Micheal Morris @Blue Booth Studios

Author's Notes
Free for non-commercial and commercial use as long as credit is given.


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