The RPG Maker Resource Kit

RMRK RPG Maker Creation => RPG Maker General => General Scripting => Topic started by: D&P3 on August 21, 2012, 01:52:39 PM

Title: How to Insert & Utilize a script
Post by: D&P3 on August 21, 2012, 01:52:39 PM
How to Insert & Utilize a script


Since it has come to my attention that not everybody knows how to implement scripts into their project, this tutorial hopes to show you the way.



Finding a Script
Spoiler for:
Each and every RPGMaker related board has its own section for scripts, they come in the following types:
RGSS ~ RMXP
RGSS2 ~ RMVX
RGSS3 ~ RMVXA


I am unaware of absolutely every single RPGMaker related forum in existence, however I shall list the location for the master scripts list for the boards that I am aware of:

Spoiler for:
RPG Maker XP
  • RMRK XP Script Index (http://rmrk.net/index.php/topic,17595.0.html)
  • RPGRevolution RGSS Master Script List (http://www.rpgrevolution.com/forums/index.php?showtopic=25015)
RPG Maker VX
  • RMRK VX Script Index (http://rmrk.net/index.php/topic,31844.0.html)
  • RPGMakerVX.net Master Script List (http://www.rpgmakervx.net/index.php?showtopic=4241)
  • RPGRevolution RGSS2 Master Script List (http://www.rpgrevolution.com/forums/index.php?showtopic=45637)
RPG Maker VXA
  • RMRK VXA Script Index (http://rmrk.net/index.php/topic,44874.0.html)
  • RPGMakerWeb VXA Master Script List (http://rmvxace.wikia.com/wiki/RPG_Maker_VX_Ace_Master_Script_List#VX_Ace_Master_Script_List)
  • RPGMakerVXAce.net Master Script List (http://www.rpgmakervxace.net/topic/254-master-script-list-on-site/)
  • RPGRevolution Master Script List (http://www.rpgrevolution.com/forums/index.php?showtopic=55691)

Of course, not all master script lists are updated constantly and there are even some forums that don't have any at all.
So with that in mind, there may be even more scripts for you to choose from that are not on those lists, but you'll need to do some searching. I'd strongly recommend using google to find a script if you can't find it on any master script list, saves you some hassle. But you can do some extra searching here:

Spoiler for:
RPG Maker XP
  • RMRK XP Scripts Database (http://rmrk.net/index.php/board,111.0.html)
  • RPGMakerWeb Scripts RMXP (http://forums.rpgmakerweb.com/index.php?/forum/39-rgss-scripts-rmxp/)
  • RPGRevolution Scripts Database (http://www.rpgrevolution.com/forums/index.php?showforum=163)
  • Whitefang RGSS Scripts (http://whitefang.makeforum.net/f43-ruby-rgss1) (This is a new forum and currently has no RMXP Scripts)
RPG Maker VX
  • RMRK VX Scripts Database (http://rmrk.net/index.php/board,100.0.html)
  • RPGMakerVX.net Complete RGSS2 Scripts (http://www.rpgmakervx.net/index.php?showforum=26)
  • RPGMakerWeb Scripts RMVX (http://forums.rpgmakerweb.com/index.php?/forum/37-rgss2-scripts-rmvx/)
  • RPGRevolution Scripts Database (http://www.rpgrevolution.com/forums/index.php?showforum=163)
  • Whitefang RGSS2 Scripts (http://whitefang.makeforum.net/f9-ruby-rgss2)
RPG Maker VXA
  • RMRK VXA Scripts Database (http://rmrk.net/index.php/board,112.0.html)
  • RPGMakerVXAce.net Complete RGSS3 Scripts (http://www.rpgmakervxace.net/forum/20-complete-rgss3-scripts/)
  • RPGMakerWeb Scripts RMVXA (http://forums.rpgmakerweb.com/index.php?/forum/35-rgss3-scripts-rmvx-ace/)
  • RPGRevolution Scripts Database (http://www.rpgrevolution.com/forums/index.php?showforum=163)
  • Whitefang RGSS3 Scripts (http://whitefang.makeforum.net/f10-ruby-rgss3)



So what are we looking for?
Spoiler for:
Well it could be pretty much anything, maybe you wanted a pathfinding script? Don't know what a pathfinding script is? Well it's a script that will allow you to set move routes without having the calculate absolutely every single tile for that event to walk on if you're a cutscene maniac like me, this is definitely a script to look at
Spoiler for:
And it just so happens that on the RMVXA Scripts Master list on RMRK, there is a pathfinding script by Cozziekuns

(http://img4host.net/upload/21154517503390ed6beb8.png)

Or maybe you want a different title screen other than the default
Spoiler for:
Well on the RPGRevolution RGSS Master Script List you can find this:

(http://img4host.net/upload/211343385033746ac0236.png)

Or maybe you wanted a hud for your game
Spoiler for:
Well on the RPGMakerVX.net Master Script List, you can find a whole section for that

(http://img4host.net/upload/2113344150337251dfc26.png)


Or maybe you want to give the player more than just 4 choices
Spoiler for:
Well on the linked Master script list of RPGMakerWeb and RPGMakerVXAce.net, you can find this

(http://img4host.net/upload/21134023503373a78a077.png)



Wow, a lot of choices there right?
Correct, but you must remember that you're only searching for scripts for your maker. For example don't go looking into RMVXA scripts if you're using RMVX, they will not work so don't waste your time.



How to insert a script
Spoiler for:
Things work differently on different forums, all of them should have a section in the thread that has the script. In most cases it should look something like this:

Spoiler for:
Spoiler for RMRK:
(http://img4host.net/upload/2114103550337abbad43b.png)

Spoiler for RPGMakerWeb & RPGMakerVXAce.net:
(http://img4host.net/upload/2114135850337b866b2b0.png)

Spoiler for RPGRevolution & RPGMakerVX.net:
(http://img4host.net/upload/2114155850337bfed9854.png)

However there may be occasions where the creator of the script tells you to get it from an outside source, normally this would be Pastebin
Spoiler for:
(http://img4host.net/upload/2114215750337d652dacc.png)

(http://img4host.net/upload/2114225650337da08fd3c.png)



If you have even basic computer skills you should know how to copy text. In my opinion, RMRK and Pastebin make this the easiest, because they have icons which allow you to select and copy the entire text.
Copy all the text inside of the code box and now go into your RPG Maker Project.



Now that you have the text, this is what you need to do to get the script working for you.
You need to check the instructions for that script to see if it needs to be placed anywhere specifically, most of the time this will not be the case and if there is no specific instructions on where to place the script, the following method will work just fine for you.
Spoiler for:
Spoiler for RPG Maker XP:
come up to this icon and click on it

(http://img4host.net/upload/211500065033865652e5c.png)


this will open up your script editor. Scroll down to the bottom, right click on main and then click on insert... Space it out to make it look neater if you wish

(http://img4host.net/upload/21150223503386df76e7a.png)


Now just above main is where you will be placing your custom script, click on any of the empty slots you made and insert a name, the name is up to you, but I suggest keeping the original script name and putting the name of the author of the script next to it

(http://img4host.net/upload/21150545503387a95cde7.png)


And now inside the huge white area to the right, you now paste the script that you copied earlier

(http://img4host.net/upload/21150653503387ed13154.png)

Click on apply, then OK
Congratulations, you've now inserted a custom script into your project.


Spoiler for RPG Maker VX:
come up to this icon and click on it

(http://img4host.net/upload/21143708503380f4051ec.png)


this will open up your script editor. Scroll down to the bottom

(http://img4host.net/upload/211439575033819d5c9f5.png)


Now in between materials and main is where you will be placing your custom script, click on any of the empty slots in between the two and insert a name, the name is up to you, but I suggest keeping the original script name and putting the name of the author of the script next to it

(http://img4host.net/upload/21144832503383a0170cb.png)


And now inside the huge white area to the right, you now paste the script that you copied earlier

(http://img4host.net/upload/21145032503384187f8cb.png)

Click on apply, then OK
Congratulations, you've now inserted a custom script into your project.


If you right click in any of the slots between Materials and Main and then click on insert you can create more slots for more scripts, pretty cool right?


Spoiler for RPG Maker VXA:
come up to this icon and click on it

(http://img4host.net/upload/21151458503389d2279a2.png)


this will open up your script editor. Scroll down to the bottom

(http://img4host.net/upload/2115154850338a04d7f32.png)


Now in between materials and main is where you will be placing your custom script, click on any of the empty slots in between the two and insert a name, the name is up to you, but I suggest keeping the original script name and putting the name of the author of the script next to it

(http://img4host.net/upload/2115172950338a697b56d.png)


And now inside the huge white area to the right, you now paste the script that you copied earlier

(http://img4host.net/upload/2115182650338aa21551b.png)

Click on apply, then OK
Congratulations, you've now inserted a custom script into your project.


If you right click in any of the slots between Materials and Main and then click on insert you can create more slots for more scripts, pretty cool right?



How to tweak a script
Spoiler for:
Well just because you've managed to insert a script does not mean you are done with it, a lot of scripts are plug and play, meaning that you do not have to do anything.
But some scripts give you the option to edit things to suit them to your needs.
For example, the versus pop-up script by Modern Algebra allows you to edit some things

Spoiler for:
(http://img4host.net/upload/2115285450338d167e97e.png)

Notice how there was a header saying "Editable Region", well that means from there on, you can edit things. Once you leave the editable region, you DO NOT TOUCH anything.
The green text is just telling you what things do, you don't edit that.
What you do edit is this

(http://img4host.net/upload/2115351550338e93a8703.png)

The instructions for editing them were in the green text above, but to further explain some things, you ONLY edit what is after the equals sign ( = )
and if you see something like this

MAVP_SE = ["Battle2"]

You only edit what is inside of the two [ ].




It is recommended that once you install a script, you start a new game on your project rather replaying from a previous save game, it is a known occurrence that some scripts require you to start a new game before it will work.



A Few Tidbits

If a script ever mentions something about an Event switch ID or a Variable ID.
it is actually referring to these:
Spoiler for:
(http://img4host.net/upload/211550075033920fcb3ac.png)

(http://img4host.net/upload/211551255033925d3723b.png)


Good Luck to you.
Title: Re: How to Insert & Utilize a script
Post by: IAMFORTE on August 21, 2012, 03:01:50 PM
Wow! Nice work
Title: Re: How to Insert & Utilize a script
Post by: modern algebra on August 22, 2012, 12:33:16 AM
Nice tutorial D&P3. Stickied for sure.
Title: Zhiyun Smooth 4
Post by: Andrewveisa on August 21, 2019, 11:18:26 PM
Iphone XS Max Cinematic Video : https://youtu.be/mi9xCohoyMw