From 117770bc9927f03ba7724cfcd820dd5f19ad00c4 Mon Sep 17 00:00:00 2001 From: GitHub Actions Bot Date: Wed, 23 Oct 2024 02:52:42 +0000 Subject: [PATCH] Update sample server documentation from README --- .../0-sample-python-base-code-gRPC/index.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/2-sampleserver/0-sample-python-base-code-gRPC/index.md b/docs/2-sampleserver/0-sample-python-base-code-gRPC/index.md index 3e5e051..a136f46 100644 --- a/docs/2-sampleserver/0-sample-python-base-code-gRPC/index.md +++ b/docs/2-sampleserver/0-sample-python-base-code-gRPC/index.md @@ -1,9 +1,13 @@ +--- +custom_edit_url: 'https://github.com/CLSFramework/sample-playmaker-server-python-grpc/blob/main/README.md' +--- + # Sample Python Base Code (gRPC) [![Documentation Status](https://readthedocs.org/projects/clsframework/badge/?version=latest)](https://clsframework.github.io/docs/introduction/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -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). +.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). 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. @@ -139,4 +143,4 @@ You can modify the rpc port by adding the argument `--rpc-port [VALUE]`, where t ## Citation - [Cross Language Soccer Framework](https://arxiv.org/pdf/2406.05621) -- 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. \ No newline at end of file +- 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....