From b4c377ee0b768adea3a9c0b6db4b7bbe27d1019a Mon Sep 17 00:00:00 2001 From: Michal Charemza Date: Sun, 8 Dec 2024 12:12:54 +0000 Subject: [PATCH] docs: add about section To make this hopefully slightly clearer what this is --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d3b448d..c2e6192 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ OpenTTDLab is based on [Patric Stout's OpenTTD Savegame Reader](https://github.c ### Contents +- [About](#about) - [Features](#features) - [Installation](#installation) - [Running experiments](#running-experiments) @@ -39,9 +40,14 @@ OpenTTDLab is based on [Patric Stout's OpenTTD Savegame Reader](https://github.c --- -## Features +## About + +[OpenTTD](https://github.com/OpenTTD/OpenTTD) is a business simulation game where one or more human players each build a company through constructing and using a transportation network to transport passengers and goods. OpenTTD can be extended by allowing custom AI players to compete against the human players through its [AI API](https://docs.openttd.org/ai-api/). + +By _only_ allowing such AI players, making it possible to run ranges of simulations from Python code using different AIs or differently configured AIs, and returning metrics from the simulations such as how money changes over time for each player, OpenTTDLab turns OpenTTD from a game into a system for researching algorithms and their effects, especially on supply chains. -OpenTTDLab essentially turns OpenTTD into a simulator - and through AIs and AI libraries it allows you to experiment with different techniques of building supply chains and study their effects. In more detail OpenTTDLab: + +## Features - Allows you to easily run OpenTTD in a headless mode (i.e. without a graphical interface) over a variety of configurations. - And allows you to do this from Python code - for example from a Jupyter Notebook.