README.md

🛡 Hexawar.io

⚠️ This project was made for school with a deadline and I chose to leave it as it was at the time of submission ⚠️

This project is a massively multiplayer game that runs directly on the browser, it takes up the concept of .io games: everyone plays on a large map and the goal is to be the first of the global ranking. It is a simple land capture game where you can attack other territories with your troops.

The game is available on Hexawar.io.

📋 Summary

• 📋 Summary
• 🎮 How to play?
• 🛠️ Install
  • 📦 dependencies
  • ⚙️ Setup
  • 🚀 Run
• 🙏 Credits

🎮 How to play?

First, choose a name and a color (or a skin if you had any) for your player.

Then, you will get a cell in the map, this 10 troops.

You can use theses troops to expend your territory, by clicking on cells around you.

You can also use them to attack other players and beat them in the global ranking.

🛠️ Install

📦 dependencies

• NodeJS
• npm
• MongoDB

Windows :

• NodeJS and npm : install here.
• MongoDB : install here.

Unix :

$ sudo apt install nodejs
$ sudo apt install npm
$ sudo apt install mongodb

⚙️ Setup

• Add a file named .env in the root of the project with :

TOKEN_SECRET=<random long string>
MONGODB_URL=<your mongodb url>/hexawar
MONGODB_USER=<user> #optional
MONGODB_PASSWORD=<password> #optional

• Install the dependencies with npm install

• Compile typescript files with npm run build (or npm run devBuild for real time compilation)

🚀 Run

Default :

$ npm run start

Dev :

$ npm run dev

Server :

$ npm run fstart

(Stop the server with : npm run fstop).

🙏 Credits

• Angel Uriot : Co-creator of the project.
• Arthur Azambre : Co-creator of the project.
• Gaétan Renard : Co-creator of the project.
• Pierre Surer : Co-creator of the project.
• Thomas Mostowfi : Co-creator of the project.