[RMMV] Split source files for plugin development.

Discussion in 'Learning Javascript' started by Zalerinian, Oct 26, 2015.

  1. Zalerinian

    Zalerinian Jack of all Errors Veteran

    Messages:
    4,691
    Likes Received:
    918
    Location:
    The Internet.
    First Language:
    English
    Primarily Uses:
    N/A

    RPG Maker MV Plugin "Dev Kit"

    This page is no longer updated. The official, current versions of all default scripts can be found on the official github account. The details are listed in the OSS changelog here.


    Hello! As I'm sure many of your plugin creators know, the default script files are really annoying to look through, and it really hurts people trying to learn who get really intimidated! As a result, I've split the files by class, and added some extra documentation to the top of each file. This should help everyone with making plugins, because now you can more easily see the source for specifically what you want, much like RM VX Ace was.


    Now, this is by no means a complete documentation. That will take a lot longer to do. However, this will help you a lot, especially if you have an editor like Sublime Text or Atom where you can include a folder structure in your project and have the files at the ready in your editor. It just makes life all the easier.


    Update [October 29th, 2015, 10:44PM EST]: Files have been updated to MV 1.0.1! Please update your files using the link below to get access to the shared files! Please let me know if you encounter any issues using these files. As opposed to splitting them by hand this time around, I have built a script that can split them for me, as MV is likely to get a couple of updates. If there's an issue with it splitting them, please let me know so I can remedy this immediately.


    Update [March 4th, 2016, 12:18PM EST]: The files for version 1.1.0 have been uploaded! Please update your files as necessary from the download link below so that you can develop with the latest version of RPG Maker MV. Please keep in mind that, like the last update, this was split automatically rather than by hand. I believe all the issues with the splitting script have been resolved, but please be sure to let me know if there is a problem with the files so that I can get them fixed for the downloads.


    Update [April 25th, 2016, 11:38AM EST]: I finally got around to uploading the 1.2.0 files, please update your files at your earliest convenience.


    Update [August 10th, 2016, 5:42PM EST]: The files for 1.3.0 have been uploaded to the google drive folder. Please note that this does not include the pixi-tilemap and pixi-picture libraries that are included with RPG Maker MV. You will need to copy these files into your libs folder yourself, or maps will fail to load due to the new PIXI WebGL tilemap script not being loaded. This new tilemap greatly increases the performance of WebGL rendered games by making extensive use of the user's graphics card, so it's important that you use it!


    Update [August 10th, 6:47PM EST]: I've updated the files due to new CacheEntry and CacheMap classes that were not properly detected by the class split script I'm using to separate the files for this. If you downloaded the files in the last hour, please redownload them for a working set.


    Update [August 11th, 10:03PM EST]: I added the decrypter class, as it was also missing from the previous two builds. If any other classes are missing from the files, please let me know so I may update them as soon as possible.


    Update [Auguest 12th, 2016, 4:58PM EST]: The files have been updated to 1.3.1.


    Update [November 12th, 2016, 11:41AM EST]: The files have been updated to 1.3.3 (was there even a 1.3.2?)


    Update [November 24th, 2016, 10:19AM EST]: The files have been updated to 1.3.4. You may notice that they are formatted slightly differently this time around, which is due to my developing of a new tool to split the files. The old tool required a little bit of manual work to split the files properly, while the new tool is a fully automated process that runs more quickly. The new tool is still being worked on, but it will be released as an open-source program upon completion, I just want to find a better way to manage the code than it currently is.

    Update [July 6th, 2017, 2:39PM EST]: The files have been updated to 1.5.0. The gap in updates is due to me assuming that the OSS files linked above are used in the official engine. Some people have expressed doubt that this is the case, so I've gone and ran my tool on the latest set, and now that I have a bit more free time, I'm going to see if I can finish working on the tool for release.


    Without further ado, your download awaits. you may download them as a zip file, or download each file separately!


    Usage Instructions


    To use the split files in a project, simply extract the index.html and JS folder onto the project, and it will do the work for you. I recommend you keep the large compiled scripts in case you need to quickly and easily find where something is used by default, as you only have to open 6 files instead of 146 files.
     
    Last edited: Jul 7, 2017
    #1
  2. EternalShadow

    EternalShadow Veteran Veteran

    Messages:
    5,805
    Likes Received:
    1,049
    First Language:
    English
    I am getting "access is denied" and "cannot open" on rpg_core/input.js and the others.


    EDIT: Antivirus detects an issue and removed the file o_0
     
    Last edited by a moderator: Oct 26, 2015
    #2
  3. Zalerinian

    Zalerinian Jack of all Errors Veteran

    Messages:
    4,691
    Likes Received:
    918
    Location:
    The Internet.
    First Language:
    English
    Primarily Uses:
    N/A
    That's very odd, as there's absolutely nothing wrong with it... o.o
     
    #3
  4. EternalShadow

    EternalShadow Veteran Veteran

    Messages:
    5,805
    Likes Received:
    1,049
    First Language:
    English
    Yeah, I keep losing half of rpg_core and maybe some others ^_^;


    Could these be converted/reuploaded as plaintext/richtext (whatever supports the indentation/linebreaks/etc already there) so I can paste into js files myself to get past the auto-antivirus scanner? (And for others that may encounter the same issue)
     
    #4
  5. Mouser

    Mouser Veteran Veteran

    Messages:
    1,246
    Likes Received:
    259
    First Language:
    English
    If I were to guess, the anti-virus freaks because you're downloading executable code from the big, scary internetz.
     
    #5
  6. Zalerinian

    Zalerinian Jack of all Errors Veteran

    Messages:
    4,691
    Likes Received:
    918
    Location:
    The Internet.
    First Language:
    English
    Primarily Uses:
    N/A
    It's not even an executable, it's a zip file..

    Alternate link posted!
     
    #6
  7. EternalShadow

    EternalShadow Veteran Veteran

    Messages:
    5,805
    Likes Received:
    1,049
    First Language:
    English
    Yeah, the computer freaks out if I download JS files for some reason (there's an autoscan) - it's not even an exe issue. The alternate link is great, I can read the file now :) (It probably reads some input files like input.js as a trojan)
     
    Last edited by a moderator: Oct 26, 2015
    #7
  8. Zalerinian

    Zalerinian Jack of all Errors Veteran

    Messages:
    4,691
    Likes Received:
    918
    Location:
    The Internet.
    First Language:
    English
    Primarily Uses:
    N/A
    There was a small issue where the Tilemap/Game_Map got messed up and set everything to 16x16 tiles, and a small change has been made to index.html! Sorry about that! It's been fixed now! If you got a version before this post, please download a new copy!
     
    #8
  9. mjshi

    mjshi Jack of Most Trades Veteran

    Messages:
    864
    Likes Received:
    692
    Location:
    USA
    First Language:
    English
    Primarily Uses:
    N/A
    Thanks for this, this will make life so much easier. (7000+ lines is really intimidating to look through, haha)
     
    #9
  10. redspark

    redspark Veteran Veteran

    Messages:
    71
    Likes Received:
    19
    First Language:
    English
    Everything is working fine for me.  Thanks so much.
     
    #10
  11. Lucifurai

    Lucifurai Villager Member

    Messages:
    18
    Likes Received:
    10
    First Language:
    French
    (0.0) Dreams come true. (Just Got Template and now *Learn Plugins Developement*)

    It's a little late to start now because I need to sleep but I start this tonight, and I tell you if there any kinds of issues in this pack. 
     
    #11
  12. Nelderson

    Nelderson Coding Bitch Veteran

    Messages:
    164
    Likes Received:
    159
    Location:
    Rhode Island
    First Language:
    English
    Primarily Uses:
    RMMV
    THANKSSSSSS!!! 

    I was going to get to this myself so I can pinpoint little things.  Thanks again!
     
    #12
  13. MechaGS

    MechaGS Veteran Veteran

    Messages:
    40
    Likes Received:
    6
    First Language:
    English
    Fantastic, this is really helpful!

    Thanks Zalerinian.
     
    #13
  14. babykgar

    babykgar Villager Member

    Messages:
    14
    Likes Received:
    1
    First Language:
    English
    Yes! This!

    This is awesome!

    Thanks, Zalerinian!
     
    #14
  15. altorn

    altorn Veteran Veteran

    Messages:
    53
    Likes Received:
    12
    Location:
    Toronto, Canada
    First Language:
    English
    Thank you for this I was getting intimidated by the 10k line codes.

    Idea: I'm a visual person and I would love to also see an overview of the classes (inheritance and all relations) in a class diagram.

    Perhaps I would at one point create one myself or if anyone out there is interested... ;)
     
    #15
  16. Zalerinian

    Zalerinian Jack of all Errors Veteran

    Messages:
    4,691
    Likes Received:
    918
    Location:
    The Internet.
    First Language:
    English
    Primarily Uses:
    N/A
    I am working on getting better documentation available, however I'm extremely busy with school and work until February at the earliest, starting on the 1st, so I'm trying to get as much as possible done before then.
     
    #16
  17. Stone

    Stone Warper Member

    Messages:
    1
    Likes Received:
    0
    Location:
    Australia
    First Language:
    English
    Hi Zalerinian,

    This is awesome, thanks. Just wondering if this has this been updated to v1.0.1?
     
    #17
  18. Zalerinian

    Zalerinian Jack of all Errors Veteran

    Messages:
    4,691
    Likes Received:
    918
    Location:
    The Internet.
    First Language:
    English
    Primarily Uses:
    N/A
    Hmm, my MV version seems to still be 1.0.0. It may be because I ended up getting a beta version of MV a few weeks before it was released, so I may be on a release branch that's stuck on the initial version. I'll have to go ask around to see if I'm supposed to be getting an update soon. Until then, these are from version 1.0.0
     
    #18
  19. Zalerinian

    Zalerinian Jack of all Errors Veteran

    Messages:
    4,691
    Likes Received:
    918
    Location:
    The Internet.
    First Language:
    English
    Primarily Uses:
    N/A
    Hello everyone! The split files have been updated to MV 1.0.1! Please redownload them to get the up-to-date scripts when you have a chance.

    Also, if you encounter any issues with the files that are not present in the original files that MV gives you, please let me know. This is the first time around I've made a script split the files rather than do it manually, so if there are issues with how it's getting done I'd like to know so I can remedy them.

    Additionally, more documentation is on the way! Here's a little sneak peek!
     
    #19
  20. Woratana

    Woratana Veteran Veteran

    Messages:
    101
    Likes Received:
    98
    First Language:
    Thai
    Wow Zalerinian O_O

    You know you deserved million cookies ! :D

    Documentation looks great. Can't wait to read it :)
     
    Last edited by a moderator: Nov 1, 2015
    #20
    Michael Dionne likes this.

Share This Page