.. Godot Gym API documentation master file, created by
   sphinx-quickstart on Fri Sep 22 22:58:23 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Godot Gym API's documentation!
=========================================

**Godot Gym API** is an Open Source framework, providing ``gym.Env`` interface and Godot base classes 
to use Godot as environment to train and evaluate reinforcement learning algorithms implemented in Python.

.. note::
   This project is under active development.

Github repository: https://github.com/ChernyakKonstantin/godot_gym_api

Main features
-------------

* Use any data as observation from Godot application with help of **protobuf**
* Extendable Godot nodes to implement a custom environment
* Working on Linix / MacOS / Windows
* Working on a local or a remote machine via TCP connection
* Standart OpenAI Gym interface 
* Compatability with popular Python RL frameworks
* Documentation



User Guide
----------

.. toctree::
   :maxdepth: 1

   installation   
   godot/index
   python/index
   godobuf/index
   examples/index
   cli_tools/index