Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/publish-to-auto-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,6 @@ jobs:
tagName: app-v__VERSION__ # the action automatically replaces \_\_VERSION\_\_ with the app version.
releaseName: "App v__VERSION__"
releaseBody: "See the assets to download this version and install."
releaseDraft: true
releaseDraft: false
prerelease: false
args: ${{ matrix.args }}
43 changes: 39 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,42 @@
# Tauri + React + Typescript
# Redox

This template should help get you started developing with Tauri, React and Typescript in Vite.
An unofficial companion desktop application for Rust game server management and monitoring.

## Recommended IDE Setup
## Overview

- [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)
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.

## Key Features

- **Server Management**: Connect to and monitor multiple Rust game servers
- **Team Coordination**: Track team members, locations, and activities in real-time
- **Interactive Maps**: View server maps with monuments, player positions, and custom markers
- **Device Control**: Manage smart switches, alarms, and storage monitors
- **Chat Integration**: Send and receive in-game chat messages
- **Camera Systems**: Monitor and control security cameras
- **Vending Machine Tracking**: Find and monitor vending machines across servers
- **Push Notifications**: Receive alerts for important game events

## Technology Stack

- **Backend**: Rust with Tauri framework
- **Frontend**: React 19 with TypeScript
- **State Management**: Redux Toolkit
- **UI Components**: HeroUI with Tailwind CSS
- **Maps**: MapLibre GL with React Map GL
- **Database**: SQLite with Diesel ORM
- **Real-time Communication**: WebSocket connections
- **Build Tools**: Vite for frontend bundling

## Architecture

The application follows a modular architecture with separate crates for:
- `companion`: Rust+ protocol implementation and server communication
- `database`: Data persistence and schema management
- `fcm`: Firebase Cloud Messaging for push notifications
- `battlemetrics`: Integration with BattleMetrics API
- `token_bucket`: Rate limiting for API requests

## Development

Built using modern development practices with hot reloading, TypeScript support, and comprehensive build optimization for both development and production environments.
4 changes: 2 additions & 2 deletions src-tauri/tauri.conf.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://schema.tauri.app/config/2",
"productName": "Redox",
"version": "0.2.0",
"version": "0.2.1",
"identifier": "com.redox.app",
"build": {
"beforeDevCommand": "npm run dev",
Expand Down Expand Up @@ -37,7 +37,7 @@
},
"active": true,
"createUpdaterArtifacts": false,
"targets": "all",
"targets": ["nsis"],
"icon": [
"icons/32x32.png",
"icons/128x128.png",
Expand Down