External Scripts Framework

じ☆ve冰风

External Scripts Framework

For RM: VX Ace (RGSS3)

Version: 1.1.0

Creator: Galenmereth

Latest changes:

• 1.1.1 – Implemented the :rest symbol feature in order arrays
  
• 1.1.0 – Introduced the exclude option, and the load_recursive method
  
• 1.0.2 – Actually works properly with encrypted archives
  
• 1.0.1 – Works with encrypted archives
  

Introduction:

The Plugin Framework is a small combination of scripts for handling external script files in Ace in an intelligent and modular fashion. Through use of a simple hash to specify the folder structure, load order, and even exclusion of individual files for debugging, it's much easier to manage vast number of scripts using this framework. And through use of a few simple methods, a plugin can register its own id and check for the existence of other plugins, making inter-plugin scripting much easier.

For example, this system allows for the grouping of scripts by "vendor" (a scripter) in plugin folders, and letting users drop all extensions to a script inside a folder and have it loaded automatically. An example of this would be Yanfly's core script being a plugin folder with a subfolder of extensions, where a user puts all other Yanfly scripts. While this might not sound like an improvement of just putting scripts in Ace's script editor, it allows for much greater flexibility for scripters, as they can ensure specific order in their own script collections, check for existence of other scripts to make compatibility easier, and overall allow for more structure in bigger script collections.

Features:

• Modular plugin folder structure
  
• A Plugin module with simple methods for requiring files in a given path, and in a given order if specified
  
• Documented code
  
• Works with encrypted game archives
  

How to use:

• Look at the linked demo project for an example that includes a Plugins folder with many example plugins that show the different methods. The scripts are documented as well.
  
• The Plugins folder can be found in Data/Plugins
  
• Make sure you test your project in the maker after you make changes to script and before you make an encrypted archive; this is not only a smart thing to do in general, but is required for the script package file to be up-to-date with any changes.
  

Demo:

Demo does not include RTP files and comes in a zip archive; it's 1,3mb in size.

https://github.com/TorD/rgss3-plugin-script-framework/archive/master.zip

Installation:

Detailed instructions for installation can be found in the GitHub repository readme file:

https://github.com/TorD/rgss3-plugin-script-framework

License

This script is free to use in commercial and non-commercial products with credits given. See below for whom to credit; credits may be just names or also mention what is being credited for.

Credit and Thanks

– Tsukihime for the "External Script Loader" script

– Galenmereth for the Plugin Framework

Author's Notes:

I posted this in the development subforum because I want feedback on this, and I'll be changing it a lot based on the feedback I get. Since this is something that can be useful for anyone who scripts a lot (I'm using it myself for my game), its use would be much greater if more scripters where to use it for their own plugins.

Feeling generous?

If you would like to give me a small tip to help me spend even more time making and maintaining these free scripts, do consider supporting me on Gratipay. Any and all support will be greatly appreciated.


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