docs: improve doucmentation
improve doucmentation and fix small store changes
This commit is contained in:
66
docs-site/docs/user-guide/first-steps.md
Normal file
66
docs-site/docs/user-guide/first-steps.md
Normal file
@@ -0,0 +1,66 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# First Steps
|
||||
|
||||
MetoYou is a chat app for servers, text conversations, direct messages, and live voice. You do not need to understand the technical parts to use it.
|
||||
|
||||
## Main Words
|
||||
|
||||
| Word | Meaning |
|
||||
| --- | --- |
|
||||
| Server | A shared space for a community, team, or group. |
|
||||
| Text channel | A named chat room inside a server. Messages stay in that channel. |
|
||||
| Voice channel | A named live room inside a server. Join it when you want to talk, share camera, or share screen. |
|
||||
| Direct message | A private conversation outside a server channel. |
|
||||
| Plugin | An add-on that can add buttons, panels, tools, integrations, or server-specific features. |
|
||||
|
||||
## Sign In
|
||||
|
||||
1. Open MetoYou.
|
||||
2. Sign in with your username and password.
|
||||
3. If you use more than one signaling server, choose the server endpoint that owns your account.
|
||||
|
||||
A signaling server handles accounts, server discovery, membership, and connection setup. In normal use you can think of it as the place MetoYou checks when you log in and join servers.
|
||||
|
||||
## Find a Server
|
||||
|
||||
1. Open the server search page.
|
||||
2. Search by server name or browse the available list.
|
||||
3. Select a server.
|
||||
4. Join directly if it is public, enter the password if it is protected, or use an invite link if someone sent you one.
|
||||
|
||||
After joining, the server appears in the vertical server rail on the left. Click a server icon there to switch servers.
|
||||
|
||||
## Read and Send Messages
|
||||
|
||||
1. Click a server in the left rail.
|
||||
2. Pick a text channel under **Text Channels**.
|
||||
3. Type in the composer at the bottom of the chat.
|
||||
4. Press Enter or use the send button.
|
||||
|
||||
Text channels keep different topics separate. For example, a server might have `general`, `announcements`, and `support` as separate text channels.
|
||||
|
||||
## Start Talking
|
||||
|
||||
1. Open a server.
|
||||
2. Pick a voice channel under **Voice Channels**.
|
||||
3. Click the voice channel to join.
|
||||
4. Use the voice controls to mute, deafen, start camera, share screen, or leave.
|
||||
|
||||
Voice is live. Text messages are written chat. They can happen at the same time, but they are different channel types.
|
||||
|
||||
## Use Direct Messages
|
||||
|
||||
Direct messages are one-to-one conversations. They are separate from server text channels, so they do not depend on which server you are viewing.
|
||||
|
||||
## Open Settings
|
||||
|
||||
Settings contain account, voice, plugin, server, desktop, update, local API, theme, and data controls. Desktop users can also manage local data import/export and local documentation/API hosting.
|
||||
|
||||
## Install Plugins
|
||||
|
||||
Plugins are installed from the Plugin Store or Plugin Manager. Some plugins are global client plugins. Other plugins are server-scoped and only apply to a specific server.
|
||||
|
||||
See [Plugins for Users](./plugins.md) for the full non-technical plugin guide.
|
||||
82
docs-site/docs/user-guide/plugins.md
Normal file
82
docs-site/docs/user-guide/plugins.md
Normal file
@@ -0,0 +1,82 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Plugins for Users
|
||||
|
||||
Plugins add features to MetoYou. They can add pages, buttons, panels, settings, sounds, message tools, custom embeds, or server-specific behavior.
|
||||
|
||||
## Types of Plugins
|
||||
|
||||
| Type | What it means |
|
||||
| --- | --- |
|
||||
| Client plugin | Installed for your app. It follows you across servers when active. |
|
||||
| Server plugin | Installed for a specific server. It may be required, recommended, optional, blocked, or incompatible. |
|
||||
| Library plugin | Shared plugin code used by other plugins. It is not normally something users interact with directly. |
|
||||
|
||||
## Install from the Plugin Store
|
||||
|
||||
1. Open the Plugin Store from the title bar or Settings.
|
||||
2. Browse or search available plugins.
|
||||
3. Open the plugin details.
|
||||
4. Read the description, version, source, and capability list.
|
||||
5. Choose install.
|
||||
6. Review and grant only the capabilities you trust.
|
||||
7. Activate the plugin.
|
||||
|
||||
Server-scoped plugins installed to the server you are currently viewing are enabled and activated automatically after install, so their panels, actions, or embeds can appear immediately.
|
||||
|
||||
## Install a Local Plugin
|
||||
|
||||
Desktop builds can discover local plugin folders from the app data plugins directory.
|
||||
|
||||
1. Put the plugin folder in the desktop plugins directory.
|
||||
2. Open Settings.
|
||||
3. Open the Plugin Manager.
|
||||
4. Refresh or register local plugins.
|
||||
5. Grant capabilities and activate the plugin.
|
||||
|
||||
## Server Plugin Prompts
|
||||
|
||||
When a server uses plugins, MetoYou may show a prompt.
|
||||
|
||||
| Status | Meaning |
|
||||
| --- | --- |
|
||||
| Required | You must install the plugin to join or continue using that server. |
|
||||
| Recommended | The server suggests the plugin, but you can choose. |
|
||||
| Optional | The plugin is available for the server, but not required. |
|
||||
| Blocked | The server marks the plugin as not allowed. |
|
||||
| Incompatible | The plugin version does not work with your app version or the server requirement. |
|
||||
|
||||
Required plugins are still installed locally on your device. The signaling server stores requirement metadata only; it does not run plugin code.
|
||||
|
||||
## Capability Grants
|
||||
|
||||
Plugins must ask for capabilities before using sensitive features.
|
||||
|
||||
Examples:
|
||||
|
||||
| Capability area | Why a plugin might ask |
|
||||
| --- | --- |
|
||||
| Messages | Send messages, read current messages, moderate messages, or render embeds. |
|
||||
| Users and roles | Read member lists, create plugin users, or manage users. |
|
||||
| Voice and media | Play audio, add an audio stream, add a video stream, or adjust volume. |
|
||||
| UI | Add pages, settings pages, side panels, toolbar buttons, or DOM elements. |
|
||||
| Storage | Save plugin preferences locally or per server. |
|
||||
|
||||
Only grant capabilities to plugins you trust.
|
||||
|
||||
## Manage Plugins
|
||||
|
||||
The Plugin Manager lets you:
|
||||
|
||||
- activate, deactivate, reload, or unload plugins;
|
||||
- grant or revoke capabilities;
|
||||
- inspect plugin logs;
|
||||
- see plugin UI contribution counts;
|
||||
- review server plugin requirements;
|
||||
- uninstall plugins.
|
||||
|
||||
## Plugin Safety Notes
|
||||
|
||||
Plugins are browser-safe JavaScript modules loaded by the client. They do not run on the signaling server. A plugin can only call privileged MetoYou APIs when its manifest declares the capability and you grant it.
|
||||
65
docs-site/docs/user-guide/servers-and-channels.md
Normal file
65
docs-site/docs/user-guide/servers-and-channels.md
Normal file
@@ -0,0 +1,65 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Servers and Channels
|
||||
|
||||
A server is the main shared space in MetoYou. Servers contain members, channels, permissions, optional plugins, and server settings.
|
||||
|
||||
## Server Rail
|
||||
|
||||
The server rail is the vertical list of servers on the left side of the app.
|
||||
|
||||
- Click a server icon to open it.
|
||||
- Use the add/search control to find or join more servers.
|
||||
- A badge can show unread activity.
|
||||
- Server context actions can include invite, leave, or server settings depending on your permissions.
|
||||
|
||||
## Text Channels
|
||||
|
||||
Text channels are written conversations. Each text channel has its own message list.
|
||||
|
||||
Common examples:
|
||||
|
||||
| Channel | Use |
|
||||
| --- | --- |
|
||||
| `general` | Everyday chat. |
|
||||
| `announcements` | Updates from owners or admins. |
|
||||
| `support` | Help requests. |
|
||||
| `clips` | Shared media or links. |
|
||||
|
||||
Messages, replies, reactions, attachments, GIFs, typing indicators, and plugin-created messages are scoped to the active text channel.
|
||||
|
||||
## Voice Channels
|
||||
|
||||
Voice channels are live spaces. Joining a voice channel connects your microphone and lets you use camera or screen sharing when enabled.
|
||||
|
||||
Voice channel examples:
|
||||
|
||||
| Channel | Use |
|
||||
| --- | --- |
|
||||
| `Lobby` | Casual drop-in voice. |
|
||||
| `Gaming` | In-game voice. |
|
||||
| `Meeting` | Focused calls. |
|
||||
| `Support Room` | Live help. |
|
||||
|
||||
## Text Channels vs Voice Channels
|
||||
|
||||
| Text channel | Voice channel |
|
||||
| --- | --- |
|
||||
| Written messages. | Live audio and media. |
|
||||
| You can read later. | You join and leave in real time. |
|
||||
| Uses the message composer. | Uses voice controls. |
|
||||
| Good for searchable discussions. | Good for conversations, calls, screen shares, and quick coordination. |
|
||||
|
||||
## Server Members
|
||||
|
||||
The member list shows people known to the server. Online members appear separately from offline members. Depending on permissions, owners, admins, or moderators can move users between voice channels, kick users, ban users, or change roles.
|
||||
|
||||
## Invites
|
||||
|
||||
Invite links help other users join a server. If a server is private or password-protected, the invite or password controls who can enter.
|
||||
|
||||
## Server Plugins
|
||||
|
||||
A server can recommend or require plugins. Required server plugins may block joining until you choose whether to install them. Optional and recommended plugins can be skipped.
|
||||
33
docs-site/docs/user-guide/settings.md
Normal file
33
docs-site/docs/user-guide/settings.md
Normal file
@@ -0,0 +1,33 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Settings and Data
|
||||
|
||||
Settings control the app, voice, plugins, servers, themes, updates, local APIs, and desktop behavior.
|
||||
|
||||
## Common Settings
|
||||
|
||||
| Area | What you can manage |
|
||||
| --- | --- |
|
||||
| Account | Current profile, display details, and avatar metadata. |
|
||||
| Voice | Devices, volumes, bitrate, latency, noise reduction, screen share preferences. |
|
||||
| Plugins | Installed plugins, capability grants, plugin logs, and plugin store sources. |
|
||||
| Server | Server details, channels, roles, moderation, plugin requirements, and member controls. |
|
||||
| Theme | App colors and visual preferences. |
|
||||
| Desktop | Tray behavior, auto-start, hardware acceleration, updates, and local data tools. |
|
||||
| Local API | Local HTTP server, API docs, Docusaurus docs, and allowed signaling servers. |
|
||||
|
||||
## Local Data
|
||||
|
||||
Desktop MetoYou stores local app data on your device. That can include rooms, messages, users, plugin data, settings, and metadata. The desktop settings include data import/export tools.
|
||||
|
||||
## Local API and Documentation Hosting
|
||||
|
||||
The desktop app can start a local HTTP server. It is off by default. When enabled, it can serve:
|
||||
|
||||
- Local REST API endpoints under `/api/...`;
|
||||
- Scalar REST API docs at `/docs`;
|
||||
- this Docusaurus site at `/docusaurus`.
|
||||
|
||||
Authentication for protected local API routes uses a local bearer token. Login is checked against an allowed signaling server that you configure in settings.
|
||||
37
docs-site/docs/user-guide/text-and-direct-messages.md
Normal file
37
docs-site/docs/user-guide/text-and-direct-messages.md
Normal file
@@ -0,0 +1,37 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Text and Direct Messages
|
||||
|
||||
Text channels and direct messages both use written chat, but they are meant for different situations.
|
||||
|
||||
## Text Channels
|
||||
|
||||
Text channels belong to a server. Everyone with access to that server and channel can participate.
|
||||
|
||||
You can use text channels to:
|
||||
|
||||
- send normal messages;
|
||||
- edit or delete your own messages when allowed;
|
||||
- react to messages;
|
||||
- send attachments;
|
||||
- browse and send GIFs when available;
|
||||
- see typing indicators;
|
||||
- read synced message history stored on your device.
|
||||
|
||||
## Direct Messages
|
||||
|
||||
Direct messages are private conversations outside a server channel. Use them when a message is meant for one person instead of the server.
|
||||
|
||||
## Attachments and Media
|
||||
|
||||
Attachments can appear as files, images, audio, or video depending on the file type and what the app can preview. If an image or link cannot load directly, the app can use fallback paths where available.
|
||||
|
||||
## Message Sync
|
||||
|
||||
MetoYou stores messages locally and syncs recent messages with peers when connections are available. If you were offline, messages may appear after peers reconnect and exchange their recent message lists.
|
||||
|
||||
## Plugin Messages
|
||||
|
||||
Some plugins can send messages, create bot-style plugin users, render custom embeds, or add composer buttons. MetoYou asks for plugin capability grants before plugins can use privileged message features.
|
||||
73
docs-site/docs/user-guide/voice-channels.md
Normal file
73
docs-site/docs/user-guide/voice-channels.md
Normal file
@@ -0,0 +1,73 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Voice Channels and Calls
|
||||
|
||||
Voice channels are live rooms inside a server. Join one when you want to talk, share camera, or share your screen.
|
||||
|
||||
## Join a Voice Channel
|
||||
|
||||
1. Open the server from the left server rail.
|
||||
2. Find **Voice Channels** in the server side panel.
|
||||
3. Click the voice channel you want to join.
|
||||
4. Allow microphone access if your system asks.
|
||||
5. Use the voice controls to manage your call.
|
||||
|
||||
When you join, other users in the same voice channel can hear you unless you are muted. Users in other voice channels are not part of your live voice room.
|
||||
|
||||
## Voice Controls
|
||||
|
||||
The voice controls can include:
|
||||
|
||||
| Control | What it does |
|
||||
| --- | --- |
|
||||
| Mute microphone | Stops sending your microphone audio. |
|
||||
| Deafen | Stops playback and usually mutes your microphone too. |
|
||||
| Camera | Starts or stops webcam video. |
|
||||
| Screen share | Shares a screen or window. |
|
||||
| Settings | Opens voice device and quality settings. |
|
||||
| Leave | Disconnects from the voice channel. |
|
||||
|
||||
## Screen Sharing
|
||||
|
||||
1. Join a voice channel.
|
||||
2. Click screen share.
|
||||
3. Choose a screen or window.
|
||||
4. Choose whether to include system audio when available.
|
||||
5. Stop sharing from the voice controls when done.
|
||||
|
||||
The screen share picker can show screens and windows. Desktop audio support depends on operating system support and the selected source.
|
||||
|
||||
## Voice Workspace
|
||||
|
||||
When someone shares camera or screen, the voice workspace can expand into a larger media area. It can show focused streams, a grid of streams, or a minimized mini-window.
|
||||
|
||||
## Floating Voice Controls
|
||||
|
||||
If you navigate away from the server while still connected to voice, MetoYou can show floating voice controls. Use them to return to the voice server or leave the call.
|
||||
|
||||
## Voice Settings
|
||||
|
||||
Voice settings can include:
|
||||
|
||||
- input device;
|
||||
- output device;
|
||||
- input volume;
|
||||
- output volume;
|
||||
- audio bitrate;
|
||||
- latency profile;
|
||||
- noise reduction;
|
||||
- screen share quality;
|
||||
- system audio preference.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
| Problem | Try this |
|
||||
| --- | --- |
|
||||
| Nobody hears you | Check mute, input device, system microphone permission, and input volume. |
|
||||
| You hear nobody | Check deafen, output device, output volume, and whether others are in the same voice channel. |
|
||||
| Screen share is missing | Check desktop permissions and try a different screen or window. |
|
||||
| Voice drops after switching servers | Return to the server with the active voice session or leave and rejoin the voice channel. |
|
||||
|
||||
Voice and screen sharing use peer-to-peer WebRTC media. The signaling server helps users connect, but the media itself travels through peer connections.
|
||||
Reference in New Issue
Block a user