RMMV Plugins Help Viewer

Discussion in 'Useful Development Tools' started by Branic, Jan 6, 2019.

    Tags:
  1. Branic

    Branic Warper Member

    Messages:
    1
    Likes Received:
    7
    First Language:
    English
    Primarily Uses:
    RMMV
    I got tired of dropping out of what I was doing, opening the Plugin Manager, then a Plugin, browsing the help documentation, and finally drilling back down into what I was originally working on. And since I couldn't find any tool for that ... I created one.

    NOTE: This tool is for Windows only. I have no means to develop utilities for other platforms.

    It's designed to be used as an add on Tool for the RPG Maker app, but can be used stand-alone (it will ask for a RPG Maker project file when lunched outside of RPM Maker since it is required to determine the plugins path).

    The tool shows all active plugins for the current project on the left; selecting one will display the corresponding help documentation on the right. If you Add/Remove/Activate/Deactivate any plugins after the tools is opened you will need to save the project in RPG Maker and then click the Refresh button in the tool to refresh the plugins list.
    [​IMG]

    I've tried to account for all the most commonly used help text formatting used by plugin developers; but since there's no real standard, help text from some plugins may not render properly.

    Also, it only pulls the "default" language help text from the plugin; any alternate languages text is filtered out. If I knew how RPG Maker was determining language (e.g. Windows Locale setting), I could add a language option. But I will only add it to my tool if I'm sure it matches how RPG Maker is doing it.

    Download here: PluginHelpViewer.zip

    --- Installation ---

    To install it simply extract the archive directly into the "tool" folder in your RPG Maker MV install folder ...
    e.g. %PROGRAMFILES (X86)%\Steam\steamapps\common\RPG Maker MV\tool . The archive contains the proper root folder so be sure to extract directly into the "tool" folder, NOT a subfolder under "tool" folder.

    Then in RPG Maker, click Tools->/RPG Maker MV Tools ... to open the Tools Interface. Depending on where/how you installed RPG Maker it may or may not automatically show up.
    [​IMG]

    If it does not show up in "Found Tools" then you'll need to click the "Select Path" button, browse to the "tool" folder, highlight the "PluginHelpViewer" folder that was extracted, and click "Select Folder". Once it's in the list select it and click "Add", then click "OK". This will add it the Tools menu and the Toolbar.
    [​IMG]
    [​IMG]

    You can find detailed instructions for adding RPG Maker tools here.


    Hope others find this helpful! :smile:
     
    #1
    XPKobold, JiM83, Eliaquim and 4 others like this.
  2. BlueVikingr

    BlueVikingr The Dragonbirb Veteran

    Messages:
    40
    Likes Received:
    23
    Location:
    Canada
    First Language:
    English
    Primarily Uses:
    RMMV
    Wooooooooo! Thank you! This makes things go so much faster, and I don't have to memorize a bajillion notetags anymore.
     
    #2
  3. Chaos17

    Chaos17 Dreamer Veteran

    Messages:
    1,252
    Likes Received:
    419
    Location:
    France
    First Language:
    French
    Hello,

    Does this plugin works with older version of Rpg Maker Mv?
     
    #3
  4. bazrat

    bazrat Veteran Veteran

    Messages:
    73
    Likes Received:
    21
    Location:
    Washington State
    First Language:
    English
    Primarily Uses:
    RMMV
    dude this is amazing! no more opening txt files and copy pasting!

    one question, is there anyway to change the background of the plugin txt or the atleast the text color? at the moment the colors of the background and plugin text are too similar

    EDIT: also not the biggest deal, but anyway for it to save the settings you had for the font, size, etc? seems i have to change it everytime?

    still enjoying this btw, just thought id mention these :)
     
    Last edited: Feb 2, 2019
    #4
    XPKobold likes this.

Share This Page