Editing scripts without leaving the game

じ☆ve冰风

[RPG Maker VX] Editing scripts without leaving the game​

Hello guys! All right with you?

Today I'm bringing a script called Scene_ResqueReload that I created for use in my projects that are in RPG Maker VX Ace .

  The Reason  

Unlike many scripts that add new functionality to the game, this script is used as a tool that facilitates the real-time testing of code editing in RPG Maker VX Ace.

Often you need to have a quick response if the changed code is working. It gets more and more stressful when an error occurs in the script and you need several clicks on the tool to open the editor, edit the code, save changes and restart the game.

I have always found limiting the use of the integrated text editor that RPG Maker makes available for code change as there are a wide variety of text editors that provide various tools to help us at that time.

I really enjoy using Sublime Text to program, it has several shortcuts, search engines and numerous text editing tools.

Other text editors can easily be found on the web, whether they are paid, free and even open source. Using this script, you will be able to use the text editor of your choice, be it Sublime, VIM, Atom, Notepad ++, Visual Studio Code, etc ...

  Theory  

Basically, when the game is started, the script reads a directory within your RPG Maker project and loads the external
files Ruby (.rb) into the game.

By default, the script is set to read the "Scripts" folder of your project's root directory, this folder does not exists by default, so you need to manually create and place your .rb files inside it.

Since we are reading an external file, it is possible to reload the code without closing the game by simply pressing the "F5" key on your keyboard when you are playing the game.

This allows you to change the code in your editor and see the change in your game without closing the game!

  The Practice  

To use the script, just create the "Scripts" folder within the root directory of your Maker project and create your custom script (.rb) files.

---

After performing the above step, you need to open open the Standard RPG Maker Text Editor and add the script Resque_Reload to the last line.

Ready! The next time that you open the game, all .rb files in the "Scripts" directory will be read automatically.

  The Benefits  

Besides using any editor, the script allows you to use version control tools like (Git, CVS, Subversion, Mercurial, etc ...), in case your computer explodes or your game gets corrupted, you will have all your code in a safe place.

Also, whenever you receive a code error, your game no will no longer be closed after this message appears:

Now the error message will appear on the Debug screen, with much more information about the error, and your game will automatically go to the home screen (you can see it in the video below)

  The Code  

The script allows some settings to be changed on its first lines:

- Reading Folder Name:
  The default name is "Scripts" but can be changed to any other name (as long as the folder has the same name.)

- Reload key:
  By default the F5 button reloads the game in real time, but this key can be changed to one of your own.

Below is the source code of the script and its latest version on Github, plus a video demonstrating how the script works, where I make several changes to a script, changing the displayed name, positioning and causing errors:

If in doubt, I'll always be here, thanks!!

https://github.com/rogesson/RGSSScr...11645bdce2b419dc1d5e5565a2/Scene_ResqueReload

https://www.youtube.com/embed/0U8TE9uoQ1k
​

Terms

Script Name: Resque Reload
Autor: Resque
Email: rogessonb@gmail.com
Engine: RPG Maker VX
Created At: 13/08/2019
Official Source Code Repository: https://github.com/rogesson/RGSSScr...11645bdce2b419dc1d5e5565a2/Scene_ResqueReload

This script is allowed for commercial and non-commercial games.
Feel free to use it, don't need to credit me in your game.

If you want to share, you must link this post to ensure there are no out of date versions floating around the internet.

                Code:       

1. # Name: Resque Reload
2. # Autor: Resque
3. # Email: rogessonb@gmail.com
4. # Engine: RPG Maker VX
5. # Created At: 13/08/2019
6. # Official Source Code Repository: https://github.com/rogesson/RGSSScripts/tree/ba0b7ef4fdfa8611645bdce2b419dc1d5e5565a2/Scene_ResqueReload
8. # Script is allowed for commercial and non-commercial games.
9. # Do not remove this script's credits or header.
11. class Scene_Base
12.   RELOAD_BUTTON = :F5
13.   SCRIPT_PATH = "Scripts"
14.   FULL_PATH = "#{File.expand_path(Dir.pwd)}/#{SCRIPT_PATH}/*.rb"
16.   DEBUG_MODE = true
18.   def main
19.     start
20.     post_start
21.     update until scene_changing?
22.     pre_terminate
23.     terminate
25.   rescue Exception => e
26.     reload_with_error(e)
27.   end
28.   def update
29.     update_basic
31.     reload if Input.trigger?(RELOAD_BUTTON)
32.   end
34.   def reload
35.     puts "Reload Button [#{RELOAD_BUTTON}] was pressed"
36.     puts "Reloading the Code..."
37.     Scene_Base.load_files
39.     call_current_scene
41.     nil
42.   end
44.   def self.load_files
45.     puts "Loading Files..."
46.     dirs = Dir[Scene_Base::FULL_PATH]
47.     failed = []
49.     dirs.each do |dir|
50.       Dir[dir].each do |file|
51.         begin
52.           class_name = file.split("/").last[0..-4]
54.           autoload class_name, file
55.           load(file)
56.           puts "#{class_name} Loaded" if Scene_Base::DEBUG_MODE
57.         rescue NameError => e
58.           failed << { class_name: class_name, file: file }
59.           next
60.         end
61.       end
62.     end
64.     self.retry_failed_files(failed)
65.     puts "Load completed"
66.   end
68.   def reload_with_error(e)
69.     error_message(e)
70.     SceneManager.call(Scene_Title)
71.   end
73.   private
75.     def self.retry_failed_files(failed_files)
76.       failed_files.each do |f|
77.         autoload f[:class_name], f[:file]
78.         load(f[:file])
79.         puts "#{f[:class_name]} Loaded" if Scene_Base::DEBUG_MODE
80.       end
81.     end
83.     def error_message(e)
84.       puts "-----------------------\nERROR: #{e} \n-> #{e.backtrace}\n-----------------------"
85.     end
87.     def call_current_scene
88.       puts "#{self.class} Reloaded"
89.       SceneManager.call(self.class)
90.     end
91. end
93. Scene_Base.load_files

复制代码

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