An open-source multiplayer browser game!

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Access
3. Contact

About The Project

Dungeon'JS is a browser-based 3D multiplayer game. Built with Three.js and React Three Fiber, the game offers a strategic and engaging dungeon-crawling experience to play with friends.

Features

• Turn-Based Dungeon Exploration: Discover new rooms and strategically plan your movements to maximize your rewards.
• Room Generation: When moving into an undiscovered room, a new dungeon room is generated, possibly hiding treasures, keys, or enemies.
• Dice-Based Combat: Battle enemies by rolling a dice—roll higher than their health points (HP) to defeat them and loot new weapons.
• Treasure Collection: Open locked chests using collected keys to obtain treasures.
• Winning Objective: The game ends when a player defeats the dungeon's most powerful enemy. The player with the most collected treasures wins the game.

Built With

The project is built with three-js and React using the react-fiber wrapper. For the multiplayer part, socket.io is used.

Getting Started

This is a quick start guide to install the application locally.

Prerequisites

You need Docker on your machine to get Dungeon'JS working.

• docker >=20.10.14 is required

How to Install

To install the project on your local machine, you'll need Docker installed. Then follow these steps:

• Clone the repository

git clone git@github.com:Zusoy/dungeonjs.git

• Copy the required .env file

cp -n .env.dist .env

• Build the stack

make build

• Start the project

make start

Access

URL	Link
http://127.0.0.1:3000	Client
http://127.0.0.1:8080	Server

Contact

Project Link: https://github.com/Zusoy/dungeonjs