Skip to content

Commit 2563f5e

Browse files
aradfirSK2iP
authored andcommitted
Update README.md
1 parent ce8aded commit 2563f5e

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,21 @@ Due to the popularity of python in Machine Learning & AI spaces we decided to cr
4949
However, using python alone was too slow as preprocessing sensor information & tasks such as localization took too long.
5050

5151
For this reason we have split up the code into two segments:
52-
The data processing section in proxy, which creates a World Model (state), and passes it to python for planning to occur.
52+
The data processing section in proxy, which creates a World Model (state), and passes it to python for planning to occur. This repository uses gRPC to pass along the World Model, but there is a sister-repo which is compatible with thrift.
53+
54+
![cls](https://github.com/user-attachments/assets/4daee216-1479-4acd-88f2-9e772b8c7837)
55+
As seen in the figure, the proxy handles connecting to the server, receiving sensor information and creating a world-model, and finds the action to take via a remote procedure call to a decision-making server, which is this repository.
56+
57+
# Configuration
58+
## RoboCup Server configuration
59+
You can change the configuration of the RoboCup server and change parameters such as players' stamina, game length, field length, etc. by modifying `~/.rcssserver/server.conf`. Refer to the server's documents and repo for a more detailed guide.
60+
61+
## Modifying Proxy & Running proxy and server seperately
62+
If you want to modify the algorithms of the base (such as ball interception, shooting, localization, etc.) you must modify the code of the [proxy repo](https://github.com/CLSFramework/soccer-simulation-proxy). After re-building from source, you can run the proxy by using `./start.sh --rpc-type grpc` in the bin folder of the proxy, and run the gRPC server with `python3 server.py` in this repo's directory. It is highly recommended to launch the python server before the proxy.
63+
64+
You can modify the rpc port by adding the argument `--rpc-port [VALUE]`, where the default is 50051.
65+
66+
# Citation
67+
68+
- [Cross Language Soccer Framework](https://arxiv.org/pdf/2406.05621)
69+
- Zare, N., Sayareh, A., Sadraii, A., Firouzkouhi, A. and Soares, A., 2024. Cross Language Soccer Framework: An Open Source Framework for the RoboCup 2D Soccer Simulation. arXiv preprint arXiv:2406.05621.

0 commit comments

Comments
 (0)