RPG Heroes

RPG Heroes is a C# class library that implements a simple role-playing game (RPG) system. It includes various hero classes, items, and game mechanics.

Project Structure

The project consists of the following main components:

1. Hero Classes:

   • Hero (abstract base class)
   • Mage
   • Ranger
   • Rogue
   • Warrior

2. Item Classes:

   • Item (abstract base class)
   • Weapon
   • Armor

3. Attribute System:

   • HeroAttribute (represents Strength, Dexterity, and Intelligence)

4. Enumerations:

   • Slot (equipment slots)
   • WeaponType
   • ArmorType

5. Utilities:

   • ItemGenerator (generates a list of predefined items)
   • EquipItemsDemo (demonstrates the functionality of equipping items)

6. Custom Exceptions:

   • InvalidWeaponException
   • InvalidArmorException

Features

• Four hero classes with unique attributes and equipment preferences
• Equipment system with weapons and armor
• Level-up mechanics
• Damage calculation based on hero attributes and equipment
• Custom exceptions for invalid equipment operations

Requirements

To build and run this project, you'll need one of the following development environments:

Option 1: Visual Studio Code

• Visual Studio Code
• .NET 6.0 SDK

Option 2: Visual Studio (Windows)

Choose one of the following versions:

Visual Studio Community 2022

• Free for individual developers, open source projects, academic research, education, and small professional teams.
• Download Visual Studio Community

Visual Studio Professional 2022

• For professional developers and small teams.
• Download Visual Studio Professional

Visual Studio Enterprise 2022

• For enterprise-scale development and testing.
• Download Visual Studio Enterprise

Ensure that you have the ".NET Desktop Development" workload installed with your Visual Studio installation.

Additional Requirements

• .NET 6.0 SDK (included in Visual Studio 2022 installations)

Make sure to select the appropriate version based on your needs and licensing requirements. All versions will be capable of building and running this project.

Unit Tests

This project includes a comprehensive suite of unit tests to ensure the correct functionality of all components. The tests are written using xUnit, a popular testing framework for .NET applications.

Test Coverage

Our unit tests cover the following areas:

1. Hero Creation: Verifies that heroes are created with correct initial attributes.
2. Level Up Mechanics: Ensures that hero attributes increase correctly when leveling up.
3. Equipment System: Tests equipping and unequipping weapons and armor, including invalid scenarios.
4. Attribute Calculations: Checks that total attributes are calculated correctly with various equipment combinations.
5. Damage Calculations: Verifies that hero damage is calculated correctly based on attributes and equipment.
6. Display Functionality: Ensures that the hero's display string contains all necessary information.

Demo

The project is primarily meant to be "run" by using the test to ensure functionality. However there a demo is provided which will display potential usage and console output

The EquipItemsDemo class provides a demonstration of the system's functionality. You can run it from the Main method in the Program class:

EquipItemsDemo.Run();

This will create a hero, generate items, attempt to equip them, level up the hero, and display the hero's state at various points.

Contributing

Contributions to improve RPG Heroes are welcome. Please feel free to submit pull requests or open issues to discuss potential changes or additions.

License

This project is licensed under the MIT License - see the LICENSE file for details.