Skip to content

Commit 7c5c754

Browse files
authored
Merge pull request #8 from CLSFramework/update-readme-grpc-3034
Update sample server documentation
2 parents 7e6fddf + 117770b commit 7c5c754

File tree

1 file changed

+6
-2
lines changed
  • docs/2-sampleserver/0-sample-python-base-code-gRPC

1 file changed

+6
-2
lines changed

docs/2-sampleserver/0-sample-python-base-code-gRPC/index.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
1+
---
2+
custom_edit_url: 'https://github.com/CLSFramework/sample-playmaker-server-python-grpc/blob/main/README.md'
3+
---
4+
15
# Sample Python Base Code (gRPC)
26

37
[![Documentation Status](https://readthedocs.org/projects/clsframework/badge/?version=latest)](https://clsframework.github.io/docs/introduction/)
48
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
59

6-
This repository contains a sample decision-making server for the RoboCup 2D Soccer Simulation, which allows you to create a team by using Python. This server is compatible with the [Cross Language Soccer Framework](https://arxiv.org/pdf/2406.05621). This server is written in Python and uses gRPC to communicate with the [proxy](https://github.com/CLSFramework/soccer-simulation-proxy).
10+
.This repository contains a sample decision-making server for the RoboCup 2D Soccer Simulation, which allows you to create a team by using Python. This server is compatible with the [Cross Language Soccer Framework](https://arxiv.org/pdf/2406.05621). This server is written in Python and uses gRPC to communicate with the [proxy](https://github.com/CLSFramework/soccer-simulation-proxy).
711

812
The Soccer Simulation Server sends the observations to the proxy, which processes the data, create state message and sends it to the decision-making server. The decision-making server then sends the actions to the proxy, and then the proxy convert actions to the server commands and sends them to the server.
913

@@ -139,4 +143,4 @@ You can modify the rpc port by adding the argument `--rpc-port [VALUE]`, where t
139143
## Citation
140144

141145
- [Cross Language Soccer Framework](https://arxiv.org/pdf/2406.05621)
142-
- 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.
146+
- 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)