Repository navigation
Install
CrossChat has three parts: the app on your computer, a script in OBS that starts it, and a browser extension. Pick your system below, then add the extension.
You need Windows 10 or 11, 64-bit. The setup program brings its own Python.
- Download
CrossChat-Setup-<version>.exefrom Releases and run it. It needs no administrator rights.- It installs for your Windows account only, in
%LOCALAPPDATA%\CrossChat. - If OBS's WebSocket server is off and OBS is closed, it asks whether to turn it on.
- It adds a CrossChat folder to the Start menu.
- It installs for your Windows account only, in
- Set your channels: Start menu → CrossChat → Open chat → Settings.
- Add the script to OBS: Tools → Scripts → +, then pick
%LOCALAPPDATA%\CrossChat\obs\crosschat.lua. Setup puts this path on your clipboard. - Add the browser extension.
- Add the widgets you want to your scenes.
The setup program is code-signed by Randy Northrup. A newly signed program can still get a "Windows protected your PC" notice until Windows has seen enough downloads of it. Choose More info, check the publisher says Randy Northrup, then Run anyway.
Prefer a zip? CrossChat-<version>-windows.zip is on every release. Extract it and double-click Install.cmd. It uses a Python 3.10 or newer already on your PC, or offers to install one, then asks for your channels in a console window. Continue from step 3.
Installing from a script:
.\CrossChat-Setup-<version>.exe /SYou need macOS 15 or newer, OBS Studio 28 or newer, Chrome, Edge or Chromium, and Python 3.10 or newer from python.org or Homebrew (brew install python@3.13). The python3 that comes with macOS is too old. The installer tells you if Python is missing.
- Download
CrossChat-<version>-mac.zipfrom Releases and double-click it to unpack it. - Run the installer from Terminal, because macOS won't open it with a double-click. Open Applications → Utilities → Terminal, type
bashwith a space after it, dragInstall.commandfrom the unpacked folder into the window, and press Return.- It installs to
~/Library/Application Support/CrossChat. - It adds a CrossChat folder of small apps in the Applications folder of your home folder: in Finder, Go → Home, then Applications → CrossChat.
- It installs to
- Add the script to OBS: Tools → Scripts → +, press Cmd+Shift+G, paste the path the installer put on your clipboard, and press Return.
- Add the browser extension.
- Add the widgets you want.
What differs on a Mac:
- CrossChat's windows are placed, moved and closed by the extension. Without it they open where Chrome puts them and stay open after the stream.
- OBS hotkeys work while another app is in front only once OBS has the Input Monitoring permission in System Settings → Privacy & Security.
- The phone companion stays off until you set its address. See Phone and Second PC.
- Chrome reads chat aloud only once you have clicked in the chat window after it opened.
You need 64-bit Linux with a desktop, Python 3.10 or newer with venv (Ubuntu and Debian: sudo apt install python3-venv), Chrome, Chromium, Edge or Brave, and OBS Studio 28 or newer.
For the widgets, OBS needs its Browser Source. OBS from Flathub and from the OBS Project's PPA have it. Ubuntu's and Debian's own obs-studio package doesn't.
To keep sign-ins you need a desktop keyring and secret-tool (Ubuntu and Debian: sudo apt install libsecret-tools). The installer tells you what's missing.
- Download
CrossChat-<version>-linux.tar.gzfrom Releases and unpack it:tar -xzf CrossChat-<version>-linux.tar.gz
- Run the installer:
It installs to
cd CrossChat-<version>-linux bash scripts/install.sh
~/.local/share/CrossChat, readable by your account only, and adds CrossChat entries to your app menu. - Add the script to OBS: Tools → Scripts → +, press Ctrl+L, enter
~/.local/share/CrossChat/obs/crosschat.lua, and press Enter. - Add the browser extension.
- Add the widgets you want.
What differs on Linux:
- On Wayland no program may choose where a window goes, so the desktop places CrossChat's windows. The extension sets their size and closes them.
- With no desktop keyring, CrossChat keeps no sign-ins at all and says why. It never stores one in plain text.
- To read chat aloud you need speech-dispatcher with a voice, and Google Chrome started with
--enable-speech-dispatcher. - The phone companion stays off until you set its address. See Phone and Second PC.
Twitch, YouTube, Kick and Rumble chat and the on-stream widgets work without the extension. Reading X, TikTok, Facebook and Instagram needs it, as do replies everywhere except Twitch and Kick, and X Live.
Open CrossChat on the Chrome Web Store in Chrome and press Add to Chrome. In Edge, press Allow extensions from other stores on that page first. Chromium and Brave use the same page. It updates by itself from then on.
Load the copy that came with CrossChat. It matches the app you installed, and needs reloading after each update.
- Open
chrome://extensions(oredge://extensions). - Switch on Developer mode.
- Press Load unpacked and pick the folder for your system:
| System | Folder | Tip |
|---|---|---|
| Windows | %LOCALAPPDATA%\CrossChat\extension |
Paste it in the folder box |
| Mac | ~/Library/Application Support/CrossChat/extension |
Press Cmd+Shift+G to type a path |
| Linux | ~/.local/share/CrossChat/extension |
Press Ctrl+L to type a path |
Use the same browser you are signed in to your platforms with. If you have more than one, set browser in Settings to the one with the extension.
The extension asks for no Chrome permissions and reads no logins. See Privacy and Security.
Run the newer download. It keeps your settings, themes, sign-ins and chat history. If OBS is open with CrossChat running, setup stops CrossChat, replaces its files and starts it again.
The extension from the Chrome Web Store updates by itself. If you loaded it unpacked, open chrome://extensions (or edge://extensions) and press the reload arrow on CrossChat. The browser keeps running the old extension until you do, and the chat window says so if it's too old to work.
To be told when a new version is out, switch on the update notice in Settings → About. It is off by default.
- Windows: Start menu → CrossChat → Uninstall CrossChat, or Settings → Apps → CrossChat → Uninstall.
- Mac: Applications in your home folder → CrossChat → Uninstall CrossChat.
-
Linux: Uninstall CrossChat in your app menu, or
bash ~/.local/share/CrossChat/scripts/uninstall.sh.
It offers to keep your settings and themes in a CrossChat backup folder in Documents.
Two things only you can remove: the script in OBS (Tools → Scripts, select it, −), and the extension in your browser.
Every release comes with .sha256 files and a signed build provenance attestation:
gh attestation verify <file> --repo RandyNorthrup/crosschat-obsGet started
Use it
Reference
Help
Developers