A tool to customize the chat wheel of Valve's game Deadlock:
- Create custom chat wheel menus. Name, icon and contents can be customized.
- Unlock voice commands that are normally not bindable.
- One click to generate an add-on VPK file, ready for use in the game.
- Share configs with your friends or online! You can directly load the VPKs, without needing to extract.
- Graphical interface for easy use, as well as a command-line tool for nerds.
- Deadlock is in early alpha, so this tool and add-on may stop working at any moment.
- As the tool edits a game file (specifically a script file), I am not responsible for any bans for users of this tool. Valve does not have a clear stance on what's fair game when it comes to modding Deadlock yet!
- Due to a game bug, whenever the game updates (and
gameinfo.gifile is reset), opening the chat wheel can crash your game! You must either patch thegameinfo.giagain (as described below), or go to chat wheel options and remove custom menus.
To get ChatLane, download the latest release's zip archive.
Extract everything somewhere, then run the ChatLane-GUI.exe file.
Note
On Linux, you can run ChatLane through Wine/Proton.
On the left half of the program, you have an overview of all voice commands in the game. By default, not all of them can be used in the game, but you can change this. After enabling edit mode (toggle button at the top), you can pick which of them can be configured in the chat wheel (left checkbox) and for keyboard shortcut binding (right checkbox).
On the right half of the program, you can define custom menus. Create a new menu, give it a name and icon, then you can decide what voice lines should be inside. Use drag and drop from the left list onto the right box to assign voice lines to the menu. You can also use drag and drop to re-arrange the elements inside the list. When in-game, you will see the new custom menus you've created at the bottom of the "Chat Wheel" settings.
In order to be able to see your changes, you must set up your Deadlock for modding.
Click here to learn how to install add-ons for Deadlock.
- Open the game folder (right-click on the game in Steam -> Manage -> Browse local files).
- Go to
game/citadeland opengameinfo.giin a text editor. - Near the top of the file should be a block called
SearchPaths. Replace it so that it looks like this:
SearchPaths
{
Game citadel/addons
Mod citadel
Write citadel
Game citadel
Write core
Mod core
Game core
}
Note that you will have to do this step every time a major patch for the game comes out.
- Still in the
game/citadelfolder, create a new folder calledaddons(if it does not exist yet).
You can now install add-ons for Deadlock by placing pakXX_dir.vpk files into the addons folder.
The XX numbers usually don't matter, as long as you start with 02 and keep counting up for each new add-on you install.
Once done, ChatLane can directly save pakXX_dir.vpk files without any intermediate steps! Just place it in the addons folder and you're done.
Open the game's settings and go to the Chat Wheel tab. This should now feature your new custom menus at the bottom, as well as any hidden voice commands you've decided to enable.
If you later want to edit your config, you can simply load the VPK file again, do your changes, then save and overwrite it.
To uninstall the add-on, you can rename or delete the VPK file. You MUST also enter the chat wheel settings and unbind any custom entries! Failing to do so will cause the game to crash when opening the chat wheel.
Entries in this list can not be fixed easily, due to how the chat wheel system of Deadlock works. The list will be updated as Valve fixes them.
- Opening the chat wheel can crash the game in following scenarios:
- A game update caused the
gameinfo.gifile to reset. Use a mod loader or manually check thatSearchPathsare up-to-date. - You removed a custom menu without unbinding it from the game's chat wheel settings.
- You uninstalled the add-on, but did not unbind custom menus from the game's chat wheel settings.
- A game update caused the
- A custom menu can only have up to 12 entries, filling up the entire circle.
- Custom menu order of items is reversed when you are on the Sapphire team.
- Having multiple menus on the wheel causes the menu to show incorrect contents.
- Menus sometimes open in the wrong direction, making them unusable. Simply bind them to another direction.
- Some custom menu items can't be selected depending on which slot the chat wheel is bound to. See #58 for a workaround.
- A placeholder voice line plays when you select a custom menu (when not selecting one of its entries).
For any other bugs, it's either an issue with ChatLane, or a new game update broke the add-on. In either case, feel free to open an issue so that we can figure it out!
This section is for all the developers, contributors and reverse-engineers among you.
CLI: A bridge that converts between a human-readable interchange YAML config format, and a fully bundled VPK add-on which can be loaded as-is into Deadlock.GUI: A layer on top of the CLI which allows for graphical modification of the config.tools: Scripts for building and deploying.
Only Windows builds are supported, since that is all I currently have access to. Contributions are welcome, and I will try my best to help with any issues encountered!
The script tools/prepare_build.ps1 prepares all projects and builds them in the same way as the release zip archives.
The result can be found in the build folder which will be generated in the repository root.
If you only wish to compile a part of the project (e.g. just the CLI or just the GUI), look inside the prepare_build script.
You will need .NET 8 SDK or newer installed. No further preparation is needed.
You will need to place Godot executables so they can be discovered by the tooling. Make sure to also rename them to conform to the following file names:
ChatLane
GUI
bin
windows
executables
godot.windows.editor.x86_64.console.exe
godot.windows.editor.x86_64.exe
godot.windows.template_release.x86_64.console.exe
7701
godot.windows.template_release.x86_64.exe
You must use Godot 4.4 or newer.
For the releases of ChatLane, a build profile was used. This step is fully optional, but it helps to reduce the export template file size slightly:
scons target=template_release build_profile="GUI/GUIdot.build"
- None of the UI strings are translated.
- Open the GUI project in Godot (see instructions above for executable download) and launch the project with F5. Then re-run the
prepare_build.ps1script.
- Open the GUI project in Godot (see instructions above for executable download) and launch the project with F5. Then re-run the
- Compiling the CLI shows warnings.
- These are expected, see #1 for cleaning them up.
- Compiling the CLI shows duplicate errors related to AssemblyInfo.
- Delete all
binandobjfolders inside the CLI folder (and sub-folders), then try again.
- Delete all
- Compiling the GUI shows errors.
- Some errors are expected, due to how Godot loads the editor headless, or due to the fluent add-on. Simply check if the export succeeded, and if the app works as expected, without worrying much about the error logs.
- ValveResourceFormat (MIT) for the very helpful Source 2 Viewer and KV3 library
- ValvePak (MIT) for VPK library
- SourceIO (MIT) for binary KV3 writer
- Godot Engine (MIT) for being a great cross-platform GUI toolkit
- YamlDotNet (MIT) and godot_rust_yaml (Apache 2.0) for YAML support
- FontAwesome Free (CC-BY 4.0) for some icons in the GUI
- Montserrat (OFL) font
- Deadlock Modding Discord for CSDK
- 9joao6 for the ChatLane logo and custom menu preview UI
- Valve for Deadlock