โก THE RUST LABORATORY
A Commercial-Grade Text Adventure Game
Built with Rust + Tauri | Beautiful Cyberpunk GUI
๐ฎ Overview
The Rust Laboratory is a fully-featured text-based adventure game with a stunning cyberpunk-themed GUI. You play as Dr. Alex Chen, an investigative journalist exploring the abandoned Prometheus Research Facility to uncover its secrets.
โจ Key Features
- 14+ Interconnected Rooms - Each with unique descriptions, puzzles, and secrets
- 20+ Collectible Items - With detailed lore and specific uses
- 6 Challenging Puzzles - Code-breaking, item combination, repair challenges
- 13 Achievements - Track your progress and unlock rewards
- Beautiful Cyberpunk GUI - Dark theme with animations, minimap, and particle effects
- Save/Load System - 3 save slots with auto-save support
- Interactive Minimap - Real-time map showing explored areas
- Smart Autocomplete - Context-aware command suggestions
- Command History - Arrow key navigation through previous commands
๐ Screenshots
| Splash Screen |
Game Interface |
| Particle-animated title screen with neon glow |
Three-panel layout: stats, game, inventory |
๐ป Installation
Download (Recommended)
Download the latest release from GitHub Releases:
- Download
RustTextAdventure_x64-setup.exe (or .msi)
- Run the installer
- Launch "The Rust Laboratory" from your desktop
Build from Source
Prerequisites: Rust 1.70+, Node.js 18+, Tauri CLI
git clone https://github.com/Ali-Marandi/RustTextAdventure.git
cd RustTextAdventure
cd src-tauri
cargo tauri build
๐ฎ How to Play
Controls
| Input |
Action |
| Type command + Enter |
Execute command |
| Arrow Up/Down |
Navigate command history |
| Tab |
Accept autocomplete suggestion |
| Escape |
Close modal/dialog |
| Click exit buttons |
Quick navigation |
| Click items |
Interact with items |
Commands
| Command |
Description |
go [direction] |
Move in a direction (north/south/east/west/up/down) |
look |
Examine current room |
take [item] |
Pick up an item |
drop [item] |
Drop an item from inventory |
use [item] |
Use an item |
examine [item] |
Inspect an item in detail |
read [document] |
Read a document |
combine [item1] [item2] |
Combine two items |
solve [puzzle] |
Attempt to solve a puzzle |
inventory |
View your inventory |
map |
View the facility map |
status |
View player statistics |
hint |
Get a contextual hint |
help |
Show all available commands |
Tips
- Read everything - Documents contain crucial clues and codes
- Explore thoroughly - Some exits are hidden until conditions are met
- Combine items - Some puzzles require combining items in specific rooms
- Use
hint - Stuck? The hint command provides context-aware guidance
๐ง Tech Stack
| Component |
Technology |
| Game Engine |
Rust |
| GUI Framework |
Tauri v2 |
| Frontend |
HTML5 / CSS3 / Vanilla JS |
| Styling |
CSS Custom Properties, CSS Grid |
| Serialization |
Serde + JSON |
| CI/CD |
GitHub Actions |
| Target Platforms |
Linux (x86_64), Windows (x86_64), macOS (Intel/Apple Silicon) |
Architecture
RustTextAdventure/
โโโ src-tauri/ # Rust backend (Tauri)
โ โโโ src/
โ โ โโโ main.rs # Tauri commands & app entry
โ โ โโโ game/
โ โ โโโ engine.rs # Core game engine
โ โ โโโ types.rs # Data types & structs
โ โ โโโ world.rs # Room definitions
โ โ โโโ items.rs # Item definitions
โ โ โโโ puzzles.rs # Puzzle definitions
โ โ โโโ player.rs # Player state
โ โ โโโ commands.rs # Command parser
โ โ โโโ story.rs # Narrative & achievements
โ โ โโโ save.rs # Save/Load system
โ โโโ Cargo.toml
โ โโโ tauri.conf.json
โ โโโ icons/
โโโ ui/ # Frontend
โ โโโ index.html
โ โโโ css/style.css
โ โโโ js/app.js
โโโ .github/workflows/ # CI/CD
โโโ release.yml
๐ Achievements
| Achievement |
How to Unlock |
| ๐ถ First Steps |
Enter the facility |
| ๐บ๏ธ Facility Explorer |
Visit 5 rooms |
| ๐ Bookworm |
Find all documents |
| ๐ ๏ธ Puzzle Master |
Solve 3 puzzles |
| ๐ Codebreaker |
Crack the office code |
| ๐งช Amateur Chemist |
Create the Stabilizer |
| โ๏ธ Chief Engineer |
Repair the generator |
| ๐ป Elite Hacker |
Decrypt the files |
| ๐ Facility Savior |
Stabilize the Core |
| ๐ Escape Artist |
Reach the surface |
| โญ Hero |
Complete the game |
๐ Product Delivery and Validation
The global commercial roadmap is available in docs/GLOBAL_COMMERCIAL_ROADMAP_FA.md. The current, Tauri-specific delivery backlog is in docs/EXECUTION_BACKLOG_FA.md, and the landing-page, interview, playtest, and attribution protocols are in docs/VALIDATION_TOOLKIT_FA.md. The release-marketing plan is in docs/GITHUB_RELEASE_MARKETING_PLAN_FA.md. The controlled UTM registry and measurement design are documented in docs/UTM_CAMPAIGN_AUTOMATION_FA.md.
๐งฉ Developer Documentation
The Tauri command contract and frontend integration examples are documented in docs/API.md. New contributors should begin with CONTRIBUTING.md, which includes environment setup, the required quality gate, test conventions, and pull-request expectations. The multi-platform automated release procedure is in docs/RELEASE_PIPELINE_FA.md, and the prioritized Engine/state coverage plan is in docs/TEST_COVERAGE_PLAN_FA.md. The Engine and command regression suite lives in src-tauri/src/game/tests.rs and runs through cargo test --workspace.
๐ License
This project is licensed under the MIT License - see the LICENSE file for details.
Built with โค๏ธ using Rust and Tauri