# RubyGame **Repository Path**: Mondeville/RubyGame ## Basic Information - **Project Name**: RubyGame - **Description**: No description available - **Primary Language**: C# - **License**: Not specified - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-08-12 - **Last Updated**: 2026-08-12 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # RubyGame ## Introduction RubyGame is a 2D platform adventure game developed based on the Unity engine, utilizing FlareEngine as the core game engine. The game features the player character Ruby exploring a rich and diverse game world, experiencing various gameplay elements including platform jumping, combat, and puzzle-solving. ## Project Structure ``` Assets/ ├── TwoBitMachines/FlareEngine/ # FlareEngine Game Engine Core │ ├── AssetsFolder/ # Game Asset Folder │ │ ├── Audio/ # Audio Resources │ │ ├── GUI/ # Graphic User Interface │ │ ├── Inputs/ # Input Configuration │ │ ├── Inventory/ # Item System │ │ ├── Materials/ # Material Resources │ │ ├── Prefab/ # Prefabs │ │ ├── Quests/ # Quest System │ │ ├── Tags/ # Tag Configuration │ │ └── Transitions/ # Scene Transition Effects │ └── Demo/ # Game Demo Scenes │ ├── Scenes/ # Demo Scenes │ ├── Sprites/ # Sprite Resources │ └── Audio/ # Demo Audio ├── Palettes/ # Palette Resources ├── Prefabs/ # Game Prefabs ├── Scenes/ # Game Scenes ├── Sprites/ # Sprite Resources ├── TextMesh Pro/ # Text Rendering System └── Tiles/ # Tile Resources ``` ## Core Features ### Character System - **Ruby Protagonist**: Features a rich action state system, including: - Basic Movement (Run, Jump, Crouch) - Advanced Actions (Climb, Wall Cling, Slide) - Combat System (Block, Shoot, Sword Swing) - Special Abilities (High Jump, Rolling Impact) ### Enemy AI - **Robot Types**: Ammo Robots, Bat Robots, etc. - **Melee Enemies**: Red Knight - **Ranged Enemies**: Throwing Mushroom Enemies - **Special Enemies**: Spider, Man-eating Flower, Basilisk, etc. - **Large Enemies**: Cave Troll (Supports Pathfinding) ### Game Systems - **Item System**: Weapons, Consumables, Collectibles - **Quest System**: Quest Tracking, Log Recording - **Save System**: Game Progress Save and Load - **Scene System**: Scene Door Teleportation, World Map ## Quick Start ### Environment Requirements - Unity 2020.3 or higher - Universal Render Pipeline (URP) ### Import Project 1. Open Unity Hub 2. Click "Add" to add the project folder 3. Select the RubyGame project directory 4. Wait for Unity to complete project initialization and asset import ### Run Game 1. Open `Assets/TwoBitMachines/FlareEngine/Demo/Scenes/FlareDemo.unity` in Unity 2. Click the Play button to run the demo scene 3. Or open other demo scenes in `Assets/TwoBitMachines/FlareEngine/Demo/Scenes/TidBits/` ## Keyboard Controls | Key | Function | |------|------| | Arrow Keys/WASD | Move | | Space/C | Jump | | Shift/X | Sprint | | Z/K | Attack/Shoot | | Esc/P | Pause | | Mouse | Interact/Select | ## Scene Directory | Scene | Description | |------|------| | FlareDemo | Main Demo Scene | | FlareDemo2 | Advanced Feature Demo | | TidBits/AIPathfindingOgres | AI Pathfinding Demo | | TidBits/BasicEnemies | Basic Enemies Demo | | TidBits/CannonAbility | Cannon Ability Demo | | TidBits/GrapplingGun | Grappling Gun Demo | | TidBits/ItemBarAndUsage | Inventory Bar Demo | | TidBits/Journal | Journal System Demo | | TidBits/KeyAndDoor | Key and Door Demo | | TidBits/MovingPlatformsSharedPath | Moving Platform Demo | | TidBits/OverworldMap | World Map Demo | | TidBits/SaveMenu | Save Menu Demo | | TidBits/SceneDoors | Scene Door Demo | | TidBits/Teleport | Teleport System Demo | ## Technical Features - **Behavior Tree AI**: Uses visual node design system for enemy behavior - **State Machine System**: Character action state management - **Component-based Design**: Highly modular engine architecture - **Universal Render Pipeline**: Uses URP rendering pipeline - **Shader Graph**: Custom shader effects - **Input System**: New Unity Input System ## Directory Structure Notes - `Assets/Prefabs/`: Basic Game Prefabs - `Assets/Sprites/`: Character, Enemy, and UI Sprite Resources - `Assets/Audio/`: Sound Effects and Background Music - `Assets/TextMesh Pro/`: Text Rendering Resources ## License This project is developed using the FlareEngine engine. Please refer to relevant documentation for specific licenses. ## Contribution Guide We welcome submitting Issues and Pull Requests to improve the project. ## Contact Information Project Address: https://gitee.com/Mondeville/RubyGame