Skip to content

Add Usage/Wiki page to describe how the program works #48

@JMVRy

Description

@JMVRy

Is your feature request related to a problem? Please describe.
Kinda. Sometimes, I'll try to start a game with default settings and it won't work, but turning on random checkboxes in the GUI eventually makes it work. If I knew what each option did, I might be able to know if turning it on will allow the game to run.

Describe the solution you'd like
Either of these two:

  1. Add a Usage section on the README. In this section, it should go over the options shown in the GUI and describe what they do. For example, it could say Update NWJS: Downloads the newest version of NW.js. Newer versions of NW.js tend to be more compatible with Linux compared to the default NW.js version included with RPGMaker. or something like that.
  2. Add a page in the wiki tab for the same thing. If you add a wiki page, you should likely also add a wiki page for "Troubleshooting". That page should contain "Common Issues" and solutions to those. For example, it could mention Black Screen: If a window opens but it's only black, open the console with Ctrl+Shift+I. Copy whatever is written in red, and submit an Issue here.

Both require describing how the program works in some way, which is currently not done. If I knew how the program worked, I'd be able to better troubleshoot the issues that some games have. I had an issue with a game where the console reported that img/SumRndmDde/preload/Поцанчик_1.png couldn't be found (but there's an encrypted .rpgmvp version instead), and Uncaught TypeError: Error in invocation of nw.Window.open(string url, optional nw.Window.CreateWindowOptions options, optional function callback): Error at parameter 'options': Unexpected property: 'toolbar'. Still dunno what this means, since I don't know how the program works.

Describe alternatives you've considered
The alternative is not describing what the program options do, but that just means it's harder for people to understand what options they need to enable.

Additional context
An image of the GUI with question marks pointing to the confusing options, such as Use SDK Version, Pixi5 Update, and the Versions dropdown

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions