This repository contains source code for a multiplayer, multi-process football game. It is multiplayer in the sense that multiple users can participate in a single game at the same time, and multi-process in the sense that the application can run multiple games concurrently. The project is written in Typescript, and is run on a node server with very few dependencies on the backend. A more in depth review of the architecture is not yet available.
Some prerequisites before running the game locally:
- Install git and update it if you haven't already. Instructions here.
- Install docker. Instructions here.
To get the game running locally, open your terminal / command line. Then clone this repository to get all the code, by typing in the following command:
git clone https://github.com/Dirichi/football.git
Next, cd into the directory where the code has been downloaded
cd football
Create a new file called .env and copy the contents of .example_env into it.
cp .example_env .env
Feel free to change the passwords / secrets in .example_env to your own preferences.
Then run the game using docker-compose.
docker-compose up
You should see some output on your terminal while the app compiles in preparation for running. Eventually you see something like server started at http://localhost:3000.
When you see this, open chrome and visit localhost:3000. Wait for about 5 seconds for the game to actually start and try out the direction controls to control whichever player has a blue cursor on their head!
This project is liberally tested (lol). To run tests:
npm run test
- Check out tutorialspoint for a Typescript tutorial.
- Check out p5js to learn about animation on the web.
- Checkout w3schools for a tutorial on nodejs.