Using Yeonhong
Yeonhong is a bot that reads Discord chat aloud in a voice channel. You don't need to turn on your mic. Just write in chat, and the people in the voice channel hear your message in a voice.
Yeonhong doesn't work alone. Several bots, such as Yeonhong and Yeonha, work together, and when you use /join, whichever bot is free at the time comes in. Yeonhong takes all the commands, and you change server settings in the dashboard.
This page puts together, in one place, how to call the bot for the first time, the rules worth knowing so you don't end up wondering "why isn't it reading?", and where the rest of the docs are. If you've been using Yeonhong for a while, start with the 4.0.0 update notes.
Hear the first words in a minute
- Join a voice channel first.
- In the text channel you want read aloud, run
/join. - A free bot joins the voice channel you're in, and a message in the text channel tells you which bot is covering which channels.
- Write anything in the text channel where you ran
/join. It's read right away. - When you're done, send the bot out with
/leave.
To use /join, you must be in a voice channel first. Otherwise, a short message, Please join a voice channel first!, appears that only you can see.
For how the three voice commands work in detail and the messages they show, see Voice channel commands.
What's where
The sidebar on the left is grouped by what you want to do. Pick the group your topic belongs to first, and you'll find it faster.
| Group | What it covers |
|---|---|
| Yeonhong | Calling and removing the bot, how several bots share the reading, the command list |
| First setup | What a server admin does right after inviting Yeonhong |
| Server settings | What each tab of the dashboard's server settings changes |
| My settings | Settings that apply only to you, such as your nickname, voice, pitch and speed |
| Voices | Which voices you can choose, and what text is read and how |
| Membership | Features membership unlocks, redeeming codes, storage |
Yeonhong
- 4.0.0 update notes — where the old commands moved
- All commands
- Several bots, one team — how a free bot is chosen, which channels each bot covers,
/bots - Voice channel commands —
/join·/leave·/skip /relay— read a message in another voice channel/info— check the bot's status- Translate — translate a message into your language, visible only to you
First setup (server admins)
- Just invited the bot? — from choosing a language to the basic settings
/setupand the Setup assistant- Server settings in the dashboard —
/settings, tabs, Apply and Revert
Server settings (dashboard tabs)
- Reading — what to read, and whose messages
- Join & alerts — Auto-join, Leave when quiet, join and leave alerts
- Voices — server default voice, Lock voice, volume
- Language — main language, Translate when reading, language by channel
- Words & sounds — Abbreviation reading, Reduce spam, Word Replacement, Soundboard
- Permissions — permission levels
- Bots — Our bots, Check permissions, Reading issues
- Voice servers —
/voice-server
My settings
- User settings — the dashboard's user settings and
/user settings
Voices
- Choosing a voice
- All voices
- Listen to new voices
- How the bot reads text — what's read and what's skipped
- Custom voices — have the bot read in your own voice
- Soundboard — write a word and a sound plays
- Voice credits
Membership
Rule 1 — The bot reads only the text channel it was called from
Yeonhong doesn't read every chat in the server. Each bot reads only the one text channel it was tied to when it joined the voice channel.
| How the bot joined | Text channel it reads |
|---|---|
Called with /join | The text channel where the command was run |
| Joined through Auto-join | The text channel where the message that brought it in was posted |
WARNING
If you write in a different text channel, the bot skips it without any message. There's no error and no reaction emoji, so it looks like "the bot is in the voice channel but isn't reading chat." Stay in the same voice channel as the bot, and run /join again in the text channel you want read. 'Move it here?' appears, and when you click [Move], the bot reads that channel.
Even when several bots are in, each message is read by only one bot. If two bots are watching the same text channel, the bot in the writer's voice channel reads it. See Several bots, one team for the full rules.
Rule 2 — Personal settings are separate for each server
Personal settings such as voice, nickname, pitch and speed are saved once per server. If you change your voice in server A, your voice in server B stays the same.
When you join a new server, your settings there start from the defaults. It's not broken. That's how it's meant to work.
Within one server, all bots, such as Yeonhong and Yeonha, use the same settings. Whichever bot comes in, it reads in your voice. See User settings for how to change them.
Rule 3 — Use commands in a server, on Yeonhong
Yeonhong takes all the commands. Other bots such as Yeonha have no commands.
Yeonhong's commands work only in servers. If you run a command in a DM with the bot, the only reply is This command can only be used in a server.
Commands are also blocked while the bot is under maintenance. In that case you'll see 현재 점검중으로 사용이 어렵습니다. 잠시 후 다시 시도해주세요. (It's under maintenance right now. Please try again in a moment.) When maintenance is over, call the bot again with /join.
Who can use what — permission levels
Yeonhong sorts server members into four levels.
| Level | Who |
|---|---|
| Admin | The server owner, people with Discord's Administrator permission, and people or roles added as admins |
| Manager | People or roles added as managers (none at first) |
| User | Everyone else |
| Guest | When 'Separate guests' is on, people without a user role |
Common commands like /join, /leave and /skip are available from User up. Removing or moving a bot in another voice channel, /relay and /voice-server are available from Manager up. See All commands for each command's default level, and Permissions for how to change it.
Auto-join — have the bot come in without calling it
With 'Auto-join' on, you don't need /join. The moment someone in a voice channel writes in chat, one free bot joins that voice channel.
This feature is off at first. You can turn it on in the Join & alerts tab of the dashboard's server settings, or in the 'How the bot joins' step of /setup.
TIP
A bot that comes in through Auto-join joins the voice channel of the person who brought it in, and reads the text channel where that person wrote. It also reads the first message that brought it in.
With auto-join on, a bot comes back in if someone writes in that voice channel even after you removed it with /leave. If it comes right back, a short notice in chat tells you auto-join can be turned off. → Voice channel commands
Messages the bot doesn't read
These are just the cases that most often confuse people at first. See How the bot reads text for all the rules.
- Messages that start with
//— a mark that tells the bot not to read them. Use it for things you'd rather not say out loud to the voice channel. - Messages that are too long — if a message goes over the server's message length limit (200 characters at first), the bot says
The message is too long to read.instead. It doesn't read just the start. The whole message is replaced. - Messages with a soundboard word — when a registered word appears, the bot plays that sound. See Soundboard for details.
- Messages from someone in 'People not to read' — a server admin sets this in the Reading tab of the dashboard.
- When a lot of messages pile up at once — if too many messages are waiting their turn, new messages are skipped without any message. Put a number in
/skipto skip many at once, or clear everything with/leaveand run/joinagain.
Bot names follow the main language
When you choose a main language, the names of all our bots in this server switch to that language. In Korean they show as 연홍, in Japanese as ヨンホン, and in English as Yeonhong. The bot accounts have English names (Yeonhong, Yeonha 1–Yeonha 5). On Korean and Japanese servers, the bots get a nickname in that language. Nicknames your server gave a bot stay as they are.
You can choose the main language from the language question that appears when you first invite Yeonhong, the 'Main language' step of /setup, or the Language tab of the dashboard. All of them do the same thing. Once you set the main language, the bot messages posted for everyone in a channel also appear in that language. Replies and buttons only you can see appear in your Discord language. You can also set a different language for each channel. → Language tab
NOTE
To change its name, a bot needs Discord's Change Nickname permission. A bot without that permission just shows its English account name (Yeonhong), and nothing else is affected. When you choose a language, you're told which bots couldn't change their names.