MasuCompanion · Guide
Your chat plays your vault
MasuCompanion lets your whole Twitch audience play each Vault Hunters vault with you. You play as usual: inside a vault everything runs by itself, and the only choice you make is the spice in the portal room.
Before you start
What you need
- A Twitch channel.
- Vault Hunters on Minecraft Forge 1.18.2 (VH3 Remastered or Wold's Vaults).
- The MasuCompanion mod in your own game. Without it the server reports none of your runs. Other players on the server never need it.
- A place to play: a server that runs MasuCompanion and accepts you, or your own singleplayer or LAN world.
Everything you set up lives in the MasuCompanion dashboard. Sign in with Twitch. It is free and needs no application.
Setup
Seven steps, checked for you
The dashboard's Setup page walks you through each step and ticks it off when it sees it working, so you can stop and come back any time:
- Connect Twitch and register the Twitch events, so support fills the meter and the bot can read chat.
- Add the extension as an Overlay and open its Configuration once.
- Choose where you play: request access to a server, or create a personal key for singleplayer.
- Connect the game: servers connect by themselves; in singleplayer type
/masucompanionand paste your key. - Link your Minecraft account with
/companion link <code>, for every account you stream with. - Chat commands (optional): turn them on and make the bot a moderator.
- Run your first vault.
Swipe sideways to see the whole screen.
Getting started
Set up your channel
Step 5
Link your Minecraft account
Create a link code and type /companion link <code> in Minecraft within 10 minutes. Link every account you stream with.
/companion link 7KQ2-M9Type it in Minecraft within 10 minutes.Waiting for the code in Minecraft.
Before you go live
Try it with a stream test
The dashboard's Stream test plays simulated fate votes, meter fills, shoutouts and a squad on your overlay and in your game, without a vault. Use it to check your scene layout and that the overlay shows up.
Everything it shows is marked TEST and test votes give nobody anything. It cannot start while a run is open, and opening a run ends it.
Portal room
Meet the spotlight squad
When you step into the portal room, the squad reveal plays full screen in your game: the three viewers in this run's spotlight squad as 3D models in their own skins, tagged with how they got their seat. Your viewers watch it on your stream and their overlay tells each of them whether they made it.
It stays until you click or press Space (at most 30 seconds), so you can introduce the squad.
Swipe sideways to see the whole screen.
Into the vault with Masuary
Spotlight squad
One MVP from last run, the rest by lucky draw
Click or press Space for the Briefing
Portal room
Choose your spice
Then the Briefing opens. Pick the spice for this run with 1 2 3 or a click:
- Chill: each vote offers 2 blessings and a mild curse.
- Spicy: a blessing, a curse and a chaos effect.
- Chaos: stronger curses and chaos, and a bigger reward for the crowd.
The server can cap the highest spice. The spice locks when the vault timer starts.
Swipe sideways to see the whole screen.
Vault briefing
Choose your spice
Every few minutes chat votes between three fates. Spice sets which kinds of fate each vote offers. Locked once the vault timer starts.
Spotlight squad
Predictions
Open on the overlay until the vault timer starts. 14 stakes, ◆ 1,240 in play.
Portal room
Your chat calls the run
While you are in the portal room, your viewers' overlay shows a full-screen predictions lobby: three questions about this run, staked with Masurium. The lobby closes and stakes lock the moment your vault timer starts, so take the time you need in the portal room.
Settlement pays out exactly what was staked. A result the game could not see is refunded, never guessed. Switch off any question under Predictions in the dashboard.
Swipe sideways to see the whole screen.
In the vault
Everything runs by itself
- Fate votes open every 3.5 minutes while the timer runs (the first after 1 minute) and stay open 45 seconds. The winner is applied to your vault and shown on your HUD. Effects tagged ×1–2 or ×1–3 roll how many copies land; Instant ones are crowd moments (Freeze Frame, Coin Rain, Launch, Shrink Ray) that happen at once and never use your mana. When an effect ends, your HUD and the overlay show what it did.
- The crowd meter fills from watching, votes, gems, Bits, subs, gift subs, hype trains and channel point rewards you map. When it fills, chat votes 20 seconds on an ultimate, including crowd casts such as Champion Call, Crowd Nova, Frost Nova and Totem Drop (the pack's own level 8 abilities, without your mana or cooldowns).
- Loot bursts fly across your viewers' video on a rare chest, a champion kill, an ultimate or the objective's reward crate.
- The spotlight squad follows you as small big-headed allies. They never fight, mobs ignore them and your attacks pass through them. Look at one to see its name and title; an ally that emotes walks into your view first.
Your HUD keeps everything on the edges of the screen; move any part in VH's HUD editor. When the vault ends, predictions settle and everyone who took part gets run XP and Masurium. If your game crashes, the run ends as aborted after 2 minutes and every stake is refunded.
Swipe sideways to see the whole screen.
Spotlight squad
Charged by PixelPilgrim, BulTan81
PixelPilgrim cheered 500 Bits
Champion slain
Viewers are grabbing gems
In the vault
What the crowd chose
When a vote closes, the HUD names the winner with the copies it rolled, its kind and how long it lasts (Instant for a crowd moment). When the effect ends, the same slot shows what it did. A failed run injures its squad for the next run; an aborted one keeps the seats for the next.
Charged by PixelPilgrim, BulTan81
+1 Slowness for everyone in the vault.
Run tools
The Control Deck
Press End for the Control Deck: connection status, your linked account and access, the current run, previews of the Briefing and HUD that only you see, and the run tools. When something is wrong it says what and who fixes it.
| Key (default) | What it does |
|---|---|
| End | Open the Control Deck |
| Shift + End | Pause or resume fate votes; the countdown continues where it stopped |
| Ctrl + End | Open the next fate vote now (at least 1 minute after the last one) |
Change the keys in Minecraft's Controls under MasuCompanion.
Swipe sideways to see the whole screen.
MasuCompanion · Multiplayer
Control deck
Status
Fate votes · next in 1:52
This server
The server owner installs the key and decides which streamers are accepted here. Your own setup lives in the MasuCompanion dashboard.
Stream tools
Previews only show on your screen
End of stream
Roll the jackpot
When a prediction's answer is known but nobody picked it, its stakes go into your channel's jackpot. Loot bursts add half the value of the gems no viewer grabbed (a burst nobody grabbed from adds nothing). Every question a viewer staked on since the last roll gives them one chance, whatever they staked.
At the end of your stream, open the Control Deck between runs and press Roll now twice: the roll plays full screen in your game and one viewer wins the whole pot. Or Keep for next stream to carry it over. MasuCompanion keeps no Masurium: everything in the pot goes back to viewers.
Swipe sideways to see the whole screen.
End of stream · Masuary rolls the jackpot
90 Masurium
9 chances from 6 viewers who made a call
iwolfking wins 90 Masurium!
A new jackpot starts with the next question nobody calls · click to close
Solo vaults
Vaults that are played solo
Some vault types get no MasuCompanion at all: Greed (the Greed Trial and challenge crystals), Herald, Architect, Speedrun, Time Trial, Paradox, Ascension, Personal Vault, Royale and PvP.
You get one line on screen when you enter one and your viewers' overlay says the vault is played solo. Nothing in it counts as a run, but viewers keep earning for watching and the meter keeps filling. A normal vault with a Greed theme plays normally.
Spotlight squad
Who gets a seat
Each run's squad has three seats, picked when you enter the portal room among the viewers active in the last 10 minutes:
- MVP: the best engagement score in your last finished run.
- Two lucky draws: every viewer is in the draw. Watching runs without a seat raises their chance, and so does a good score. Bits and subs do not buy seats.
- After a seat a viewer rests for two runs. When too few viewers are watching to fill the seats, resting viewers can still be drawn.
Viewers always see their own chance for the next squad on their overlay.
Dashboard
Your dashboard
| Section | What is there |
|---|---|
| Home | Live status, the current run, notices |
| Setup | The setup steps above |
| Connections | Servers you play on, requests and invites, your personal key, linked Minecraft accounts |
| Gameplay | Which systems run on stream, default spice, vote cadence, meter size, cooldowns, loot bursts and rewards |
| Predictions | Stake limits (10 to 500 Masurium by default), run time brackets and every question you can switch off |
| Fate effects | Effects you allow, within what the server allows |
| Season & shop | Season length and end, the cosmetics shop rotation |
| Stream test | Simulated votes and meter on your overlay and HUD |
| Runs | Every run with its votes, winners, outcome, top viewers and season trends |
| Viewers | Moderation |
Seasons last 8 weeks by default. At the end, levels reset to 1 and viewers gain prestige; Masurium, stars and cosmetics stay.
Viewers
Moderate your channel
Under Viewers you can ban a viewer from MasuCompanion in your channel for a set time or until you lift it (they cannot vote, predict, grab gems, emote, shop or sit in the squad, and they leave your public leaderboards), reset a companion's Masurium, XP or stars, and revoke a cosmetic and restore it later. Every action is logged with who did it.
Server owners
Run MasuCompanion on your server
- Register your server in the dashboard and accept the server terms (no paywalled participation, follow Twitch's rules, keep the mod updated).
- After approval, create the server key on your server page. It is shown once.
- Install the mod on the server and connect it: set the key in
config/masucompanion-common.toml, or run/masucompanion server connect <key>as an operator or from the console. - Accept streamers who request access, or invite them by Twitch name.
- Under Rules and Settings, choose the effects you allow, the highest spice, which systems run and what other players see. Streamers can only narrow what you allow.
Players on your server never need the mod; only streamers do. Running several servers behind a Velocity proxy? Group them into a network: one membership then covers every server in it.
Troubleshooting
When something is off
| Problem | What to do |
|---|---|
| Nothing happens in vaults | Open the Control Deck: the server must be connected, your Minecraft account linked and your channel accepted on this server. The client mod must be installed in your game. |
| "Your game is missing the MasuCompanion client mod" | Install the mod in your own game and rejoin. |
| The overlay does not show on stream | Activate the extension as an Overlay and go live. Twitch shows overlays only while you are live. |
| No meter fill or shoutout for Bits or subs | Setup step 1: every Twitch event must be registered. Press Register Twitch events again. |
| The bot does not answer in chat | Make it a moderator. Votes never get a reply, by design. |
| A vault type gets no votes | It may be one of the vaults played solo. |
Questions or problems: MasuCraft Discord.