# Group name

**Repository Path**: zhao2596989641/group-name

## Basic Information

- **Project Name**: Group name
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-08
- **Last Updated**: 2025-05-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Cpp

## README

# GROUP INFO
## GROUP NAME
`📘 Group name`

## GROUP MEMBER
- 🌟 member 1: `Peggy`（汪紫妍）
- 🌟 member 2: `Mercury`（谢小炜）
- 🌟 member 3: `Landy`（赵书炜）

# Class Hierarchy
## Project Structure
- 📁 group-name/
  - 📂 code(code_en, code_zh, code_en_crack)/
    - 📂 include/
      - 📂 character/
        - 📄 PageGuardian.hh
        - 📄 ScrollMage.hh
      - 📂 enemy/
        - 📄 BookThief.hh
        - 📄 ScrollGuard.hh
        - 📄 LibraryElder.hh
        - 📄 ScrollMaster.hh
        - 📄 KnowledgeDragon.hh
      - 📄 ICharacter.hh
      - 📄 Character.hh
      - 📄 Enemy.hh
      - 📄 Item.hh
      - 📄 Room.hh
      - 📄 IO.hh
      - 📄 Game.hh
      - 📄 main.hh
    - 📂 sources/
      - 📜 Character.cpp
      - 📜 Enemy.cpp
      - 📜 Item.cpp
      - 📜 Room.cpp
      - 📜 IO.cpp
      - 📜 Game.cpp
      - 📜 main.cpp
    - 📄 CMakeLists.txt
  - 📄 README.md
  - 📄 outline.md
  - 📄 Classes_Documentation.md
  - 📄 update_logs.md
  - 📄 LICENSE

---

## ICharacter Class
- **🔍 getName()**: Returns the character's name.
- **❤️ getHealth()**: Gets the current health value.
- **🛠️ setHealth(unsigned newHealth)**: Sets the character's health value.
- **🗡️ takeDamage(unsigned damage)**: Applies damage to the character, reducing their health.

## Character Class
- **🌟 Character(const std::string& name, unsigned level, unsigned health, unsigned attackPower, unsigned defense, unsigned speed)**: Constructor that initializes the character's attributes.
- **🌐 addExp(unsigned addExp)**: Adds experience points to the character.
- **👀 isAlive()**: Checks if the character is alive (health greater than 0).
- **🔮 useSkill1(ICharacter& target)**: Uses Skill 1 on the target (must be implemented in derived classes).

## Enemy Class
- **👾 Enemy(const std::string& name, unsigned health, unsigned attackPower, unsigned defense, unsigned speed, unsigned exp, unsigned shield = 0)**: Constructor that initializes the enemy's attributes.
- **🛡️ takeDamage(unsigned damage)**: Handles damage to the enemy, considering shields and defense.
- **💫 revive()**: Revives the enemy, restoring half of their maximum health.

## Room Class
- **🚪 Room(const std::string& name, const std::string& description, bool hasSkillRestriction = false, double speedPenalty = 1.0)**: Constructor that initializes room information.
- **👹 addMonster(ICharacter* monster)**: Adds a monster to the room.
- **🧹 removeDeadMonsters()**: Removes all defeated monsters from the room.

## Item Class
- **🎁 Item(const std::string& name, const std::string& description, float effectValue, unsigned quantity = 1)**: Constructor that initializes item information.
- **🌟 use(ICharacter* character)**: Defines how the item interacts with a character (must be implemented in derived classes).

## IO Class
- **👔 getPlayerName()**: Prompts the player to input their name and returns it.
- **📊 displayCharacterStatus(ICharacter* character)**: Displays detailed status information about the character.
- **⏳ waitForPlayer()**: Waits for the player to press Enter to continue.

## Game Class
- **🔄 initialize()**: Initializes the game state, including creating the player, rooms, and enemies.
- **🏁 run()**: Starts the main game loop, managing turns, battles, and player actions.
- **⚔️ enterCombatMode()**: Enters combat mode, preparing the player and enemies for battle.
- **🎮 handlePlayerTurn()**: Handles the player's actions during their turn.
\* Regarding the detailed explanation of the class, please refer to the `Classes_Documentation.md` document.

---

# Outline
## 📘 Void Library Text RPG  
A Strategy-Based Adventure Game  

---

## 🎮 Game Overview
**Genre**: Text-based RPG  
**Objective**: Restore order to the collapsing "Void Library" by defeating the Knowledge Dragon and overcoming environmental challenges.  

---

## 📚 Story  
You find yourself in the **Void Library**, a transcendent sanctuary where bookshelves float in non-Euclidean space. Each book is a living entity of knowledge, rewriting itself endlessly. However, the library’s indexing system has malfunctioned, threatening to fragment all knowledge into chaos. As the sole savior, you must explore rooms, collect magical items, defeat monsters, and restore balance to this sacred realm.  

---

## 🏆 Winning Conditions  
1. **Main Goal**:  
   - Reach the **End Realm** and defeat the **Knowledge Dragon**.  
2. **Hidden Challenge**:  
   - Collect specific items from **Library Elder** and **Scroll Master** to unlock the **Easter Egg Room**, which grants powerful bonuses.  
   - Use the **Resurrection Potion** (only available in the Easter Egg Room) to revive yourself if you perish in the final boss battle.  

