Toolshed needs better documentation for beginners #616
Description
"Toolshed is one of the three primary built-in debug tools (alongside scsi and View Variables.) for RobustToolbox, functioning as the game’s development console. To use Toolshed, open the debug console or use the debug console in devwindow."
- How do I open the debug console? (check keybindings: Options>Control>Scroll down to Development>Open Console)
- How do I access devwindow? (write /devwindow in the chat)
- What is scsi and where is it's documentation?
Some Toolshed commands require that you have certain admin permissions, for example debug or mapping flags. These restricted commands are listed in clientCommandPerms.yml.
- How do I gain access to these restricted commands?
Turns out you need to give yourself these flags through the admin permissions window: F7 to open Admin Menu, open the permissions panel, then Add Admin, then enter your username (eg. localhost@JoeGenero) and click on all the '+' symbols to give all those flags.
All of this should be properly documented to save time for new contributors.
toolshed/environments.md says this:
"Cache your environments, ToolshedEnvironment is extremely expensive to create and should not be created more than once per system using them if possible.
Avoid using the default environment for non-debug things, construct your own environment for your systems."
- How do you cache your environment?
- How do you construct your own environment? Does this mean editing clientCommandPerms.yml? What is this even talking about?