README.md

Soccer Field Map Generator

This repository contains a tool for generating soccer field maps. It includes a GUI for interactively creating and editing maps, as well as a command-line interface for scripted map generation.

Installation

Installation using ROS 2

To install the tool, run the following commands in your colcon workspace:

git clone [email protected]:ros-sports/soccer_field_map_generator.git src/soccer_field_map_generator
rosdep install --from-paths src --ignore-src -r -y
colcon build

Don't forget to source your workspace after building:

source install/setup.bash

Installation using only Python

First I would recommend creating a virtual environment:

python3 -m venv venv
source venv/bin/activate

Then install the tool using pip:

pip install "git+https://github.com/ros-sports/soccer_field_map_generator.git#subdirectory=soccer_field_map_generator"

Usage

GUI

To launch the GUI, run the following command:

ros2 run soccer_field_map_generator gui

or this command if you installed the tool using pip:

python -m soccer_field_map_generator.gui

You should see a window like this:

CLI

To generate a map using the command-line interface, run the following command:

ros2 run soccer_field_map_generator cli [output_file] [config_file] [options]

or this command if you installed the tool using pip:

python -m soccer_field_map_generator.cli [output_file] [config_file] [options]