Deadlock Mod Manager

Deadlock Mod Manager

A mod manager for the Valve game Deadlock, built with Tauri, React, and TypeScript.

Download · Report Bug · Request Feature

Table of Contents

1. Screenshots
   • Main Window
   • Mod Details
   • My Mods
   • Mods
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

Screenshots

Click to view screenshots

What's inside?

This monorepo includes the following packages/apps:

Apps

• web: A Next.js web application
• desktop: A Tauri + React desktop application
• api: A Bun + Hono API server

Packages

• @deadlock-mods/database: Prisma ORM wrapper to manage & access the database
• @deadlock-mods/utils: Shared utilities
• @deadlock-mods/eslint-config: ESLint configurations
• @deadlock-mods/typescript-config: TypeScript configurations

Getting Started

Prerequisites

• Node.js >= 18
• pnpm
• Docker (for local database)
• Rust (for desktop app)

Installation

1. Install dependencies:

pnpm install

2. Set up environment variables:

cp .env.example .env

3. Run the migrations:

pnpm db:migrate:deploy

4. Run the API server:

pnpm api:dev

5. Run the desktop app:

pnpm desktop:dev

Development

To develop all apps and packages:

pnpm dev

Features

• Cross-platform desktop application (Windows, macOS, Linux)
• Modern UI with shadcn/ui
• Database integration with Prisma
• Type-safe development with TypeScript
• Consistent code style with ESLint and Prettier

Roadmap

• Prepare first release

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

(back to top)

License

This project is not affiliated with Valve. Deadlock, and the Deadlock logo are registered trademarks

Acknowledgments

This project was only possible thanks to the amazing open source community, especially:

• Gamebanana API
• Phosphor Icons
• React Icons
• shadcn/ui
• Tauri
• Hono
• Bun
• Prisma
• shadcn/ui

(back to top)