|
1 | | -# Tauri + React + Typescript |
| 1 | +# Redox |
2 | 2 |
|
3 | | -This template should help get you started developing with Tauri, React and Typescript in Vite. |
| 3 | +An unofficial companion desktop application for Rust game server management and monitoring. |
4 | 4 |
|
5 | | -## Recommended IDE Setup |
| 5 | +## Overview |
6 | 6 |
|
7 | | -- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) |
| 7 | +Redox is a cross-platform desktop application built with Tauri (Rust + React) that provides comprehensive tools for managing and monitoring Rust game servers. It features real-time server communication, team management, map visualization, and device control capabilities. |
| 8 | + |
| 9 | +## Key Features |
| 10 | + |
| 11 | +- **Server Management**: Connect to and monitor multiple Rust game servers |
| 12 | +- **Team Coordination**: Track team members, locations, and activities in real-time |
| 13 | +- **Interactive Maps**: View server maps with monuments, player positions, and custom markers |
| 14 | +- **Device Control**: Manage smart switches, alarms, and storage monitors |
| 15 | +- **Chat Integration**: Send and receive in-game chat messages |
| 16 | +- **Camera Systems**: Monitor and control security cameras |
| 17 | +- **Vending Machine Tracking**: Find and monitor vending machines across servers |
| 18 | +- **Push Notifications**: Receive alerts for important game events |
| 19 | + |
| 20 | +## Technology Stack |
| 21 | + |
| 22 | +- **Backend**: Rust with Tauri framework |
| 23 | +- **Frontend**: React 19 with TypeScript |
| 24 | +- **State Management**: Redux Toolkit |
| 25 | +- **UI Components**: HeroUI with Tailwind CSS |
| 26 | +- **Maps**: MapLibre GL with React Map GL |
| 27 | +- **Database**: SQLite with Diesel ORM |
| 28 | +- **Real-time Communication**: WebSocket connections |
| 29 | +- **Build Tools**: Vite for frontend bundling |
| 30 | + |
| 31 | +## Architecture |
| 32 | + |
| 33 | +The application follows a modular architecture with separate crates for: |
| 34 | +- `companion`: Rust+ protocol implementation and server communication |
| 35 | +- `database`: Data persistence and schema management |
| 36 | +- `fcm`: Firebase Cloud Messaging for push notifications |
| 37 | +- `battlemetrics`: Integration with BattleMetrics API |
| 38 | +- `token_bucket`: Rate limiting for API requests |
| 39 | + |
| 40 | +## Development |
| 41 | + |
| 42 | +Built using modern development practices with hot reloading, TypeScript support, and comprehensive build optimization for both development and production environments. |
0 commit comments