tchojnacki/scripting-tanks

Online real-time multiplayer game. Final project for the Script Languages university course. Rebuilt in C#. 🏫

Tanks - online real-time multiplayer game 🎮

Task 🏫

Requirements 📝

This project was created for the Script Languages university course. The goal was to create an advanced Python application, following these requirements:

• In the case of a full-stack application, Python should cover as much of the codebase as possible.
• It should follow the rules of SOLID, DRY, CQS, and POLA.
• The project should be a usable product and it should be useful for an end user (see Motivation).
• The project must contain a (preferably graphical) user interface.
• It should use tools that make deployment easier (e.g. Docker, setuptools, build script).
• It must use a VCS.

Motivation 💪

The main goal of this application was to create a multiplayer game, that can be played with friends, is free, uses three-dimensional effects, can be played from any device, and can be installed in seconds. Surprisingly, there aren't many such games on the market. An obvious solution to the last two points was to create a web app. A website can be accessed from any device and doesn't need any installation at all.

Further work 🚀

After submitting the project, I decided to rebuild it using C#. The choice of Python as the game's main backend language proved to be problematic in terms of performance, safety (caused by lack of static typing), and readability. That's why this repository mainly consists of C# code.

If you want to see the previous Python version, check the repository at the time of v1.0.0 (the "Deadline" release).

Technology 🔧

Backend ⚙️

• C# 10
• .NET 6.0
• ASP.NET
• MediatR
• xUnit
• FluentValidation
• FluentAssertions
• NSubstitute

Frontend 🖥️

• TypeScript 4.6
• React + Immer
• Three.js + React Three Fiber + React Three Drei
• Mantine + Tabler Icons React
• Lodash

Tooling 🧰

• Docker
• Git + GitHub Actions
• Vite
• Prettier

Deployment 🚀

Run using Docker Compose:

docker compose up

The app will be available under localhost:8080.

Alternatively, run the container from Dockerfile yourself.

The app can be deployed to Heroku using the Container framework through heroku.yml & Dockerfile. It can also be deployed to Fly.io, using the provided fly.toml file. While not supported, it should be possible to also run the production mode without Docker, if your software versions are correct.

Architecture 🏗

Authoritative server 🏛️

The game is server-authoritative by design which means the server has a final say over any operation. It stores and computes the locations of all players and is their single source of truth. All of the client messages are validated and it is guaranteed that only legal moves are made, even if a player modifies their client.

Most important classes 🗺️

classDiagram
    direction RL
    class IConnectionManager { <<interface>> }
    class IRoomManager { <<interface>> }
    class ICustomizationProvider { <<interface>> }
    class IMessageSerializer { <<interface>> }
    class IMessageValidator { <<interface>> }
    class IValidator { <<interface>> }
    class IWorld { <<interface>> }
    IConnectionManager <.. WsEndpointMiddleware
    ConnectionManager ..|> IConnectionManager
    ConnectionManager ..> IRoomManager
    ConnectionManager ..> ICustomizationProvider
    ConnectionManager ..> IMessageSerializer
    ConnectionManager ..> IMessageValidator
    PlayerData --o ConnectionManager
    MessageValidator ..|> IMessageValidator
    IValidator <.. MessageValidator
    RoomManager ..|> IRoomManager
    MenuRoom --|> ConnectionRoom
    GameRoom --|> ConnectionRoom
    MenuRoom --o RoomManager
    GameRoom --o RoomManager
    WaitingGameState --|> GameRoom
    SummaryGameState --|> GameRoom
    PlayingGameState --|> GameRoom
    IWorld <.. PlayingGameState
    Entity --o PlayingGameState
    Tank --|> Entity
    Bullet --|> Entity

Loading