808PrintScreen MV

じ☆ve冰风

Simple and light plugin for MV to let the user take screenshots from the game.
This is a regular screenshot picture where everything on screen will be saved on the image. Different from OrangeMapShot that will only save the map.

Assign your desired screenshot key in the parameters and decide if you want to see a notification on screen or not when the screenshot is saved.

Screenshots will be saved in the screenshots folder at the root of the game directory. The folder will be created automatically.

By default the plugin stops working and display a warning when there are 999 images in the screenshots folder.


Name the file 808PrintScreen.js
Spoiler: Code

                JavaScript:       

1. //==============================================================================
2. //  808PrintScreen
3. //==============================================================================
4. // File: 808PrintScreen.js
5. // v1.0
6. // 7th Sep 2024
7. //==============================================================================
8. /*:
9. * @plugindesc v1.0 Allows taking screenshots by pressing a specified key and saving them to the 'screenshots' folder. Optionally displays a notification on screen.
10. * @author mugen808
11. * @param Screenshot Key
12. * @desc The key to press for taking a screenshot. Default: F7
13. * @default F7
14. * @param Screenshot Notification
15. * @type boolean
16. * @desc Whether to display a screenshot notification on screen. Default: true
17. * @default true
18. * @help
19. *==============================================================================
20. *  808PrintScreen
21. *==============================================================================
22. *
23. * This plugin enables taking screenshots of the game by pressing a specified
24. * key. Screenshots are saved in a 'screenshots' folder in the game directory.
25. *
26. * -Available keys:
27. *   F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, A, B, C, D, E, F, G, H,
28. *   I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, 0, 1, 2, 3, 4, 5, 6,
29. *   7, 8, 9, Shift, Ctrl, Alt, Space, Enter, Escape, Left, Up, Right, Down,
30. *   PrintScreen.
31. *
32. *
33. * By default, a notification will be displayed on the screen when a screenshot
34. * is taken. This can be deactivate in the plugin parameters.
35. *
36. * The screenshot will still be logged in the console regardless of the
37. * notification setting.
38. *
39. * -Parameters:
40. *   Screenshot Key: The key to press for taking a screenshot (default: F7).
41. *
42. *   Screenshot Notification: Whether to display a notification on the screen
43. *   (default: true).
44. *
45. *
46. *==============================================================================
47. *  Terms
48. *==============================================================================
49. *
50. * Free to use. Redistribution not permitted.
51. *
52. *..............................................................................
53. */
55. (function() {
56.     const fs = require('fs');
57.     const path = require('path');
59.     const parameters = PluginManager.parameters('808PrintScreen');
60.     const screenshotKey = parameters['Screenshot Key'] || 'F7';
61.     const screenshotNotification = String(parameters['Screenshot Notification'] || 'false').toLowerCase() === 'true';
63.     function getKeyCode(keyName) {
64.         const keyCodes = {
65.             'F1': 112, 'F2': 113, 'F3': 114, 'F4': 115, 'F5': 116, 'F6': 117, 'F7': 118, 'F8': 119, 'F9': 120, 'F10': 121, 'F11': 122, 'F12': 123,
66.             'A': 65, 'B': 66, 'C': 67, 'D': 68, 'E': 69, 'F': 70, 'G': 71, 'H': 72, 'I': 73, 'J': 74, 'K': 75, 'L': 76, 'M': 77, 'N': 78, 'O': 79, 'P': 80, 'Q': 81, 'R': 82, 'S': 83, 'T': 84, 'U': 85, 'V': 86, 'W': 87, 'X': 88, 'Y': 89, 'Z': 90,
67.             '0': 48, '1': 49, '2': 50, '3': 51, '4': 52, '5': 53, '6': 54, '7': 55, '8': 56, '9': 57,
68.             'Shift': 16, 'Ctrl': 17, 'Alt': 18, 'Space': 32, 'Enter': 13, 'Escape': 27, 'Left': 37, 'Up': 38, 'Right': 39, 'Down': 40,
69.             'PrintScreen': 44
70.         };
71.         return keyCodes[keyName] || null;
72.     }
74.     const keyCode = getKeyCode(screenshotKey);
75.     if (keyCode === null) {
76.         throw new Error(`Invalid key: ${screenshotKey}`);
77.     }
78.     Input.keyMapper[keyCode] = 'screenshot';
80.     let screenshotQueue = [];
81.     let screenshotTimeout = null;
83.     function getNextFileName(dirPath) {
84.         for (let i = 1; i <= 999; i++) { // limit of screenshot files in the folder
85.             const fileName = `img${String(i).padStart(3, '0')}.png`;
86.             const filePath = path.join(dirPath, fileName);
87.             if (!fs.existsSync(filePath)) {
88.                 return fileName;
89.             }
90.         }
91.         return null;  // No available file names
92.     }
94.     function takeScreenshot() {
95.         const dirPath = path.join(process.cwd(), 'screenshots');
96.         if (!fs.existsSync(dirPath)) {
97.             fs.mkdirSync(dirPath);
98.         }
100.         const fileName = getNextFileName(dirPath);
101.         if (!fileName) {
102.             console.error('Screenshot limit reached. Please delete some screenshots and try again.');
103.             if (screenshotNotification) {
104.                 displayScreenshotText('Screenshot limit reached. Please delete some screenshots and try again.');
105.             }
106.             return;
107.         }
109.         const filePath = path.join(dirPath, fileName);
110.         const bitmap = Graphics._canvas.toDataURL('image/png').replace(/^data:image\/png;base64,/, "");
111.         fs.writeFile(filePath, bitmap, 'base64', function(err) {
112.             if (err) {
113.                 console.error('Failed to save screenshot:', err);
114.             } else {
115.                 console.log('Screenshot saved as', fileName);
116.                 if (screenshotNotification) {
117.                     displayScreenshotText(fileName);
118.                 }
119.             }
120.         });
121.     }
123.     function displayScreenshotText(message) {
124.         const text = new PIXI.Text(`Screenshot ${message}`, { fontFamily: 'Arial', fontSize: 12, fill: 'white' });
125.         text.x = Graphics.width - text.width - 10;
126.         text.y = 10 + screenshotQueue.length * 20;
127.         SceneManager._scene.addChild(text);
128.         screenshotQueue.push(text);
130.         setTimeout(() => {
131.             SceneManager._scene.removeChild(text);
132.             screenshotQueue.shift();
133.             updateScreenshotQueue();
134.         }, 2150);
135.     }
137.     function updateScreenshotQueue() {
138.         screenshotQueue.forEach((text, index) => {
139.             text.y = 10 + index * 20;
140.         });
141.     }
143.     const alias_SceneManager_update = SceneManager.update;
144.     SceneManager.update = function() {
145.         alias_SceneManager_update.call(this);
146.         if (Input.isTriggered('screenshot')) {
147.             if (!screenshotTimeout) {
148.                 takeScreenshot();
149.                 screenshotTimeout = setTimeout(() => {
150.                     screenshotTimeout = null;
151.                 }, 200);
152.             }
153.         }
154.     };
155. })();

复制代码

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