Project Name: Jhamela

Short and Sweet Description:

Jhamela is a Unity project demonstrating a core RPG framework using the MadCoreRPG library, featuring a sample Dash Attack mechanic and providing a foundation for creating engaging and customizable role-playing games.

Longer Description:

Jhamela serves as a practical demonstration of integrating and utilizing the MadCoreRPG submodule within a Unity environment. It showcases the library's features, including entity management, stat systems, and potential stat calculations, in a real-world game context. This project includes a sample scene /Assets/Minis/DashAttack/Scene/mainTest.unity where a Dash Attack mechanic is implemented, showcasing how to use the MadCoreRPG stats to drive gameplay functionality. This project aims to provide developers with a starting point for building their own RPG systems, allowing for rapid prototyping and flexible customization.

Key Features:

• Integrated MadCoreRPG Submodule: Leverages the MadCoreRPG submodule for robust stat management and calculations.
• Entity System Example: Demonstrates how to create and manage game entities with configurable stats, used to control the dash attack example.
• Stat Modifiers: Showcases the application of flat, percentage, and override modifiers to stats, which could be used to modify dash attack strength or range.
• Potential Stat Calculations: Illustrates the use of formulas for dynamic stat calculations, potentially used for calculating dash attack damage based on strength.
• Unity Integration: Provides clear examples of how to use MadCoreRPG within a Unity project, including a Dash Attack example.
• Dash Attack Example: A basic gameplay scenario showcasing stat manipulation and entity interaction, specifically a Dash Attack implemented in /Assets/Minis/DashAttack/Scene/mainTest.unity.

Getting Started:

1. Prerequisites:

   • Unity (version compatible with your project)
   • Git

2. Installation:

   • Clone the Jhamela repository:

     git clone [https://github.com/MadCore-Dev/Jhamela.git](https://github.com/MadCore-Dev/Jhamela.git)
     cd Jhamela

   • Initialize and update the MadCoreRPG submodule:

     git submodule init
     git submodule update

   • Open the Jhamela project in Unity.
   • The MadCoreRPG.dll should be located within the Assets/Plugins/DLLs folder. If for some reason it is not, refer to the MadCoreRPG repository: https://github.com/MadCore-Dev/MadCoreRPG for build instructions, and manually place the dll into the plugin folder.

3. Usage:

   • Open the sample scene: /Assets/Minis/DashAttack/Scene/mainTest.unity.
   • Explore the scripts in the Assets/Scripts and Assets/Minis/DashAttack/Scripts folders to understand how MadCoreRPG is integrated and how the Dash Attack mechanic is implemented.
   • Run the scene to see the example gameplay mechanics.
   • Examine the scripts within the DashAttack folder to understand how to define stats, apply modifiers, and handle stat changes using the MadCoreRPG library to develop gameplay features.

Example Code (Dash Attack):

• Within the Dash Attack scripts, you'll find examples of how to:

  • Retrieve and modify entity stats.
  • Use stats to determine dash distance or damage.
  • Trigger stat-related events.

• You will see how to connect the MadCoreRPG library to Unity's components.

Project Structure:

Jhamela/
├── Assets/
│   ├── Minis/
│   │   └── DashAttack/
│   │       ├── Scene/
│   │       │   └── mainTest.unity
│   │       └── Scripts/
│   │           └── ... (Dash Attack scripts)
│   ├── Plugins/
│   │   └── DLLs/
│   │       └── MadCoreRPG.dll
│   ├── Scripts/
│   │   └── ... (general scripts)
│   └── ... (other Unity assets)
├── MadCoreRPG/ (Submodule)
│   ├── ... (MadCoreRPG source code)
├── LICENSE
└── README.md

Contributing:

Contributions are welcome! If you find a bug or have an idea for a new feature, please open an issue or submit a pull request.

License:

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

Contact:

For bug reports or feature requests, please open an issue on GitHub.

Important Notes:

• Ensure that the MadCoreRPG submodule is correctly initialized and updated.
• Refer to the MadCoreRPG README for detailed information about the library's features and usage: https://github.com/MadCore-Dev/MadCoreRPG
• The /Assets/Minis/DashAttack/Scene/mainTest.unity scene is a primary point of reference for understanding the integration between MadCoreRPG and Unity gameplay.
• Explore the Dash Attack scripts to see how stat values are used to drive gameplay mechanics.