veskoy / gomas

A Master Server for some of Valve's games written in Go.

Table Of Contents

• Table Of Contents
• Basic Overview
• Installation
• Usage
• Changelog
• Contributing
• License
• Contributors

Basic Overview

Gomas is a Master Server written in Go for some of Valve's multiplayer games. It is an implementation of the Master Server Query Protocol. The main objective of Gomas is to allow the community to run 3rd party quality master servers.

Installation

Gomas hasn't been released yet. This means there are no stable executables that you can use out of the box. Gomas is in its early stage and goes through rapid development. For that reason the only way you can run and try it out is by building it from source (Linux / MacOS):

git clone https://github.com/veskoy/gomas.git
cd gomas
go get -v -t ./...
go build -o ./gomasd ./cmd/gomasd

This will make an executable "./gomasd" which you can use to start a Master Server.

Usage

Default - the master server will listen on 127.0.0.1:27010:

./gomasd

Start a master server that will listen on specified ip address and port:

./gomasd -ip=xxx.xxx.xxx.xxx -port=xxxxx

Truncate/Seed/Reset database on startup:

./gomasd -ip=xxx.xxx.xxx.xxx -port=xxxxx -db=truncate
./gomasd -ip=xxx.xxx.xxx.xxx -port=xxxxx -db=seed
./gomasd -ip=xxx.xxx.xxx.xxx -port=xxxxx -db=reset

Changelog

To see what has changed in recent versions of Gomas, see the CHANGELOG.

Problems

Please report and follow the resolution of any encountered problems in the issue tracker.

Contributing

Thank you for considering contributing to Gomas. Any contributions are always welcomed as long as they follow our contributing guidelines.

License

Gomas is open-sourced software licensed under the MIT license.

Contributors

• Author: Veselin Stoyanov

gomas's Issues

f2017160203 - Update README.md

Feature description:
Update readme according to the tasks below.

Tasks:

• Add "Installation" instructions
• Add "Usage" instructions

f2017100201 - Add Ginkgo & Gomega for BDD

Feature description:
Add Ginkgo & Gomega for easier testing and behaviour driven development.

Tasks:

• Add Ginkgo & Gomega
• Rewrite tests in the new style
• Make sure CI server runs the new tests correctly

f2017160201 - Web CRUD Interface for managing servers

Feature description:
Implement a web interface for easier management of game servers.

Tasks:

• Create
• Read
• Update
• Delete

f2017050101 - Create a README.md file

Create a README.md file with the following features:

• Project logo
• Program description
• How to install
• How to use
• License info

f2017280101 - Make the project use a configuration file for various settings

Feature description:
For better usability and easier configuration, the project needs to be configured via configuration file/s.

Tasks:

• Implement configuration file loading and parsing
• Implement helper methods for easier setting fetching

f2017160204 - Make an initial release (MVP)

Feature description:
Release the initial version of Gomas.

Tasks:

• Think of a versioning strategy.
• Release the initial version and upload it to GitHub.

f2017100201 - Add Ginkgo & Gomega for BDD

Feature description:
Add Ginkgo & Gomega for easier testing and behaviour driven development.

Tasks:

• Add Ginkgo & Gomega
• Rewrite tests in the new style
• Make sure CI server runs the new tests correctly

f2017050102 - Project Structure

Plan and create the desired structure of the project:

• Create all folders
• Create initially planned files

f2017050103 - Setup a continuous integration server

Setup a continuous integration server which runs tests and code style checks on the project on commit in the master branch:

• Setup a CI for the project

f2017050105 - Dockerize the application

Dockerize the application:

• Create an easy to use docker image
• Write documentation

f2017050104 - Basic server implementation

Implement the basic server functionality:

• Run on desired port
• Wait for requests

f2017170102 - Research the Master Server Query Protocol

Feature description:
Research the Master Server Query Protocol.

Tasks:

• Plan the desired functionality.
• Create method definitions inside the msqp package.

f2017170101 - Database Structure

Feature description:
Plan the database structure and create appropriate package in the project structure.

Tasks:

• Plan the database structure
• Create package in the project structure
• Write simple definitions with documentation of the desired functionality (no implementation for now).

f2017160202 - Ping servers periodically to check activity (A2A_PING query)

Feature description:
Implement A2A_PING query in order to check game servers availability periodically. This will allow fetching additional data as well.

Tasks:

• Implement A2A_PING query
• Enqueue worker jobs for fetching each server's data separately

Additional notes:
Use A2A_PING documentation.

f2017050106 - Add ISSUE_TEMPLATE.md and PULL_REQUEST_TEMPLATE.md files

Add the following files in the master repository for easier project management:

• Create a /.github folder
• Inside create:
  • ISSUE_TEMPLATE.md
  • PULL_REQUEST_TEMPLATE.md
• Move CONTRIBUTING.md inside /.github folder

f2017050107 - Create a .gitignore file

Feature description:
Create a .gitignore file in the project root.

Tasks:

• Create a .gitignore file