Warning: The project is still work in progress. The first functioning version will be tagged v0.1.0

GMod-CLI

This is a CLI for managing a gmod server instance

This project is continuously developed to fit the needs of Flauschig e.V. Version v0.1.0 will be working soon. You can find a feature roadmap at the end of this README.

Getting Started

Tested Operating Systems

The tool is currently tested on the following systems:

• Debian 4.9.130-2 x86_64

It may also run on different Linux distributions, but some extra configuration can be necessary.

Prerequisites

To run the CLI, you need the following software:

• Python3
• PIP
• SteamCMD (Installation Guide)

Installation

1. Clone the repo
2. Install the necessary pip dependencies by running:

   pip install -r requirements.txt
   

   or install them manually. List of dependencies

TODO Finish installing guide

Running the tests

TODO Add test description

Built With

Contributing

TODO Provide information

Versioning

We use SemVer 2.0.0 for versioning. For the versions available, see the tags on this repository.

Authors

• Kai Frankenhäuser - Initial work - Kailijan

See also the list of contributors who participated in this project.

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details

Acknowledgments

Feature Roadmap

For v0.1.0

• Install and update GMod

For v0.2.0

• Start and stop a gameserver with the default gamemode

For v0.3.0

• Support for TTT
• Support for Prop Hunt