README.md Updated

This commit is contained in:
Steffen Illium 2023-06-16 14:42:54 +02:00
parent b4326b514c
commit bf3e1e2ea4
3 changed files with 28 additions and 8 deletions

View File

@ -77,14 +77,35 @@ Varying levels are created by defining Walls, Floor or Doors in *.txt*-files (se
Define which *level* to use in your *configfile* as:
```yaml
General:
level_name: rooms
level_name: rooms # 'double', 'large', 'simple', ...
```
... or create your own , maybe witht he help of [asciiflow.com](https://asciiflow.com/#/).
... or create your own , maybe with the help of [asciiflow.com](https://asciiflow.com/#/).
Be sure to use '#' as Walls, '-' as free (walkable) Floor-Tiles, 'D' for Doors.
Custom Entites (define you own) may bring their own "Symbol"
#### Entites
TODO
Entites are either [Objects](./environment/entity/object.py) for tracking stats or env. [Entity](./environment/entity/entity.py) which can interact.
Abstract Entities are provided.
#### Groups
[Groups](./environment/groups/objects.py) are entity Sets that provide administrative access to all group members.
All [Entites](./environment/entity/global_entities.py) are available at runtime as EnvState property.
#### Rules
TODO
- Results
[Rules](./environment/entity/object.py)
[Results](./environment/entity/object.py) provide a way to return 'rule' evaluations such as rewards and state reports
back to the environment.
#### Assets
TODO
Make sure to bring your own assets for each Entity, that is living in the Gridworld, the 'Renderer' relies on it.
PNG-files (transparent background) of square aspect-ratio should do the job, in general.
<div style="margin:0 auto;">
<img src=".\environment\assets\wall.png" width="10%"> | <img src=".\environment\assets\agent\agent.png" width="10%">
</div>

View File

@ -1 +0,0 @@

View File

@ -10,7 +10,7 @@ Entities:
Defaults: {}
DirtPiles:
initial_dirt_ratio: 0.3 # On INIT, on max how many tiles does the dirt spawn in percent.
dirt_spawn_r_var: 0.05 # How much does the dirt spawn amount vary?
dirt_spawn_r_var: 0.05 # How much does the dirt spawn amount vary?
initial_amount: 3
max_local_amount: 5 # Max dirt amount per tile.
max_global_amount: 20 # Max dirt amount in the whole environment.