|
2 | 2 | sidebar_position: 1 |
3 | 3 | --- |
4 | 4 |
|
5 | | -# Tutorial Intro |
| 5 | +# Cross Language Soccer Framework |
6 | 6 |
|
7 | | -Let's discover **Docusaurus in less than 5 minutes**. |
| 7 | +Cross Language Soccer Framework (CLSFramework) is a new approach to enhance the flexibility and interoperability of RoboCup Soccer Simulation 2D (SS2D). |
| 8 | +This framework is designed to allow the development of RoboCup Soccer Simulation 2D agents in different programming languages. |
| 9 | +The Soccer Simulation Proxy is an extended version of the Helios base that can send decision-making information to a PlayMaker Server. It can receive high-level/low-level actions from the PlayMaker Server and send them to the RoboCup Soccer Simulation Server and/or SoccerWindow2. |
| 10 | +On the other hand, the PlayMaker Server receives information from the client(Modified version of Helios base/Soccer Simulation Proxy) and selects the appropriate actions to be sent back to the client. We have implemented some sample servers in C\#, Python, and JavaScript, but it can also be implemented in other languages to make use of their features. |
8 | 11 |
|
9 | | -## Getting Started |
| 12 | +To learn more about the framework, how to build, and how to run it please check the [wiki pages](https://github.com/CLSFramework/cross-language-soccer-framework/wiki). |
10 | 13 |
|
11 | | -Get started by **creating a new site**. |
| 14 | +Also, you can check the following repositories to find sample playmaker servers in many programming languages: |
| 15 | +- [Soccer Simulation Proxy](https://github.com/CLSFramework/soccer-simulation-proxy) |
| 16 | +- [PlaymakerServer-CSharp](https://github.com/CLSFramework/playmaker-server-csharp) |
| 17 | +- [PlaymakerServer-Python](https://github.com/CLSFramework/playmaker-server-python) |
| 18 | +- - [Sample-PlaymakerServer-Python-GRPC](https://github.com/CLSFramework/sample-playmaker-server-python-grpc) |
| 19 | +- - [Sample-PlaymakerServer-Python-THRIFT](https://github.com/CLSFramework/sample-playmaker-server-python-thrift) |
| 20 | +- - [Starter-PlaymakerServer-Python-THRIFT](https://github.com/CLSFramework/starter-playmaker-server-python-thrift) |
| 21 | +- [PlaymakerServer-NodeJs](https://github.com/CLSFramework/playmaker-server-nodejs) |
12 | 22 |
|
13 | | -Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. |
14 | 23 |
|
15 | | -### What you'll need |
| 24 | + |
16 | 25 |
|
17 | | -- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: |
18 | | - - When installing Node.js, you are recommended to check all checkboxes related to dependencies. |
| 26 | + |
19 | 27 |
|
20 | | -## Generate a new site |
| 28 | + |
21 | 29 |
|
22 | | -Generate a new Docusaurus site using the **classic template**. |
| 30 | + |
23 | 31 |
|
24 | | -The classic template will automatically be added to your project after you run the command: |
25 | 32 |
|
26 | | -```bash |
27 | | -npm init docusaurus@latest my-website classic |
28 | | -``` |
| 33 | +# How To Use The Framework? |
29 | 34 |
|
30 | | -You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. |
| 35 | +To run a normal soccer simulation 2D game without using the proxy, you need to run the Soccer Simulation Server (RCSSServer) and the Soccer Simulator Monitor (RCSSMonitor). The Soccer Simulation Server will host the game, and the Soccer Simulator Monitor will display the game. Also, you need to run two teams to play the game. Each team should have a coach and eleven players (and trainer for training proposes and controlling the server). All of the clients connect to the RCSSServer by using UDP to send action and receive information. |
31 | 36 |
|
32 | | -The command also installs all necessary dependencies you need to run Docusaurus. |
33 | | - |
34 | | -## Start your site |
35 | | - |
36 | | -Run the development server: |
37 | | - |
38 | | -```bash |
39 | | -cd my-website |
40 | | -npm run start |
41 | | -``` |
42 | | - |
43 | | -The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. |
44 | | - |
45 | | -The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. |
46 | | - |
47 | | -Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. |
| 37 | +To run a game by using the framework, you need to run the Soccer Simulation Server to host a game, the Soccer Simulator Monitor, Soccer Simulation Proxy, and a Playmaker Server. We provide some different solution to build, install, and run these components on Linux(Ubuntu) [Build From Source, AppImage, Docker] and Windows[WSL, Docker]. Also, there are some solutions that you can run some of the components together. |
0 commit comments