Differential D2199 Diff 10477 source/tools/clients/python/README.md

Changeset View

Standalone View

source/tools/clients/python/README.md

This file was added.

				# 0 AD Python Client
				This directory contains `zero_ad`, a python client for 0 AD which enables users to control the environment headlessly.
				ItmsUnsubmitted Done Inline Actions I would call the directory `source/tools/rlinterface` or maybe `rlclient` but not `clients`. Itms: I would call the directory `source/tools/rlinterface` or maybe `rlclient` but not `clients`.

				## Installation
				`zero_ad` can be installed with `pip` by running the following from the current directory:
				```
				pip install .
				```

				Development dependencies can be installed with `pip install -r requirements-dev.txt`. Tests are using pytest and can be run with `python -m pytest`.

				## Basic Usage
				If there is not a running instance of 0 AD, first start 0 AD with the RL interface enabled:
				```
				pyrogenesis --rpc-server=0.0.0.0:50050
				```

				Next, the python client can be connected with:
				```
				import zero_ad
				from zero_ad import ZeroAD

				game = ZeroAD('localhost:50050')
				```
				ItmsUnsubmitted Done Inline Actions It should be `6000` Itms: It should be `6000`

				A map can be loaded with:

				```
				config = zero_ad.ScenarioConfig('Acropolis Bay (2)')
				config.add_player('Player 1')
				config.add_player('Player 2')
				state = game.reset(config)
				```
				ItmsUnsubmitted Done Inline Actions this is not in your API as of now Itms: this is not in your API as of now

				where `state` contains the initial game state for the given map. The game engine can be stepped (optionally applying actions at each step) with:

				```
				state = game.step()
				```

				For example, enemy units could be attacked with:

				```
				my_units = state.units(owner=1)
				enemy_units = state.units(owner=2)
				actions = [zero_ad.actions.attack(my_units, enemy_units[0])]
				state = game.step(actions)
				```

				For a more thorough example, check out samples/simple-example.py!