Skip to content

Commit

Permalink
Add top level folders to README.md (#170)
Browse files Browse the repository at this point in the history
Added some description to what is found in each of the top level
folders.

Also fixed a bad Markdown link I did in the previous PR.
  • Loading branch information
markmandel authored Apr 10, 2023
1 parent 64f61d9 commit b97a62f
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,17 @@ Projects and products utilised include:
The **Droid Shooter** game, is composed of a game client and dedicated server, and multiple backend services hosted
around the globe.

### Top Level Folders

| Folder | Description |
|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [infrastructure](./infrastructure) | This contains all the Terraform scripts and resources to create the infrastructure that the project relies on. It is worth noting that the Terraform scripts will generate configuration files that are used by Cloud Deploy and Kubernetes in both the `platform` and `services` directories |
| [platform](./platform) | The `platform` directory contains the Cloud Build and Cloud Deploy scripts to set up the application platforms, such as Open Match and Agones, on the infrastructure that the `infrastructure` folder provisions. |
| [services](./services) | Contains the code for all the backend services that Droid Shooter requires, and Cloud Build and Cloud Deploy scripts to build and deploy these services to their appropriate hosting and storage infrastructure. |
| [game](./game) | The code for the game launcher, client and server, as well as Cloud Build, Cloud Deploy and Agones configurations for building and hosting the dedicated game servers |

### System Components

![Architecture diagram](images/architecture.png)

| Component | Technologies | Description |
Expand All @@ -39,7 +50,7 @@ around the globe.
[Fyne]: https://developer.fyne.io/index.html
[Agones Fleet]: https://agones.dev/site/docs/getting-started/create-fleet/
[Agones Latency Ping endpoints]: https://agones.dev/site/docs/guides/ping-service/
[Agones Allocator Endpoints]: https://agones.dev/site/docs/advanced/allocator-service/
[Agones Allocator Service]: https://agones.dev/site/docs/advanced/allocator-service/

## Run in Your Google Cloud Project

Expand Down

0 comments on commit b97a62f

Please sign in to comment.