Skip to content

Commit 80ed6bf

Browse files
committed
add required_players to readme
1 parent da21875 commit 80ed6bf

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -213,9 +213,10 @@ The environment part defines the properties of the environment for the task (see
213213
- `use_dynamic_addresses` - if `True`, the network and IP addresses defined in `scenario` are randomly changed at the beginning of **EVERY** episode (the network topology is kept as defined in the `scenario`. Relations between networks are kept, IPs inside networks are chosen at random based on the network IP and mask)
214214
- `use_firewall` - if `True` firewall rules defined in `scenario` are used when executing actions. When `False`, the firewall is ignored, and all connections are allowed (Default)
215215
- `use_global_defender` - if `True`, enables global defendr which is part of the environment and can stop interaction of any playing agent.
216+
- `required_players` - Minimum required players for the game to start (default 1)
216217
- `rewards`:
217-
- `win` - sets reward which agent gets when it reaches the goal (default 100)
218-
- `loss` - sets the reward that which agent does not reach it's objective (default -10)
218+
- `success` - sets reward which agent gets when it reaches the goal (default 100)
219+
- `fail` - sets the reward that which agent does not reach it's objective (default -10)
219220
- `step_reward` - sets reward which agent gets for every step taken (default -1)
220221
- `actions` - defines the probability of success for every ActionType
221222

0 commit comments

Comments
 (0)