Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/niewidzialny84/pathfighters
Path Fighters is a Tower Defense versus game as online module.
https://github.com/niewidzialny84/pathfighters
flask game python study-project unity
Last synced: 19 days ago
JSON representation
Path Fighters is a Tower Defense versus game as online module.
- Host: GitHub
- URL: https://github.com/niewidzialny84/pathfighters
- Owner: Niewidzialny84
- License: mit
- Created: 2021-08-17T15:30:30.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-28T00:31:31.000Z (almost 3 years ago)
- Last Synced: 2023-08-19T02:54:02.053Z (over 1 year ago)
- Topics: flask, game, python, study-project, unity
- Language: C#
- Homepage:
- Size: 81.8 MB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PathFighters
[](https://github.com/Niewidzialny84/PathFighters/actions/workflows/python_api_test.yml)
[](https://github.com/Niewidzialny84/PathFighters/actions/workflows/api-container.yml)
[](https://github.com/Niewidzialny84/PathFighters/actions/workflows/server-api-container.yml)
## About
PathFighters is a game with login system and REST API with multiplayer gameplay where you face other player in a duel. Games takes aproximatly 15 minutes. Game core is three lanes and two bases where one belongs to you and other to oponent that you joined to. You can choose from variety of minions/soldiers to attack or place towers to defend yourself from oponent. Each unit has different stats and abilities as well as price. Also there is possibility to upgrade your units and towers under uprade menu. Main goal is to take down oponent base and win the game.
Game was made as a part of university project.
### Used technologies
Here is a list of technologies used in this project:
- Python 3
- Unity with C# Scripts
- Mirror Networking for Unity as synchronization tool
- Flask
- SQLAlchemy
- Swagger API documentation for better understanding of API
- Pytest
- Docker
- Docker Compose
### How to run game
To run the game simply install it with the provided setup file and run the created .exe file. To register you need to have a password which is at least 8 symbols long and contains at least 1 lower case and 1 upper case letter, a digit and a special symbol.
### Description of game
Here is a brief description of the game elements that can be found while playing the game.
1. Player 1 health points
2. Current gold that is different depending on player
3. Time left to finish finish the research
4. Player 2 health points
5. Lanes that can be used to send units by selecting unit in the box and clicking on the lane
6. Towers that can be placed and removed
7. Units that can be created
8. Towers that can be build
9. Avaible researches
10. Player 1 base
11. Player 2 base
12. Surrender button/leave from the game
13. Language selector
14. Volume change for game sounds
15. Music volume change
16. Help box where information about hovered element is displayed
### How to run API and server
All of neccesery files for running server side are compressed into a single `docker-compose.yml` that is found within this repository. All that can change in configuration is the volume in the `path-fighters-api` container and port in `path-fighters-server-api` container.
To run all just type in console `docker-compose up` command with optional `-d` for this being detached.