diff --git a/README.md b/README.md index c897960..58bd266 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Highlights: * ⚡ **blazing-fast simulator**: run thousands of steps per second with `numpy`-powered efficiency * 🤝 **seamless integration**: fully compatible with RL standards 🤸[Gymnasium](https://gymnasium.farama.org/) and đŸĻ[PettingZoo](https://pettingzoo.farama.org/) * 🔧 **extensive customization**: easily tailor environments to your specific needs -* 🚀 **effortless deployment**: launch your agents to generalsio +* 🚀 **effortless deployment**: launch your agents to [generals.io](https://generals.io) * đŸ”Ŧ **analysis tools**: leverage features like replays for deeper insights > [!Note] @@ -141,7 +141,7 @@ replay = Replay.load("my_replay") replay.play() ``` ### 🕹ī¸ Replay controls -You can control your replays to your liking! Currently we support these controls: +You can control your replays to your liking! Currently, we support these controls: - `q` — quit/close the replay - `r` — restart replay from the beginning - `←/→` — increase/decrease the replay speed @@ -206,14 +206,14 @@ observations, info = env.reset() ## 🚀 Deployment to Live Servers Complementary to local development, it is possible to run agents online against other agents and players. -We use `socketio` for communication and you can either use out `autopilot` to run agent in a specified lobby indefinitely, +We use `socketio` for communication, and you can either use our `autopilot` to run agent in a specified lobby indefinitely, or create your own connection workflow. Our implementations expect that your agent inherits from the `Agent` class, and has -implemented required methods. +implemented the required methods. ```python from generals.remote import autopilot import argparse parser = argparse.ArgumentParser() -parser.add_argument("--user_id", type=str, default=...) # Register yourself at generalsio and use this id +parser.add_argument("--user_id", type=str, default=...) # Register yourself at generals.io and use this id parser.add_argument("--lobby_id", type=str, default="psyo") # The last part of the lobby url parser.add_argument("--agent_id", type=str, default="Expander") # agent_id should be "registered" in AgentFactory @@ -224,9 +224,9 @@ if __name__ == "__main__": This script will run your `ExpanderAgent` in lobby `psyo`. ## 🙌 Contributing You can contribute to this project in multiple ways: -- 🤖 If you implement ANY non-trivial agent, send it to us! We will publish it so others can play against it +- 🤖 If you implement ANY non-trivial agent, send it to us! We will publish it, so others can play against it. - 💡 If you have an idea on how to improve the game, submit an issue or create a PR, we are happy to improve! - We also have some ideas (see [issues](https://github.com/strakam/generals-bots/issues)), so you can see what we plan to work on + We also have some ideas (see [issues](https://github.com/strakam/generals-bots/issues)), so you can see what we plan to work on. > [!Tip] > Check out [wiki](https://github.com/strakam/generals-bots/wiki) to learn in more detail on how to contribute. diff --git a/examples/client_example.py b/examples/client_example.py index 9e5376c..f12b960 100644 --- a/examples/client_example.py +++ b/examples/client_example.py @@ -3,7 +3,7 @@ import argparse parser = argparse.ArgumentParser() -parser.add_argument("--user_id", type=str, default=...) # Register yourself at generalsio and use this id +parser.add_argument("--user_id", type=str, default=...) # Register yourself at generals.io and use this id parser.add_argument("--lobby_id", type=str, default="psyo") # After you create a private lobby, copy last part of the url parser.add_argument("--agent_id", type=str, default="Expander") # agent_id should be "registered" in AgentFactory