-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathDoubleX_RMMV_RMMZ_Event_Text_Extractor.js
More file actions
343 lines (312 loc) · 12.7 KB
/
DoubleX_RMMV_RMMZ_Event_Text_Extractor.js
File metadata and controls
343 lines (312 loc) · 12.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
/*============================================================================
* ## Plugin Info
*----------------------------------------------------------------------------
* # Plugin Name
* DoubleX_RMMV_RMMZ_Event_Text_Extractor
*----------------------------------------------------------------------------
* # Prerequisites
* Abilities:
* 1. Nothing special
*----------------------------------------------------------------------------
* # Terms Of Use
* 1. Commercial use's always allowed and crediting me's always optional.
* 2. You shall keep this plugin's Plugin Info part's contents intact.
* 3. You shalln't claim that this plugin's written by anyone other than
* DoubleX or my aliases. I always reserve the right to deny you from
* using any of my plugins anymore if you've violated this.
* 4. If you repost this plugin directly(rather than just linking back),
* you shall inform me of these direct repostings. I always reserve
* the right to request you to edit those direct repostings.
* 5. CC BY 4.0, except those conflicting with any of the above, applies
* to this plugin, unless you've my permissions not needing follow so.
* 6. I always reserve the right to deny you from using this plugin
* anymore if you've violated any of the above.
*----------------------------------------------------------------------------
* # Links
* Video:
* 1. https://www.youtube.com/watch?v=xDjqmoJAZk4
* This Plugin:
* 1. https://github.com/Double-X/DoubleX-RMMZ/blob/master/DoubleX_RMMV_RMMZ_Event_Text_Extractor.js
* Posts:
* 1. https://forums.rpgmakerweb.com/index.php?threads/doublex_rmmv_rmmz_event_text_extractor.146836/
* 2. https://www.rpgmakercentral.com/topic/43111-doublex_rmmv_rmmz_event_text_extractor/
* 3. https://rpgmaker.net/engines/rmmz/utilities/345/
* 4. https://www.save-point.org/thread-8506.html
* 5. https://gdu.one/forums/topic/14133-doublex_rmmv_rmmz_event_text_extractor/
* 6. https://www.arpgmaker.com/threads/doublex_rmmv_rmmz_event_text_extractor.80837/
* 7. https://forum.chaos-project.com/index.php/topic,16229.msg197732.html
* 8. https://www.reddit.com/r/RPGMaker/comments/u5d37v/doublex_rmmv_rmmz_event_text_extractor/
* 9. https://doublexrpgmaker.wordpress.com/2022/04/17/doublex_rmmv_rmmz_event_text_extractor/
* 10. https://www.patreon.com/posts/65233133
* Mentioned Patreon Supporters:
* https://www.patreon.com/posts/71738797
*----------------------------------------------------------------------------
* # Contributors
* Authors:
* 1. DoubleX
* Plugin Development Collaborators:
* - None So Far
* Bug Reporters:
* - None So Far
* Compatibility Issue Raisers:
* - None So Far
* Feature Requesters:
* - None So Far
*----------------------------------------------------------------------------
* # Changelog
* { codebase: "1.4.4", plugin: "v1.00a" }(2022 Apr 15 GMT 1300):
* 1. 1st version of this plugin finished
*============================================================================*/
/*:
* @url https://www.patreon.com/doublex
* @target MZ
* @plugindesc Versions: { codebase: "1.4.4", plugin: "v1.00a" }
* Lets you extract texts in events/common events/battle events to txt file
* @orderAfter DoubleX_RMMZ_Enhanced_Codebase
* @orderAfter DoubleX RMMZ Enhanced Codebase
* @author DoubleX
*
* @param fileName
* @type string
* @desc Sets the name of the txt file having those extracted texts
* @default Extracted Event Texts
*
* @param filePath
* @type string
* @desc Sets the path of the txt file having those extracted texts
* Leaving it empty means placing the file at project root directory
* @default
*
* @help
* This plugin works for both RMMV and RMMZ but only when running on NW.js
* Only texts, choices and scroll texts in common events, events and troop
* battle events will be extracted by this plugin into the output txt file
* This plugin can lead to very long loading time upon game start when the
* project has hundreds of maps each having tons of texts, choices and
* scroll texts in common events, events and troop battle events
* The output txt file may contain something like this:
* {
* "Common Events": {
* "Cri Hit Sound": {
* "Text": {
* "Contents Line 4": "Cri Hit Sound"
* }
* },
* "Norm Hit Sound": {
* "Text": {
* "Contents Line 4": "Norm Hit Sound"
* }
* },
* "Common Event Name Test Event Text Extractor": {
* "Text": {
* "Contents Line 2": "Common Event Test Text"
* },
* "Choices": {
* "Contents Line 3": [
* "Choice I",
* "B",
* "3rd Selection",
* "Yes",
* "No",
* "Cancel"
* ]
* },
* "Scroll Text": {
* "Contents Line 18": "Common Event Scroll Text Extractor Test"
* }
* }
* },
* "Troop Events": {
* "Hi_monster*8": {
* "Page 1": {
* "Text": {
* "Contents Line 3": "New Turn"
* }
* }
* }
* },
* "First Map": {
* "Event Name Summon Hi Monster X": {
* "Page 1": {
* "Text": {
* "Contents Line 16": "Do you want to fight Hi Monster X?"
* },
* "Choices": {
* "Contents Line 17": [
* "Yes",
* "No"
* ]
* },
* "Scroll Text": {
* "Contents Line 48": "Is Monsters X Working?"
* }
* }
* },
* "Event Name Summon Minions": {
* "Page 1": {
* "Choices": {
* "Contents Line 13": [
* "Cnt Crow"
* ]
* }
* }
* }
* }
* }
*/
// jshint esversion: 8
// var must be used or game will crash
var DoubleX_RMMV_RMMZ = DoubleX_RMMV_RMMZ || {};
//
(() => {
"use strict";
const src = document.currentScript.src;
const name = src.split("/").slice(-1)[0].split(".")[0].replace(/%20/g, " ");
console.info(src, name);
// Separates the version numbers with the rest to make the former more clear
DoubleX_RMMV_RMMZ.Event_Text_Extractor = {
PLUGIN_NAME: name,
VERSIONS: { codebase: "1.4.4", plugin: "v1.00a" }
}; // DoubleX_RMMV_RMMZ.Event_Text_Extractor
//
})();
(ETE => {
"use strict";
const pluginCodebaseVer = ETE.VERSIONS.codebase;
if (!Utils.checkRMVersion) return;
if (Utils.checkRMVersion(pluginCodebaseVer)) return;
console.warn(`Your codebase version is ${Utils.RPGMAKER_VERSION} but must be
at least ${pluginCodebaseVer} to use ${ETE.PLUGIN_NAME}`);
})(DoubleX_RMMV_RMMZ.Event_Text_Extractor);
/*============================================================================
* ## Plugin Implementations
* You need not edit this part as it's about how this plugin works
*----------------------------------------------------------------------------
* # Plugin Support Info:
* 1. Prerequisites
* - Little RMMZ plugin development proficiency to fully comprehend
* this plugin
* (Elementary Javascript exposures being able to write beginner
* codes up to 300LoC scale)
* 2. Parameter/Return value of type * means it might be of any type
* 3. Function signature with (**) means it might take any number of
* parameters of any type
* 4. Supposedly nullable variables are marked with the _ suffix in their
* names(but they can be sure to be non null in some cases)
* 5. Functions supposedly returning nullable values are marked with the
* _ suffix in their names(but their return values can be sure to be
* non null in some cases)
*----------------------------------------------------------------------------*/
/*============================================================================*/
((ETE) => {
"use strict";
const _COMMON_EV_PATH = "data/CommonEvents.json";
const _MAP_INFO_PATH = "data/MapInfos.json";
const _TROOPS_PATH = "data/Troops.json";
const _TEXT_CMD_CODES = { 401: "Text", 102: "Choices", 405: "Scroll Text" };
const _allTxts = async () => _combinedTxts(await Promise.all([
_allCommonEvs(),
_allMaps(),
_allTroopEvs()
])); // _allTxts
const _allCommonEvs = async () => {
return _commonEvWithTxts(await _readJSON(_COMMON_EV_PATH));
}; // _allCommonEvs
const _commonEvWithTxts = commonEvs => commonEvs.filter(commonEv_ => {
return commonEv_ && _hasListTxts(commonEv_);
}); // _commonEvWithTxts
const _allMaps = async () => {
const infos = (await _readJSON(_MAP_INFO_PATH)).filter(info_ => info_);
return _mapWithTxts(infos, await _combinedMaps(infos));
}; // _allMaps
const _combinedMaps = infos => {
return Promise.all(infos.map(map => _readJSON(_mapPath(map.id))));
}; // _combinedMaps
const _mapPath = id => {
return `data/Map${"0".repeat(3 - id.toString().length)}${id}.json`;
}; // _mapPath
const _mapWithTxts = (infos, maps) => maps.filter(map => {
return map.events.some(ev_ => ev_ && _hasPageTxts(ev_.pages));
}).map((map, i) => Object.assign({ name: infos[i].name }, map));
const _allTroopEvs = async () => {
return _troopWithTxts(await _readJSON(_TROOPS_PATH));
}; // _allTroopEvs
const _troopWithTxts = troops => troops.filter(troop_ => {
return troop_ && _hasPageTxts(troop_.pages);
}); // _troopWithTxts
const _readJSON = path => new Promise((resolve, reject) => {
_readJSONXHR(path, resolve, reject).send();
}); // _readJSON
const _readJSONXHR = (path, resolve, reject) => {
const xhr = new XMLHttpRequest();
xhr.onerror = () => {
const rs = xhr.readyState, s = xhr.status;
reject(`path: ${path}, readyState: ${rs}, status: ${s}`);
};
xhr.onload = () => {
const s = xhr.status;
if (s >= 400) return reject(`path: ${path}, status: ${s}`);
const rt = xhr.responseText;
if (rt) return resolve(JSON.parse(rt));
reject(`path: ${path}, responseText: ${rt}`);
};
xhr.open("GET", path);
xhr.overrideMimeType("application/json");
return xhr;
}; // _readJSONXHR
const _combinedTxts = ([commonEvs, maps, troopEvs]) => {
const txts = {
"Common Events": _commonEvTxts(commonEvs),
"Troop Events": _evTxts(troopEvs)
};
maps.forEach(map => { txts[map.name] = _evTxts(_evs(map)); });
return JSON.stringify(txts, null, "\t");
}; // _combinedTxts
const _commonEvTxts = commonEvs => {
const txts = {};
commonEvs.forEach(commonEv => {
const evNameTxts = txts[commonEv.name] = {};
commonEv.list.forEach(_extractTxts.bind(null, evNameTxts));
});
return txts;
}; // _commonEvTxts
const _evTxts = ev => {
const txts = {};
ev.forEach(ev => {
const evNameTxts = txts[ev.name] = {};
ev.pages.filter(_hasListTxts).forEach((page, i) => {
const evPageTxts = evNameTxts[`Page ${i + 1}`] = {};
page.list.forEach(_extractTxts.bind(null, evPageTxts));
});
});
return txts;
}; // _evTxts
const _evs = map => {
return map.events.filter(ev_ => ev_ && _hasPageTxts(ev_.pages));
}; // _evs
const _extractTxts = (txts, cmd, i) => {
const code = _txtCmdCode_(cmd);
if (!code) return;
txts[code] = txts[code] || {};
txts[code][`Contents Line ${i + 1}`] = cmd.parameters[0];
}; // _extractTxts
const _hasPageTxts = pages => pages.some(_hasListTxts);
const _hasListTxts = page => page.list.some(_txtCmdCode_);
const _txtCmdCode_ = cmd => _TEXT_CMD_CODES[cmd.code];
const {
fileName,
filePath
} = PluginManager.parameters(ETE.PLUGIN_NAME);
const _fullFileNamePath = `${filePath}${fileName}.txt`;
(async () => {
const txts = await _allTxts();
if (!StorageManager.isLocalMode()) return console.info(txts);
// RMMV doesn't support require("fs").promises
require("fs").writeFile(_fullFileNamePath, txts, null , err => {
if (err) return console.warn(err);
console.info(`${_fullFileNamePath} is successfully created!`);
});
//
})();
})(DoubleX_RMMV_RMMZ.Event_Text_Extractor);
/*============================================================================*/