rothiotome / godot-very-simple-twitch

Very Simple Twitch Chat integration for Godot
MIT License
46 stars 6 forks source link

Dock documentation #7

Closed Laurick closed 8 months ago

Laurick commented 9 months ago

1. Why?

The documentation about the docks are empty.

2. How?

Just write the information about the dock, the usage and other features. I also added the entry for the bottom dock ( still WIP ) and fixed some title indentations

3. Related Issue

None

4. Checklist:

5. Tests made

None

6. Notes

None

rothiotome commented 9 months ago

I've found some grammar and spell errors, can you correct them? Here you have the corrected one, let me know what you think :)

Editor Docks Godot Very Simple Twitch has two docks. One at the bottom called Very Simple Twitch and one at the right called VSTChatDock. Each is used for a specific function:

Very Simple Twitch (WIP) -> Used primarily for changing settings. VSTChatDock -> Used as a test connection with Twitch and one Twitch channel. All messages from the channel are displayed in the editor ;) Very Simple Twitch WIP

VST Chat Dock As mentioned above, VST Chat Dock is a connection to the Twitch channel chat where all messages are displayed in the editor. This is useful for testing your project as it allows you to easily visualize what and when you are getting the messages.

If you are a Godot streamer, you can read your chat in the same window you are coding in.

Usage Just add and activate the plugin as explained in the installation instructions, install the plugin as usual and you'll see a new tab in the right dock named "VstChatDock". Type in the name of a channel and click connect. You will see the messages as soon as the plugin connects.

Features The chat works ONLY in anonymous mode, so you don't need any authorization token, just the channel name. There is a limit for saved messages. Default is 50 messages, but it can be changed in the editor settings (TBI) You can delete all chat messages

rothiotome commented 8 months ago

Perfect! Thanks for contributing :D