A dungeon crawler game made with React!
Play the game!

Table of Contents

1. About The Project
   • Built With
   • Technologies
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

A roguelike dungeon crawler game made with React!

The main goal was to create a fun little game while getting a deeper understanding of React, TypeScript and web development in the process.

Built With

• React
• TypeScript
• Next.js

Technologies

• 2d-dungeon
• PathFinding.js
• Styled-components

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/totoledao/react-dungeon.git

2. Install dependencies

   npm install

3. Start the development server

   npm run dev

Usage

You can click here to play the game or follow the previous step.

Click on an empty tile adjacent to your character to move there. Diagonal movement is not allowed.

Click on an enemy adjacent to you to attack. Diagonal attacks are allowed.

Have fun!

Contributing

Contributions make the open source community such an amazing place to be, learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Guilherme Toledo - guilherme-toledo@live.com

Project Link: https://github.com/totoledao/react-dungeon