SmartFoundations / SmartIssueTracker

1 stars 1 forks source link

In-game Smart! documentation #18

Open majormer opened 1 year ago

majormer commented 1 year ago

Is your feature request related to a problem? Please describe. I am unable to find clear documentation for all the features Smart! provides.

Describe the solution you'd like Please include documentation in-game for the various features and controls.

Describe alternatives you've considered I have started to populate a GitHub repo with documents for the time being, but it is still detached from the normal consumption and usage of the mod (i.e., grab the mod from SMM and boot up Satisfactory right away)

Additional context Thoughts have included pulling documentation from this GitHub repo as part of the build process and including it in the mod.

siath70 commented 1 year ago

My suggestion is this: Maybe add a small info panel to the left or right when in build menu to highlight what to do with the mod.

Like 'Point at a building to duplicate it.' 'Use the scroll wheel to change the position of the building to the left or right.' 'Press 'm' to enter the menu while in options menu (or if not in build menu the instructions to open the options menu).' and anything else you can think to add.

This way people can see what is needed and it make the using of the mod easier as you have some on screen instructions.

Of course a toggle for the tips part in the options menu for the help screen. I think that was the hard part for me, learning what I could and couldn't do, and in game instruction tips screen would have helped a lot.

majormer commented 1 year ago

Loving @siath70 's idea. Perhaps the current keybinds could be used in context when generating the panel, so you have it displaying the current keybind in relation to the build mode. "Press up arrow/down arrow to scale on the Y axis, and left arrow and right arrow to scale on the X axis. Press and hold the Left Shift and Control buttons to scale on the Z axis. And the keybinds would be displayed differently if someone modifies them.

majormer commented 1 year ago

And maybe document the current build mode. If you are targeting a building with a similar building to enable "extend mode", then perhaps it would say you were in extend mode, and some context around that such as, "This is limited to a single building at once. Use the mouse wheel to select which direction to extend."

Davosaurus commented 1 year ago

Love the idea of having some on-screen tooltips to make some of Smart's features less of an enigma. There are some really amazing features that we have to keep telling people in the community over and over again that they exist!

Especially: "Double tap shift to temporarily disable auto-connect and extend" That's a big one.