Finite State Machine Game

Overview

This repository is a fun exploration of finite state machines, featuring a simple game inspired by the Witcher series. Using JavaScript and the XState library, we model character behavior through potion effects. The machine is built in 3 ways: 1- as a JavaScript object, 2- with class syntax, and 3- using the XState library, offering a hands-on look at finite state machines in action.

🟣 tl;dr: A player tries different potions and ends up in different states (might even die!).

Project Structure
Installation
Usage
Contributing
License

Project Structure

The project is divided into three main parts:

JavaScript Object Implementation (1-js-object.js): This file contains a simple object-based representation of the Witcher character's finite state machine. It includes methods for consuming potions and transitioning between states.
JavaScript Class Implementation (2-js-class.js): This file shows a more structured approach using classes to encapsulate the finite state machine logic for the Witcher character.

The finite state machine directs actions to the appropriate states automatically. Even repeating an action can lead to different states:

Geralt.dispatch("speak");
Geralt.dispatch("consume", mysticMoonshine);
Geralt.dispatch("consume", dragonfireBrew);
Geralt.dispatch("consume", dragonfireBrew);
Geralt.dispatch("wake");
Geralt.dispatch("consume", revitalizingTonic);
Geralt.dispatch("fly");
Geralt.dispatch("consume", revitalizingTonic);

XState Implementation (3-xstate.mjs): This file utilizes the XState library to define the finite state machine as a statechart. It includes actions and guards to handle the transitions between states based on the character's enchantment level.

Live XState Demo

Each part of the project demonstrates a different way to implement the same concept, providing a comparison of approaches.

Installation

To install and run the project, clone the repository and install the required dependencies using npm:

git clone https://github.com/b-amir/fsm-game.git
cd fsm-game
npm install

Usage

After installation, you can execute the different implementations using Node.js:

node  1-js-object.js
node  2-js-class.js
node  3-xstate.mjs

Each script will run the game simulation, simulating the character's behavior based on the finite state machine.

Contributing

Contributions are welcome! Please read the CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

License

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

b-amir/fsm-game