How to Review and Understand the Project

Introduction

This document provides a guide on how to effectively review, understand, and contribute to the "Do It for the XP" project. It outlines the key areas to focus on, the tools available, and best practices to follow.

Steps to Review the Project

1. Familiarize Yourself with the Wiki

• Start with the XP.wiki folder, which contains detailed documentation about various features and systems.
• Key pages to review:
  • Battle System.md: Explains the mechanics and implementation of the battle system.
  • Temple System.md: Details the temple mechanics and their integration.
  • Difficulty Levels.md: Provides insights into how difficulty is scaled.

2. Explore the Codebase

• The src/ directory contains the main application code.
• Key folders to review:
  • views/: Contains Vue components for the UI.
  • lib/: Includes utility functions and services like the BattleService.
  • store/: Manages application state using Vuex.

3. Use Development Tools

• The BattleroomDevTools component provides a dedicated UI for testing and debugging the battle system.
• Run the development server with:

  npm run battleroom:serve
  

• Access the tools at /dev/battleroom in your browser.

4. Run Tests

• Use the battleroom-specific test suite to validate changes:

  npm run battleroom:test
  

5. Understand the Architecture

• Review the vue.config.js and battleroom.config.js files for configuration details.
• Check the BattleService in src/lib/services/battle/ for core battle logic.

6. Follow Best Practices

• Use the BattleroomTestUtils for programmatic testing of battle logic.
• Refer to the README.md files in various directories for additional context.

Tips for Understanding the Codebase

• Look for comments and documentation within the code.
• Use the BattleroomDevTools to simulate battles and observe the system in action.
• Refer to the XP.wiki for high-level explanations and examples.
• Use VS Code's search functionality to find usages of specific functions or components.
• Use the debugger to step through the code and understand the flow of execution.

Key Areas to Focus On

1. Battle System

• Components: BattleField.vue, XpFabBattleActions.vue
• Services: BattleService.ts, BestiaryService.ts
• Store: store/mutations.ts (battle-related mutations), store/actions.ts (battle-related actions)
• Utils: BattleroomTestUtils.ts

2. Task and Quest System

• Components: MyTask.vue
• Services: (if any)
• Store: (task/quest related mutations and actions)

3. User Interface

• Components: Examine the components in the views/ directory to understand how the UI is structured.
• Styling: Look at the styles/ directory to understand the project's styling conventions.

Contributing

• Follow the project's coding standards and guidelines.
• Document any new features or changes in the wiki.
• Run tests before submitting a pull request.
• Ensure your code is well-commented and easy to understand.

By following this guide, you should be able to effectively review, understand, and contribute to the "Do It for the XP" project.