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

In game documentation for tools #84

Open
S-S-X opened this issue Dec 22, 2020 · 2 comments
Open

In game documentation for tools #84

S-S-X opened this issue Dec 22, 2020 · 2 comments
Labels
enhancement New feature or request

Comments

@S-S-X
Copy link
Owner

S-S-X commented Dec 22, 2020

Add standardized formspecs containing documentation for tools.

In game docs should contain:

  • List of supported nodes.
  • Info if tool can be used on any node and description what wildcard node def is supposed to do.
  • What functions are implemented and usable for tool and nodes: copy, paste, info.
  • How to execute those functions: use, special+use, sneak+use.
  • Registered chat commands that work with said tool.
  • Something else?

How to display that formspec in game?
Possibly some chat command /metatool help and display documentation for tool that player is holding, allow also saying for example /metatool help tubetool to display tubetool docs no matter what tool player holds in hand.
If not holding anything and not adding tool name then maybe chat reply listing all possible help commands something like:

Run one of following commands to display documentation for tool:
/metatool help tubetool
/metatool help sharetool
/metatool help luatool

Another option would be just /metatool help that would display form that lists tools and when selected displays documentation for that tool. Form could then also contain simple description of common metatool API things.

@S-S-X S-S-X added the enhancement New feature or request label Dec 22, 2020
@6r1d
Copy link
Collaborator

6r1d commented Dec 22, 2020

How to display that formspec in game?

Command is cool, but I was thinking about a tool one can carry without looking at help, because people won't look for a command generally.
It can contain a hint about the command so people learn it, but by default I expect new players to avoid the in-game command. :/

Something else?

Digiline blocks need examples most of the time. Loading these examples should depend on node existing, maybe there should be more examples, because conflicting mods probably do exist.

@S-S-X
Copy link
Owner Author

S-S-X commented Dec 22, 2020

but I was thinking about a tool one can carry without looking at help

#85

Seems I now have 2 separate in game documentation things here 😄

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

No branches or pull requests

2 participants