on-chain turn-based pvp battling game, (heavily) inspired by pokemon showdown x mugen
designed to be highly extensible
general flow of the game is:
- each turn, players simultaneously choose a move on their active mon.
- moves can alter stats, do damage, or generally mutate game state in some way.
- this continues until one player has all their mons knocked out.
(think normal pokemon style)
mechanical differences are:
- extensible engine, write your own Mons or Moves
- far greater support for state-based moves / mechanics
- stamina-based resource system instead of PP for balancing moves
This repo uses foundry.
To get started:
forge install
forge test
Main entry point for handling Battles. Handles committing, revealing, and executing moves to advance battle state. Stores global state / data available to all players.
General flow:
- p1 commits hash of a Move
- p2 commits hash of a Move
- p1 reveals hash
- p2 reveals hash
- anyone can execute to advance game state
- validator ensures moves are legal at each stage
During a player's turn, they can choose either a Move on their active Mon, or switch to a new Mon.
Validators do auxiliary verification outside of the game engine. They handle additional game ending conditions like timeouts and hook into the Battle's lifecycle, e.g. Battle start and Battle end.
Mons are the player's game pieces. They can each hold a number of Moves and have their own stats as well as a unique Ability. Abilities trigger on switch in, and can also mutate game state.
A Move can mutate game state, e.g. alter stats, deal damage, or attach effects. Moves cost a Mon stamina to use, with stronger moves requiring more stamina. See IMove.sol for the current working interface.
Effects are persistent side effects that alter game state. Effects can be called on several lifecycle hooks during a Battle's execution by the Engine, e.g. during a Mon switching in, at the beginning of a round, etc. See IEffect.sol for the current working interface.