README
¶
GameMate
A fancy, efficient and scalable architecture for next generation games.
A light architecture for game companies which uses the power of redis, mySQL and Golang!
How to use :
- clone this repository, use this as a template for your cloud architecture
- setup Redis and MySQL
- setup configuration package
- gather some Game Developers (for games) and API Users (to have your API used via some cool devices)
- have some games added to the system
- Spread the joy :)
Donate
Feel free to donate:
| METHOD | ADDRESS |
|---|---|
| Paypal | https://paypal.me/AlessandroSanino |
| BTC | 1DVgmv6jkUiGrnuEv1swdGRyhQsZjX9MT3 |
| XVG | DFstPiWFXjX8UCyUCxfeVpk6JkgaLBSNvS |
| ETH | 0x2fe7bd8a41e91e9284aada0055dbb15ecececf02 |
| USDT | 18obCEVmbT6MHXDcPoFwnUuCmkttLbK5Xo |
Documentation
¶
Overview ¶
Represents the main package of this project and the file to be "executed" at first level.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package benchmarks contains all the benchmarks to show the performance of the system.
|
Package benchmarks contains all the benchmarks to show the performance of the system. |
|
Package configurations contains all the configuration parameters and data structures for the server initialization.
|
Package configurations contains all the configuration parameters and data structures for the server initialization. |
|
Contains all the constants used in this project.
|
Contains all the constants used in this project. |
|
Package controllers represents a container for all Controllers of the API project.
|
Package controllers represents a container for all Controllers of the API project. |
|
shared/cache_consistency_flyweight
Package isCacheConsistent contains variables to check whenever cache is not consistent with the archives (so it should not be used and must be fixed from a routine).
|
Package isCacheConsistent contains variables to check whenever cache is not consistent with the archives (so it should not be used and must be fixed from a routine). |
|
user/login_controller
Package loginController contains all functions regarding user authentication and registration.
|
Package loginController contains all functions regarding user authentication and registration. |
|
user/out_game_controller
Package outGameController contains the functions handling requests for features regarding users outside a selected game.
|
Package outGameController contains the functions handling requests for features regarding users outside a selected game. |
|
user/score_controller
Package scoreController contains helper methods to update scoretables and playing player counts.
|
Package scoreController contains helper methods to update scoretables and playing player counts. |
|
models
|
|
|
developer/requests
Package developerRequests contains all requests handling developer entity functions.
|
Package developerRequests contains all requests handling developer entity functions. |
|
developer/responses
Package developerResponses contains all responses regarding developer entity operations.
|
Package developerResponses contains all responses regarding developer entity operations. |
|
game_owner/data_structures
Package gameOwnerDataStructs contains all helper structs used by requests or responses for the gameOwner entity.
|
Package gameOwnerDataStructs contains all helper structs used by requests or responses for the gameOwner entity. |
|
game_owner/requests
Package gameOwnerRequests contains all requests regarding gameOwner entity.
|
Package gameOwnerRequests contains all requests regarding gameOwner entity. |
|
game_owner/responses
Package gameOwnerResponses contains all responses regarding gameOwner entity operations.
|
Package gameOwnerResponses contains all responses regarding gameOwner entity operations. |
|
shared/game_server
Package gameServerLogic (not part of the project) is used as example to provide how an external service should use gamemate API.
|
Package gameServerLogic (not part of the project) is used as example to provide how an external service should use gamemate API. |
|
shared/requests/interfaces
Package requestInterfaces contains all interfaces common to all requests.
|
Package requestInterfaces contains all interfaces common to all requests. |
|
shared/responses/errors
Package errorResponses contains all models regarding error messages from the server.
|
Package errorResponses contains all models regarding error messages from the server. |
|
shared/socket
Package socketModels contains the structures used to allow socketModels real-time communication with the system.
|
Package socketModels contains the structures used to allow socketModels real-time communication with the system. |
|
user/data_structures
Package userDataStructs contains all structs used by user entity.
|
Package userDataStructs contains all structs used by user entity. |
|
user/requests/in_match
Package inMatchRequests contains all models used when a player is playing a match
|
Package inMatchRequests contains all models used when a player is playing a match |
|
user/requests/login
Package loginRequests contains all models regarding login and registration requests.
|
Package loginRequests contains all models regarding login and registration requests. |
|
user/requests/out_game
Package outGameRequests contains all models regarding all the requests from logged users searching for games to play.
|
Package outGameRequests contains all models regarding all the requests from logged users searching for games to play. |
|
user/requests/out_match
Package outMatchRequests contains all models regarding requests form players searching for a match to play.
|
Package outMatchRequests contains all models regarding requests form players searching for a match to play. |
|
user/responses/in_match
Package inMatchResponses contains all models used to respond to inMatchRequests.
|
Package inMatchResponses contains all models used to respond to inMatchRequests. |
|
user/responses/login
Package loginResponses contains all models regarding responses to login or registration requests.
|
Package loginResponses contains all models regarding responses to login or registration requests. |
|
user/responses/out_game
Package outGameResponses contains all models used to respond to outGameRequests.
|
Package outGameResponses contains all models used to respond to outGameRequests. |
|
user/responses/out_match
Package outMatchResponses contains all models used to respond to outMatchRequests.
|
Package outMatchResponses contains all models used to respond to outMatchRequests. |
|
Package test contains all tests for the API, such as Redis Linking check or Server conf up check.
|
Package test contains all tests for the API, such as Redis Linking check or Server conf up check. |
Click to show internal directories.
Click to hide internal directories.