Operator's Handbook
How to run the Bureau on your channel. The tools and the commands that will help you.
What it is
Every channel is a country, and your viewers carry a passport from chat to chat. Each channel they visit that uses the Bureau's tool gets a stamp when they type !passport.
You install one Browser Source. The bot sits in your chat waiting for commands like any other bot.
Setting up
It takes about a minute to get it up and running: registration form.
-
Connect with Twitch.
We ask for no permissions at all. All the login is for is to know what account is yours!
-
Design your stamp.
Pick a shape and add 4 letters. Give it some color and done! Or upload a custom one through your settings.
If a viewer hasn't signed up at the Bureau, they get a version of your design. If they want their own, you know where to send 'em
The more they visit, the more distinct the stamp becomes!
-
Add the Browser Source in OBS.
Make a new Browser Source with a 1920 × 1080 resolution and put your custom overlay URL:
https://bureauofchat.com/overlay/index.html?channel=yourchannelLeave "Shutdown source when not visible" unchecked. So it runs in the background. In case you have a counter or a poll in the background. It ends up goofing it if the source refreshes.
-
Give the bot moderator.
Totally optional. But modding Passport_Controller gives it 5x more chatting power. In case a lot of things happen, the bot could be silenced for talking too much. So modding it helps.
/mod the bot -
Test it.
Type !passport in your own chat when the overlay is installed. You should be able to see it in action.
The two tools
Dispatch & Settings is where you set the channel up. Everything is self-explanatory so take some time to look around!
Dispatch is where most of the Bureau functions live. Including the telestrator. Trigger countdowns. Polls. Draw, track and even add pictures live onto the overlay. You can even give your mods permission to do this for you.
Dispatch also comes as a dock inside OBS. Go to Docks → Custom Browser Docks and add bureauofchat.com/overlay/dock. You get a condensed control room to be able to remove images. Play and pause videos. Trigger polls and countdowns from your OBS (or similar).
Commands
Anyone can use the first group of commands. The rest is for you and your mods.
!help will show you all the available commands in chat, in case you forget!
Anyone
| Command | What it does |
|---|---|
| !passport | Puts the user's passport on the screen and collects the channel's stamp. |
| !visa <why they are here> | Files Form BC-7. A fun way to announce your intentions. Co-work. Gaming. Chatting. Whatever they want. Deny all the weird requests... Please. |
| !vote <n> | Votes for the corresponding number on the active poll! |
| !ports | Only if it's turned on. Your viewers can see what other live Bureau ports are streaming right now. |
| !miles | You can check how many flier miles you've collected! |
| !enter | Enters the open giveaway. You can customize the command to enter to anything you want like !potluck. |
| !booth | Provides the inspection booth mini game link for viewers who may have missed the command. |
| !admit / !refuse | Viewers can help out in the game as well. |
| !water | They can water your plant (If you have one enabled) |
| !help | The command list. !bureau and !commands |
You and your moderators
| Command | What it does |
|---|---|
| !approve / !decline | If you've turned on that feature, you can deny someone's passport for funsies. |
| !bureau test | If you need to test things offline, you can invite the bot while you are offline to help you out. |
| !stamp <name> | Approves that viewer's application. |
| !deny <name> | Turns it down. |
| !pending <name> | Saves it for later. |
| !filings | Lists who is waiting. |
| !dismiss | !dismiss <name> clears that viewer's visa application. |
| !board <question>? a | b | c | Opens a poll. Chat answers with !vote 1. !board clear takes the poll off the screen. |
| !raid | Tell your chat where we are going! |
| !so <name> | Shouts out a fellow streamer. Can even play a clip of theirs! |
| !timer <minutes> | A countdown for whatever you'd like. !timer stop stops it early. |
| !scene <name> | If you saved a scene, you can use the command to bring it back. It's easier in the telestrator though. |
| !clearstream | Takes everything off the overlay. !stageclear does the same thing. |
| !booth close | Ends the booth minigame. shut, end and stop all work in place of close just in case. |
Your own commands
Make a command to link your discord. Or your socials. Your raid messages etc.
- Open the Port of Entry and make Your own commands.
- In the first box, type the word your chat will use. Example: Discord is saved as !discord.
- In the other box, write what the bot says. Use things like {user} to show who asked, {channel} is your channel, {uses} is how many times it's been asked in case you wanna count something.
- Press Save and it's ready to go.
Try it out. Make sure it works!
Timed messages is exactly as you think. It plays that command every certain minutes.
Duty Free
Everyone earns miles for checking-in. They can use it on the Bureau's permit and duty free store (No real money involved)
Streamers and approved artists can upload designs and re-skins of any widget for users to spend miles on! template
For now it's only reskins. No plans for anything else yet.
When someone buys a passport reskin with miles, they can find it in their passport customization. If it's a widget reskin, streamers can apply it in their settings.
Giveaways
A random draw. It chooses a name from a list of anyone who enters with the designated command. It is truly random. Any prizes offered are not the responsibility of the Bureau of Chat.
You can make it followers only but never subscribers only. In some places in the world, a paid entry into a random draw can be considered illegal gambling/gaming. Laws n' such. (Canada law)
The Community Garden
Your channel grows a flower on stream. They can use !water to keep it healthy. Every chat message also encourages it to grow. When it's finished, the streamer can give the flower to a user to keep. How cute!
By default it takes roughly three hundred to seventeen hundred chat lines to completely grow the flower. You can adjust the settings in the widget settings.
You can adjust the size and position in the Telestrator with the Placement menu.
What the room makes of a flower
Chat can also visit the community garden link to feed it special nutrients to encourage a rare version of itself!
- Blood meal, forty miles. Eight of them and the plant finishes Bloody.
- Grave water, twenty-five. Eight and it finishes Haunted.
- Phosphor wash, thirty. Eight and it finishes Luminous.
- Grave ash, twenty, with blood meal. Ten ash and three blood and it comes up Thorned.
- Gold leaf, ninety, the dearest thing on the shelf. Five and the edges take it: Gilded.
- Ink, thirty, and brine, twenty. These are second roads: ink counts as grave water and brine counts as grave ash, and each adds up with the thing it stands in for. Your garden page still says what was actually given.
- Bone meal, thirty-five, mineral grit, twenty, and stormwater, fifteen. These three earn nothing at all, ever. These encourage how big and tall it grows!
A plant carries two conditions at most.
There's a sixth status and it's very rare.
Nothing can spoil a plant. It can't die and it can't fail. It just grows into a happy little flower.
You can't force the flower to a certain type rarity per se. But you can have fun mixing and experimenting.
Your chat on your stream
Displays your chat messages on screen!
Nothing is stored. After it leaves the screen on the overlay it's gone from the bot/server as well. Read more about it in the privacy notice.
The Ledger
Your channel's own report. bureauofchat.com/overlay/ledger. It shows stats of your channel you may be interested in!
Drawing on the stream
The telestrator has many tools that allow you to do many things. One being: draw on screen.
Drawing includes circling, arrows and free lines. They appear as soon as they are drawn. Similar to a news broadcast/live sports broadcast you may have seen on TV.
Playing something from a link
Video link can be played through the overlay as well. Audio and all. Good for sharing videos with your audience. Bureau of Chat isn't responsible for anything you play.
You can play, pause, and mute/adjust the volume of the video through the telestrator's settings as well. Sadly playback on the telestrator isn't a thing yet. So be sure to watch the live broadcast to see if it is playing.
Telling your chat
!passport works for everyone, even those who aren't signed up on the Bureau website. But if they want to collect stamps and customize it, they need to sign up.
You can use this as an example message to encourage viewers to visit the site and customize their own.
You can use the custom bot commands to achieve this or handle it however you want.
You can make your own commands !discord, !socials as well in the same menu.
What it records
Only viewers who signed up can collect stamps and track their visits. So it's entirely optional to viewers who don't want to use it. It doesn't record anything besides their chat message for the onscreen chat widget but it's immediately deleted when it leaves.
When it goes quiet
The overlay is blank
The overlay by default comes empty if you just signed up. Type !passport to test it. If still nothing, check that the Browser Source URL has ?channel= followed by your own login. If not, restarting OBS helps too.
The bot is not in my chat
For privacy's sake, it only joins your chat when you are live. You can invite it to join offline in case you want to test something with !bureau test.
It sees commands but never answers
It could be due to messaging limitations. If passport_controller is unmodded it can get caught by follower-only mode, slow mode or even a filter. /mod the bot sorts out most of it.
Someone's stamps are missing
They haven't signed up for a Bureau account. Point them to the Citizenship office.
Nothing here fixed it
If all else fails, my servers could be going bonkers and it's not your fault. Reach out to me in DMs or send an email.