Deadlock Mod Manager
Table of Contents
<a href="#screenshots">Screenshots</a>
<a href="#usage">Usage</a>
<a href="#sponsors">Sponsors</a>
<a href="#whats-inside">What's inside?</a>
<a href="#development">Development</a>
<a href="#translation--localization">Translation & Localization</a>
<a href="#contributing">Contributing</a>
<a href="#license">License</a>
<a href="#contact">Contact</a>
<a href="#acknowledgments">Acknowledgments</a>
Usage
For detailed installation instructions, getting started guides, troubleshooting, and feature documentation, please visit our comprehensive documentation:
Player Guide - Installation, usage, and troubleshooting
For help and support:
> [!WARNING]
> Linux Support - Limited
>
> Linux support is provided on a best-effort basis. Due to a lack of contributors with Linux expertise and the maintainer's limited experience distributing software across the many Linux distributions, you may encounter packaging issues, missing dependencies, or platform-specific bugs. If you're a Linux user and want to help improve support, contributions are very welcome! Please reach out on Discord or open a PR.
> [!NOTE]
> AUR Releases Temporarily Unavailable
>
> We are currently unable to push new releases to the AUR package. As of late July 2026, the Arch Linux team has restricted AUR package adoptions and related git write access while investigating waves of malicious package adoptions (over 1,500 infected packages removed). Until those restrictions are lifted, AUR packages may lag behind GitHub releases. Please download the latest Linux builds from the GitHub Releases page in the meantime.
Sponsors
Serverless Postgres provided by Neon. Thanks for sponsoring Deadlock Mod Manager!
Free code signing on Windows provided by SignPath.io
Certificate by SignPath Foundation
Tauri tooling and distribution infrastructure provided by CrabNebula. Thanks for sponsoring Deadlock Mod Manager!
Faster CI builds provided by Depot. Thanks for sponsoring Deadlock Mod Manager!
(back to top)
Development
For development setup, project architecture, contributing guidelines, and API integration documentation, please visit:
Development with Nix (Linux only)
For Linux developers, we provide a complete Nix development environment:
# Clone and enter the project
git clone https://github.com/deadlock-mod-manager/deadlock-mod-manager.git
cd deadlock-mod-manager
# Start development shell (or use direnv for automatic loading)
nix develop
# Install dependencies and start
pnpm install
pnpm desktop:dev
The Nix environment includes everything you need: Rust, Node.js, pnpm, Docker, system libraries, and all development tools.
For detailed Nix setup instructions, see CONTRIBUTING.md.
Translation & Localization
🌍 Help us translate Deadlock Mod Manager!
We're actively working to make Deadlock Mod Manager accessible to users worldwide. Join our translation efforts and help bring the mod manager to your language!
Currently Supported Languages
How to Help
All translations are managed on Crowdin. Translations are synced back into this repository automatically via the Crowdin GitHub action, so you don't need to edit JSON files directly.
- Translate on Crowdin: Head to translate.deadlockmods.app and pick your language - approved translations are proposed as a PR automatically
- Join our Discord server: join our Discord server and visit the #translations channel for coordination
- Suggest a new language: Open a request on Crowdin, or file an issue if the language isn't listed there
Translation files are located in apps/desktop/src/locales/ and loaded via react-i18next. Only en.json is edited directly in the repo; all other locales are managed through Crowdin.
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
For comprehensive contributing guidelines, development setup, code style standards, and best practices, please see:
> AI-Assisted Contributions: We welcome AI-assisted contributions! Please review our AI Policy for guidelines on disclosure and quality expectations.
Top contributors:
(back to top)
License
This project is licensed under the GNU General Public License v3.0 - see the LICENSE.md file for details.
Vendored and copied-in third-party source (vpkmerge, ValveResourceFormat, shadcn/ui, and others) is documented in THIRD-PARTY-NOTICES.md.
Disclaimer: This project is not affiliated with Valve Corporation. Deadlock and the Deadlock logo are registered trademarks of Valve Corporation.
Contact
For support and questions, please use GitHub Issues or join our Discord community. We're always happy to help!
Acknowledgments
This project was only possible thanks to the amazing open source community, especially:
Special Thanks
-
GameBanana - Our primary mod source and the backbone of this application. GameBanana provides the comprehensive mod database and API that makes browsing, discovering, and downloading Deadlock mods possible. This project would not exist without their excellent platform and community-driven content.
-
Jelloge/Deadlock-Rich-Presence - Discord Game Presence was only possible thanks to this project and its work mapping Deadlock console log events for rich presence.
-
vpkmerge - Source 2 texture, KV3 and sound codecs used by the Mod Foundry (MIT).
-
ValveResourceFormat - Source 2 resource format research the Foundry's codecs and model preview are adapted from (MIT).
-
RapidRAW - A Tauri project that inspired our CI pipelines, Linux optimizations, and packaging/distribution approach. Thank you for sharing your setup and best practices.
Open Source Libraries
Framework & Build
Backend
UI & Styling
TanStack
Other
(back to top)