---

## 🌟 Key Features  
### 1. Character System  
Choose between two protagonists:  
#### **A. Page Guardian**  
- **Base Stats**: High HP, moderate Attack, low Defense, average Speed (1 action per turn).  
- **Skills**:  
  - **📚 Scroll Empowerment** (4-turn cooldown): Boosts attack power by 20% this turn.  
  - **🌀 Mana Bind** (3-turn cooldown): Paralyzes enemies for 1 turn.  
#### **B. Scroll Mage**  
- **Base Stats**: Moderate HP, low Attack, average Defense, high Speed (2 actions per turn).  
- **Skills**:  
  - **🌪️ Scroll Burst** (3-turn cooldown): Deals three consecutive attacks.  
  - **🐌 Slow Curse** (5-turn cooldown): Reduces enemy speed by 25% for 3 turns.  

---

### 2. Enemy Design  
#### **Common Enemies**  
- **📖 Page Thief**: Steals magical scrolls with a chance during attacks.  
- **📜 Scroll Guardian**: Steals ancient scrolls with a chance during attacks.  
#### **Elite Enemies**  
- **👴 Library Elder**: Uses **🛡️ Wisdom Shield** (4-turn cooldown) to absorb damage.  
- **📚 Scroll Master**:  
  - **🌪️ Scroll Storm** (3-turn cooldown): Deals multiple hits.  
  - **🌀 Mana Drain** (4-turn cooldown): Reduces player’s attack power for 2 turns.  
#### **Final Boss**  
- **🐉 Knowledge Dragon**:  
  - High HP/Attack/Defense.  
  - Skills:  
    - **🔥 Dragon’s Breath** (4-turn cooldown): Massive damage.  
    - **👁️ Knowledge Gaze** (4-turn cooldown): Paralyzes the player for 2 turns.  

---

### 3. Room Design & Environment Mechanics  
Explore 9 interconnected rooms with unique challenges:  
| Room Name           | Special Mechanics                                                                 | Items/Enemies                          |  
|---------------------|-----------------------------------------------------------------------------------|----------------------------------------|  
| **📚 Scroll Room**  | Normal room.                                                                     | 2 Scroll Guardians, ancient scrolls.   |  
| **📖 Book Room**      | Normal room.                                                                     | 2 Page Thieves, magic scrolls.         |  
| **🌀 Forgotten Corridor**| Boss room.                                                           | 1 Page Thief, 1 Scroll Guardian, Elder |  
| **⏳ Time Distortion Room** | Boss room.                                                        | 1 Scroll Master, Elder.                |  
| **🎉 Easter Egg Room** | **No enemies**. Reward room with powerful items.                                  | 10 Ancient Scrolls, 10 Magic Scrolls, 5 Health Potions, 2 Strength Potions, 2 Agility Potions, 1 Resurrection Potion. |  
| **🏰 End Realm**       | Final battle against the Knowledge Dragon.                                       | 1 Knowledge Dragon.                    |  

#### **map**
```
📚 Scroll Study 1  
         │  
  📖 Book Room 1 ── 🌀 Forgotten Corridor ── 📚 Scroll Study 2 ── 📖 Book Room 2 —— 🎉 Easter Egg Room  
                                │                      │  
                          🛌 Rest Room  ──  ⏳ Time Warp Chamber  
                                │  
                  🗼 Tower of Babel Dictionary  
```

---

### 4. Item System  
- **Consumables**:  
  - **🧚‍♂️ Health Potion**: Restores HP.  
  - **💪 Strength Potion**: Boosts attack by 50% for 2 battles.  
  - **🏃‍♂️ Agility Potion**: Doubles speed for 2 battles.  
  - **🧚‍♂️ Resurrection Potion**: Revives the player once (only in Easter Egg Room).  
- **Essential Items**:  
  - **📜 Magic Scrolls**: Required for skills.  
  - **📚 Ancient Scrolls**: Required for advanced skills.  

---

## 🎯 How to Play  
1. Move between rooms via menu-based navigation.  
2. Manage inventory, use items, and cast skills strategically.  
3. Adapt to room-specific mechanics (e.g., speed reduction, skill restrictions).  
4. Defeat enemies through combat turns, considering cooldowns and status effects.  

---

## 🛠️ Compilation and Execution  
### Compilation Steps  
This project uses **🔧 CMake** and **🗂️ MinGW** toolchain to generate an executable file. Below are the steps to compile:  
1. Open a terminal and navigate to the project's root directory.  
2. Run the following command to generate build files:  
   ```bash
   cmake -G "MinGW Makefiles" -B build
   ```  
   - `-G "MinGW Makefiles"`: Specifies generating MinGW-compatible Makefile files.  
   - `-B build`: Specifies that the generated build files will be stored in the `build` directory.  
3. Run the following command to compile the project:  
   ```bash
   cmake --build build
   ```  
   - This command generates the final executable file `program.exe` in the `code` directory.  
   
### Running the Program  
Run the generated executable file:  
   ```bash
   ./program.exe
   ```  
   - Once the program starts, follow the in-game prompts to begin your adventure!  

### Note
The Chinese version `/code_cn` of this project is still under development and is not yet complete. It is only for preliminary development use. The English version `/code_en` and the cracked English version `code_en_crack` have been fully developed. Please feel free to experience them.