API tools faq
paste
Sigony

Sigony's Map Additions - Copy and Delete Maps In-Game - RPG Maker MV Plugin - RMMV

Sigony
Aug 20th, 2020
555
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
JavaScript 13.46 KB | None | 0 0
raw download clone embed print report
  1. /*:
  2.  * @plugindesc Allows you to copy a map file from within the game.
  3.  * @author Sigony
  4. */
  5.  
  6.  
  7. /*
  8. Overview​
  9.  
  10. This RMMV plugin allows you to use a plugin command to copy and delete maps using plugin commands, meaning this can happen in-game. This has some powerful possibilities for those with imagination.
  11.  
  12.  
  13.  
  14. [QUOTE]With great power comes great responsibility.[/QUOTE]
  15.  
  16.  
  17.  
  18. Important
  19.  
  20. This plugin manipulates your project's files. Before using this plugin, you should backup your data. I am not responsible for any loss that you incur from using this plugin. Use this plugin with caution.
  21.  
  22.  
  23.  
  24. Potential Use Cases
  25.  
  26. ​Map instances
  27. Powerful when used with Shaz's Tile Changer.
  28. Plugin creators who would like to generate new maps in-game may find that this plugin saves them lots of work.
  29. Features
  30.  
  31. Copy a map using a plugin command.
  32. Delete a map using a plugin command (mainly if you want to clean up instances)
  33. ​INSTRUCTIONS
  34.  
  35. ​
  36.  
  37. To copy a map you can use the following plugin command format:
  38.  
  39. [QUOTE]CopyMap mapId "mapName" variableForNewMapId parentId [/QUOTE]
  40.  
  41. mapId - this is the ID of the map that you wish to copy. A new map, with a different ID will be created.
  42. mapName - this is the name that appears in the editor, and is also the display name.
  43. variableForNewMapId - this is the $gameVariable that will store the newly copied map's ID.
  44. Once you copy the map, you might like to go to it, and so you can do this using events.
  45. Event > Transfer Player > Designation with variables. (You will need to set some temporary values for x and y coord)
  46. You do not need an endless list of variables to hold the mapIDs of every new map that you create in-game. You can be clever and juggle them a bit. To get you started look at: Event > Control Variables > GameData > MapID. The fact that the current map's ID is accessible allows you to store the ID of a map after you leave it.
  47. Make sure to keep track of if a mapID actually exists and know where it leads at any moment. When a map is deleted, and another created, the mapID will be re-used, and this might create some headaches for you if you aren't careful.
  48. parentId - this allows you to make the generated map a child of the map with this parent ID, making it indented and able to be hidden with a spoiler in the editor, the purpose of which is to help reduce clutter in the editor and for you to organize the potentially large amount of maps you'll be dealing with. If you do not desire the copied map to be foldable, set the parentId to 0.
  49. Example:
  50.  
  51. [QUOTE]CopyMap 1 "Copied Map" 5 1[/QUOTE]
  52.  
  53. ​
  54.  
  55. ​​Note: If you copy a map in-game and it does not appear in your editor, it is because the editor hasn't updated its list. If you want to see your copied map in the editor, then feel free to close and re-open the editor.
  56.  
  57. ​
  58.  
  59. To delete a map you can use the following plugin command format:
  60.  
  61. [QUOTE]DeleteMap mapId[/QUOTE]
  62.  
  63. mapId - The mapID of the map you wish to delete.
  64. Example, accessing the value stored in variable 5:
  65.  
  66. [QUOTE]DeleteMap $gameVariables.value(5)[/QUOTE]
  67.  
  68. ​
  69.  
  70. Note: Deletion is permanent. Deleting maps should be done with extreme caution. Again, make sure you backup any maps that are important to you. Make sure you know what you are deleting. Make sure you do any necessary cleanup of your variables. Make sure you do not try to transfer the player to a map that no longer exists.
  71.  
  72. ​
  73.  
  74.  
  75.  
  76. ​
  77.  
  78. ​
  79.  
  80. ​Troubleshooting / Feedback
  81.  
  82. Please report any bugs that you have, and how to recreate the issue. Press F8 to open console.
  83.  
  84. Feedback is welcome.
  85.  
  86.  
  87.  
  88. Credit
  89.  
  90. Sigony
  91.  
  92.  
  93.  
  94. License
  95.  
  96. Credit me where applicable in your derivative works.
  97.  
  98. Redistribute by linking to the original post by Sigony.
  99.  
  100. Commercial use requires payment.
  101.  */
  102.  
  103. (async function() {
  104.     var parameters = PluginManager.parameters('SigonysMapAdditions');
  105.  
  106.     function SigonyMapAdditions(){
  107.         return new Error("This is a static class");
  108.     }
  109.  
  110.     SigonyMapAdditions.copyMapCommand = async function(args){
  111.         const mapId = eval(args.shift());
  112.         const mapName = eval(args.shift());
  113.         const variable = eval(args.shift());
  114.         const parentId = eval(args.shift());
  115.         const destFolder = eval(args.shift());
  116.  
  117.         const newMapId = await this.copyMapFile(mapId,mapName,parentId,destFolder);
  118.         $gameVariables.setValue(variable,newMapId)
  119.  
  120.     }
  121.  
  122.     SigonyMapAdditions.deleteMapCommand = async function(args){
  123.         const mapId = eval(args.shift());
  124.         const srcFolder = eval(args.shift());
  125.         await this.deleteMapFile(mapId,srcFolder)
  126.     }
  127.  
  128.     SigonyMapAdditions.deleteMapFile = async function(mapId,srcFolder=null){
  129.         const mapInfos = await this.scrapeMapInfos();
  130.         const filename = 'Map%1.json'.format(mapId.padZero(3));
  131.         const src = srcFolder? srcFolder+filename : "data/"+filename;
  132.  
  133.         const fs = require('fs');
  134.         fs.unlinkSync(src);
  135.        
  136.         this.removeMapInfo(mapId);
  137.        
  138.         console.log(`${src} SUCCESSFULLY DELETED`)
  139.     }
  140.  
  141.     SigonyMapAdditions.copyMapFile = async function(mapId=$gameMap.mapId(),mapName=null,parentId=0,destFolder=null){
  142.         let mapInfos = await this.scrapeMapInfos();
  143.         //Copy the file
  144.         const filename = 'Map%1.json'.format(mapId.padZero(3));
  145.         const newMapId = await this.findAvailableMapId(mapInfos);
  146.         const newFileName = 'Map%1.json'.format(newMapId.padZero(3));
  147.         const src = 'data/'+filename;
  148.         const dest = destFolder ? destFolder+newFileName : 'data/'+newFileName
  149.  
  150.         const fs = require('fs');
  151.         const { COPYFILE_EXCL } = fs.constants;
  152.         fs.copyFile(src,dest,COPYFILE_EXCL,()=>{console.log(`${filename} COPIED SUCCESSFULLY to ${dest}`)});
  153.  
  154.         //Add the reference to MapInfos.json
  155.         await SigonyMapAdditions.addMapInfo(mapInfos,newMapId,mapName,parentId);
  156.  
  157.         //Polish copied map, change display name
  158.         const map = await SigonyMapAdditions.scrapeMap(newMapId);
  159.         map.displayName = mapName;
  160.         fs.writeFileSync(dest,JSON.stringify(map));
  161.  
  162.  
  163.         return newMapId;
  164.     }
  165.  
  166.     SigonyMapAdditions.removeMapInfo = async function(mapId){
  167.         let mapInfos = await this.scrapeMapInfos()
  168.         mapInfos = mapInfos.filter(mapInfo => {
  169.             if(mapInfo==null){return true;}
  170.             return mapInfo.id != mapId
  171.         });
  172.         const mapInfoData = JSON.stringify(mapInfos);
  173.         const fs = require('fs');
  174.         fs.writeFileSync('data/MapInfos.json',mapInfoData);
  175.     }
  176.  
  177.     SigonyMapAdditions.addMapInfo = async function(mapInfos,mapId,mapName=null,parentId=0){
  178.         let mapInfo = {"id":mapId,"expanded":true,"name":mapName? mapName : "GeneratedMap"+mapId,"order":mapId,"parentId":parentId?parentId:0,"scrollX":1081.3333333333333,"scrollY":680}
  179.         mapInfos.push(mapInfo);
  180.         console.log(JSON.parse(JSON.stringify(mapInfos)));
  181.         mapInfos=this.fixMapInfos(mapInfos);
  182.         console.log(mapInfos);
  183.         const mapInfoData = JSON.stringify(mapInfos);
  184.  
  185.         const fs = require('fs');
  186.         fs.writeFileSync('data/MapInfos.json',mapInfoData);
  187.        
  188.     }
  189.  
  190.     /*SigonyMapAdditions.addMapInfo = async function(mapId){
  191.         const mapInfos = await this.scrapeMapInfos();
  192.         this.addMapInfo(mapInfos,mapId)
  193.     }*/
  194.  
  195.     SigonyMapAdditions.fixMapInfos = function(mapInfos){
  196.         //Sort first
  197.         mapInfos.sort((a,b)=>{
  198.             if(a == null){
  199.                 return -1;
  200.             }
  201.             if(b==null){
  202.                 return 1;
  203.             }
  204.             return a.id-b.id
  205.         });
  206.         console.log(mapInfos);
  207.        
  208.         //Now ensure just one null at beginning
  209.        
  210.         mapInfos = mapInfos.filter(info=>info);
  211.         mapInfos.unshift(null);
  212.         return mapInfos;
  213.        
  214.     }
  215.  
  216.     SigonyMapAdditions.findAvailableMapId = async function(mapInfos){
  217.         let occupied = []
  218.         for(info of mapInfos){
  219.             if(info==null){
  220.                 continue
  221.             }else{
  222.                 occupied.push(info.id)
  223.             }
  224.         }
  225.         occupied.sort((a,b)=>a-b);
  226.         console.log(occupied);
  227.  
  228.         let prev = occupied[0];
  229.         for(i=1;i<occupied.length;i++){
  230.             const o = occupied[i];
  231.             console.log(prev+" "+o)
  232.             if(o==prev+1){
  233.                 prev = o;
  234.                 continue;
  235.             }else{
  236.                 return prev+1
  237.             }
  238.         }
  239.         return prev+1;
  240.     }
  241.  
  242.     SigonyMapAdditions.scrapeMapInfos = async function(){
  243.         var url = 'data/MapInfos.json';
  244.         const data = await fetch(url,{
  245.             headers:{
  246.                 'Content-Type':'application/json'
  247.             }
  248.         });
  249.         return data.json();
  250.     }
  251.  
  252.     SigonyMapAdditions.scrapeMap = async function(mapId,folder="data/"){
  253.         const filename = 'Map%1.json'.format(mapId.padZero(3));
  254.         const data = await fetch(folder+filename,{headers:{
  255.             'Content-Type':'application/json'
  256.         }}).catch(err=>{console.log(err)});
  257.         return data.json()
  258.  
  259.     }
  260.  
  261.     SigonyMapAdditions.createBlankMap = async function(parentId=0, folder="data/"){
  262.         const mapInfos = await SigonyMapAdditions.scrapeMapInfos();
  263.         const mapId = await SigonyMapAdditions.findAvailableMapId(mapInfos);
  264.         const filename = 'Map%1.json'.format(mapId.padZero(3));
  265.         const fs = require('fs');
  266.         fs.writeFileSync(folder+filename,JSON.stringify(
  267.             {
  268.                 "autoplayBgm":false,"autoplayBgs":false,"battleback1Name":"","battleback2Name":"","bgm":{"name":"","pan":0,"pitch":100,"volume":90},"bgs":{"name":"","pan":0,"pitch":100,"volume":90},"disableDashing":false,"displayName":"","encounterList":[],"encounterStep":30,"height":13,"note":"","parallaxLoopX":false,"parallaxLoopY":false,"parallaxName":"","parallaxShow":true,"parallaxSx":0,"parallaxSy":0,"scrollType":0,"specifyBattleback":false,"tilesetId":1,"width":17,
  269.                 "data":[0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
  270.                 "events":[
  271.                 ]
  272.                 }
  273.  
  274.         ));
  275.         mapInfos.push(
  276.             {"id":mapId,"expanded":false,"name":"GeneratedMap"+mapId,"order":mapId,"parentId":parentId,"scrollX":1092,"scrollY":604}
  277.             );
  278.         fs.writeFileSync('data/MapInfos.json',JSON.stringify(mapInfos));
  279.         return mapId;
  280.     }
  281.  
  282.     var Sigony_MapAdditions_Game_Interpreter_pluginCommand = Game_Interpreter.prototype.pluginCommand;
  283.     Game_Interpreter.prototype.pluginCommand = function(command, args) {
  284.         switch(command.toUpperCase()) {
  285.             case 'COPYMAP': // PluginCommand: CopyMap mapId mapName variableForNewMapId parentId  destFolder
  286.                 SigonyMapAdditions.copyMapCommand(args);
  287.                 break;
  288.             case 'DELETEMAP':
  289.                 SigonyMapAdditions.deleteMapCommand(args)
  290.                 break;
  291.             default:
  292.                 Sigony_MapAdditions_Game_Interpreter_pluginCommand.call(this, command, args);
  293.         }
  294.     };
  295.  
  296. })();
Add Comment
Please, Sign In to add comment
Public Pastes
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!