Dojo

🚀 Beast Battle Game

A dojo game where players attack a beast to gain XP and level up. The beast becomes stronger after each level-up.

🚀 Quick Start

Prerequisites

• dojo
• scarb
• katana

Installation

1. Clone the repository.
2. Navigate to the repository directory.
3. Run the installation command.

# Example installation command
npm install

Running the Game

Step-by-step Instructions

1. Migrate Contracts:

   scarb run -- cairo-migrate
   

2. Initialize the Game:

   scarb run -- initialize-game
   

3. Create a Player Character:

   scarb run -- create-player "Player Name"
   

4. Attack the Beast:

   scarb run -- attack-beast
   

5. Level Up the Character:

   scarb run -- level-up
   

✨ Features

• Player Registration: Players can register to participate in the game.
• Beast Attack: Players can attack the main beast, causing damage and earning XP.
• Character Leveling: Players can level up their characters to increase their attack power.
• Beast Strengthening: After defeating the beast, it levels up and becomes stronger.
• Token Rewards: Players can earn BEAST tokens through attacks and level-ups.

The beast gains more HP and attack power after each level-up, providing a more challenging gaming experience.

📚 Documentation

Game Mechanics

• Beast: A central monster with HP, level, and attack power.
• Player: Each player has XP, level, and attack power.
• Attack: Players can attack the beast, with a cooldown period between attacks.
• XP System: Players earn XP based on the damage they deal to the beast.
• Leveling: Both players and the beast can level up, increasing their attributes.
• Token Rewards: Players earn BEAST tokens through attacks, level-ups, and completing tasks.

Game Commands

• initialize-game: Initialize the game environment.
• create-player "name": Create a player character, with the parameter being the player's name.
• attack-beast: Attack the beast.
• level-up: Level up the character.
• migrate-contracts: Migrate smart contracts.

Token Rewards

• BEAST Tokens: The main incentive tokens in the game.
• Earning Methods:
  • Earn rewards by attacking the beast.
  • Earn rewards by successfully leveling up.
  • Earn rewards by completing tasks.

Testing

# Run the test suite
sozo test

Project Structure

• models.cairo: Define data models.
• systems/beast_battle.cairo: Implement game logic.
• systems/token.cairo: Implement the ERC20 token contract.
• tests/test_beast_battle.cairo: Contain test cases.
• lib.cairo: Export modules.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for details.