public/traque
1
0
Fork 0
mirror of https://git.rezel.net/LudoTech/traque.git synced 2026-02-09 02:10:18 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
Quentin Roussel
2024-06-11 00:11:39 +00:00
parent 303cc83c54
commit 7d33e60950
2 changed files with 29 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/La_Traque.pdf Normal file
View File

Binary file not shown.

33
readme.md
View File

@@ -1,5 +1,27 @@
# Instructions
## Setup development environment
# The game
## General principle
La traque is a IRL team game where the goal is to catch another team without being catched by another team.
Each team starts with the starting position of the tracked team as well as a picture of them, they don't know who they are being tracked by.
To get the latest known position of the tracked team, a team can update their lastest known position as their own position.
Once the tracked team is captured, the tracked team becomes the team previously tracked by the captured team, the game continues until two teams are left.
Each team has to update their location at a given interval, if they don't, they recieve a penalty.
The game is played in a zone, if a team goes outside of the zone for a given time, they recieve a penalty.
For further information see the pdf in the doc folder.
## The zone
The zone is similar to the one in Fortnite, it is a circle that gets smaller and smaller as the game goes on.
The zone is defined by two circles, the starting zone and the final zone, a number of reductions, the delay between two reductions, and the duration of a reduction.
## The penalties
A penalty can be given to a team for going outside the zone or not updating their position. After 3 penalties a team is eliminated.
# Structure of the app
The app is divided in two parts, a Next.js front end and a Node.js back end.
The front end is divided in a team section and an admin section.
The backend manages the game state and the teams, and communicates with the front end through socket.io
# Setting up the app
## Development environment
### Front end configuration
Edit the .env file in traque-front and add specify the following values:
```
@@ -42,6 +64,9 @@ https://example.com:3000
## Deployment
Put your certificate and private key in the proxy/ssl folder. They need to be named `cert.pem` and `privkey.pem`.
You can then depploy the docker application with `docker compose up`
You can then depploy the docker application with `docker compose up`.
You can change the production environment varialbes for the backend in the docker-compose.yml file. The frontend environment variables can be changed in the .env file in the traque-front directory.
The reverse proxy is used to get https to the next app on port 3000.
# Authors
- [Quentin Roussel](mailto:quentin.roussel11@gmail.com) (initial version)