Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GUM] Tips and Help #207

Open
kaltinril opened this issue Oct 13, 2024 · 2 comments
Open

[GUM] Tips and Help #207

kaltinril opened this issue Oct 13, 2024 · 2 comments

Comments

@kaltinril
Copy link
Collaborator

kaltinril commented Oct 13, 2024

The Interface has many nuances, behaviors, and functionality that is not obvious or common to me (and maybe others?)

Add a HELP or TIPS section in the Help. Or link to the official documentation in the Help.

  1. Explain each item in the Project tab, explain how to use them, the purpose, etc.
  2. Explain the States tab (I don't understand this)
  3. Explain the Variables that exist, how they work, the different purposes
  4. Explain the Editor and it's features, shortcuts, tips
  5. Explain the Code gen and other tabs

Suggestions so far I'll be talking about in the video below.

TIPS:

  1. Middle mouse wheel will move editor

  2. SHIFT limit movement in 1 axis

  3. White line from top left of selected object shows it's parent

  4. Standard windows shortcuts:
    CTRL+Z Undo
    CTRL+C Copy
    CTRL+V Paste

  5. Colors on variables:
    white means it's set explicitly
    Green means using the default

  6. Change order: Can move objects UP/DOWN the treeview within a container
    by ALT+ARROW-UP or ALT+ARROW-DOWN

  7. Can filter your project objects to find one by name

  8. Right-click to make default variable value

  9. Moving X/Y/Width/Height via scroll bar on label

  10. Changing Rotation via circle

@vchelaru
Copy link
Owner

vchelaru commented Oct 28, 2024

I think the documentation is the easier to maintain long-term and it's a catch-all, so I'm going to copy the issues in this card here and link to the documentation. I'll also review the documentation to make sure it covers everything:

Suggestions so far I'll be talking about in the video below.

TIPS:

  • Middle mouse wheel will move editor

  • SHIFT limit movement in 1 axis

  • White line from top left of selected object shows it's parent

  • Standard windows shortcuts:

  • CTRL+Z Undo

  • CTRL+C Copy

  • CTRL+V Paste

Colors on variables:

  • white means it's set explicitly

  • Green means using the default

  • Change order: Can move objects UP/DOWN the treeview within a container by ALT+ARROW-UP or ALT+ARROW-DOWN

  • Can filter your project objects to find one by name

  • Right-click to make default variable value

  • Moving X/Y/Width/Height via scroll bar on label

  • Changing Rotation via circle

@kaltinril
Copy link
Collaborator Author

kaltinril commented Nov 10, 2024

At a minimum, add a link under the Help drop-down, that takes the user directly to the docs page on flatredball.

EDIT: For some reason github adds a blackbox over the mockup I created.... I had to save the file, and then upload an actual file vs pasting the image... silly github

quick_mockup

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants