From d2704f495070c19753fb7413b42870a2a7bf561d Mon Sep 17 00:00:00 2001 From: Jonas Dujava Date: Fri, 13 Sep 2024 15:46:32 +0200 Subject: [PATCH] Fix capitalization in README.md Signed-off-by: Jonas Dujava --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7f09279..2968812 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ -[generals.io](https://generals.io/) is a real-time strategy game where players compete to conquer their opponents' generals on a 2D grid. While the goal is simple — capture the enemy general — the gameplay involves a lot of depth. Players need to employ strategic planning, deception, and manage both micro and macro mechanics throughout the game. The combination of these elements makes the game highly engaging and complex. +[Generals.io](https://generals.io/) is a real-time strategy game where players compete to conquer their opponents' generals on a 2D grid. While the goal is simple — capture the enemy general — the gameplay involves a lot of depth. Players need to employ strategic planning, deception, and manage both micro and macro mechanics throughout the game. The combination of these elements makes the game highly engaging and complex. This repository aims to make bot development more accessible, especially for Machine Learning based agents. @@ -19,7 +19,7 @@ Highlights:
-Generals.io has interesting properties: +Generals.io has several interesting properties: * 👀 Partial observability * 🏃‍♂ī¸ Long action sequences and large action spaces * 🧠 Requires strategical planning @@ -38,7 +38,7 @@ cd Generals-RL pip install -e . ``` -## Usage example +## Usage Example ```python from generals.env import generals_v0 from generals.agents import RandomAgent @@ -121,7 +121,7 @@ Maps are encoded using these symbols: - `A,B` are positions of generals - digits `0-9` represent cost of cities calculated as `(40 + digit)` -## đŸ”Ŧ Replay analysis +## đŸ”Ŧ Replay Analysis We can store replays and then analyze them. ### Storing a replay ```python @@ -139,7 +139,7 @@ import generals.utils generals.utils.run_replay("replay_001") ``` -### 🕹ī¸ Replay Controls +### 🕹ī¸ Replay controls - `q` — quit/close the replay - `←/→` — increase/decrease the replay speed - `h/l` — to control replay frames @@ -199,7 +199,7 @@ Creating your first agent is very simple. Start by subclassing an `Agent` class - `none` that omits rendering and is suitable for training, - `human` where you can see the game roll out. -## 🛠ī¸ Coming soon: +## 🛠ī¸ Coming Soon - Extend action space to sending half of units to another square - Examples and baselines using RL - Add human control to play against