gtm-cli

README

Go! Tame! Me! CLI (gtm-cli)

Welcome to the official command-line interface (CLI) for Go! Tame! Me!, an ambitious simulation project inspired by the classic game Ant!Me!. The gtm-cli tool is designed to streamline the development, testing, and execution of custom ant behavior simulations. This CLI leverages the core functionalities of Go! Tame! Me!, allowing users to compile and run simulation plugins directly from the command line.

Features

• Compile and Run Simulation Plugins: Quickly compile and run your custom Go! Tame! Me! simulation plugins with a simple command.
• Customizable Simulation Parameters: Launch simulations with customizable settings such as immediate start, headless mode, and desired sugar cone count.
• Open-Source Development: Built with the open-source community in mind, gtm-cli supports collaborative development and experimentation.

Installation

Before you can use gtm-cli, make sure you have Go installed on your machine (version 1.22 or newer is recommended).

To install gtm-cli, run the following command:

go install github.com/gotameme/gtm-cli@latest

This command downloads and installs the gtm-cli tool, making it ready to use.

Usage

gtm-cli currently supports three primary commands:

1. Root Command

The base command for gtm-cli, which can be executed with just gtm-cli, provides a brief description of the application and available commands.

2. Run Command

The run command compiles and executes a Go! Tame! Me! simulation plugin.

gtm-cli run -i /path/to/your/plugin.go

Flags

• --startImmediately or -i: Start the game immediately after the plugin has been compiled.
• --headless: Run the game in headless mode for simulations without a graphical interface.
• --sugar: Set the desired amount of sugar cones in the simulation environment.

3. Init Command

Starting a new Go! Tame! Me! Ant project is made simple with the init command:

gtm-cli init --name "AwesomeAnt"

Executing this command will create a new directory named AwesomeAnt, pre-populated with a basic project structure. This includes a go.mod file to handle dependencies and a main.go file, where a skeleton of an Ant project is automatically generated. The generated main.go file contains template code to get you started with your ant simulation, providing a clear example of how to define ant behaviors and integrate them into the Go! Tame! Me! environment.

The init command is designed to streamline the project setup process, allowing you to jump straight into developing your ant behaviors without worrying about boilerplate code.

Contributing

Contributions are welcome! Whether you're fixing bugs, adding new features, or improving documentation, your help is invaluable. For more details on how to contribute, please refer to our CONTRIBUTING.md file.

Support and Communication

For questions, suggestions, and discussions, please use the GitHub Issue Tracker. We strive for a supportive and harassment-free communication environment. English is the preferred language for project communication to include as many contributors as possible.

Thank you for your interest in contributing to Go! Tame! Me! CLI. Together, we're building an engaging and educational simulation platform.

License

gtm-cli is licensed under the MIT License. See the LICENSE file for more details.

Documentation

Overview

Copyright (c) 2024 Sebastian Kroczek <me@xbug.de>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.