Developer Documentation
Overview
Setup, architecture, contribution and API guides for Deadlock Mod Manager developers
Developer Documentation Overview
Development Setup
Set up your development environment to start contributing
Development with Nix
Reproducible development setup for Linux using Nix flakes
Project Structure
Understand the codebase organization and architecture
Architecture
System design and technical decisions
Contributing
Learn how to contribute code, documentation, and translations
API Integration
Base URL, mod routes and error format
Build a mod registry
Publish a mod source with taxonomy, variants, install buttons and updates
Getting Started
Contributing code
- Set up your development environment (or use Nix on Linux)
- Understand the project structure
- Read the contributing guidelines
- Start with a good first issue on GitHub
Understanding the system
- Review the project structure
- Study the architecture documentation
- Explore the interactive API documentation
API integration
- Browse the interactive API reference
- Read the integration guide
- Join our Discord for developer support
Key Technologies
- Desktop: Tauri v2 with a Rust backend and a React 19 frontend using TypeScript and Tailwind CSS v4
- Backend: Bun with Hono and oRPC
- Database: PostgreSQL with Drizzle ORM
- Cache and pub/sub: Redis
- Build system: Turborepo