Skip to content

Commit dec8a40

Browse files
committed
update
1 parent ec40960 commit dec8a40

File tree

8 files changed

+1390
-46
lines changed

8 files changed

+1390
-46
lines changed

blog/team.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
slug: team
3+
title: Team Members
4+
# authors: [slorber, yangshun]
5+
tags: [hola, docusaurus]
6+
---
7+
8+
# Team Members

docs/intro.md

Lines changed: 21 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,46 +2,36 @@
22
sidebar_position: 1
33
---
44

5-
# Tutorial Intro
5+
# Cross Language Soccer Framework
66

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.
811

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).
1013

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)
1222

13-
Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
1423

15-
### What you'll need
24+
![image](https://github.com/user-attachments/assets/0c22d0e5-a1ad-4a43-8cba-a9fc70c6ed5b)
1625

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+
![image](https://github.com/Cross-Language-Soccer-Framework/cross-language-soccer-framework/assets/25696836/7b0b1d49-7001-479c-889f-46a96a8802c4)
1927

20-
## Generate a new site
28+
![image](https://github.com/user-attachments/assets/b4484095-0913-4434-bf1f-35f11e8bf629)
2129

22-
Generate a new Docusaurus site using the **classic template**.
30+
![image](https://github.com/user-attachments/assets/bc1b9c86-f772-4df8-a420-438e363c59b5)
2331

24-
The classic template will automatically be added to your project after you run the command:
2532

26-
```bash
27-
npm init docusaurus@latest my-website classic
28-
```
33+
# How To Use The Framework?
2934

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.
3136

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.

docusaurus.config.ts

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@ import type {Config} from '@docusaurus/types';
33
import type * as Preset from '@docusaurus/preset-classic';
44

55
const config: Config = {
6-
title: 'My Site',
7-
tagline: 'Dinosaurs are cool',
6+
title: 'Cross Language Soccer Framework',
7+
tagline: 'A framework for soccer development and research in multiple languages',
88
favicon: 'img/favicon.ico',
99

1010
// Set the production url of your site here
11-
url: 'https://your-docusaurus-site.example.com',
11+
url: 'https://clsframework.github.io',
1212
// Set the /<baseUrl>/ pathname under which your site is served
1313
// For GitHub pages deployment, it is often '/<projectName>/'
1414
baseUrl: '/',
1515

1616
// GitHub pages deployment config.
1717
// If you aren't using GitHub pages, you don't need these.
18-
organizationName: 'facebook', // Usually your GitHub org/user name.
19-
projectName: 'docusaurus', // Usually your repo name.
18+
organizationName: 'CLSF', // Usually your GitHub org/user name.
19+
projectName: 'CLSF', // Usually your repo name.
2020

2121
onBrokenLinks: 'throw',
2222
onBrokenMarkdownLinks: 'warn',
@@ -66,10 +66,10 @@ const config: Config = {
6666
// Replace with your project's social card
6767
image: 'img/docusaurus-social-card.jpg',
6868
navbar: {
69-
title: 'My Site',
69+
title: 'CLSF',
7070
logo: {
7171
alt: 'My Site Logo',
72-
src: 'img/logo.svg',
72+
src: 'img/clsf.svg',
7373
},
7474
items: [
7575
{
@@ -79,8 +79,9 @@ const config: Config = {
7979
label: 'Tutorial',
8080
},
8181
{to: '/blog', label: 'Blog', position: 'left'},
82+
{to: '/blog/team', label: 'Team', position: 'left'},
8283
{
83-
href: 'https://github.com/facebook/docusaurus',
84+
href: 'https://github.com/clsframework/clsframework.github.io',
8485
label: 'GitHub',
8586
position: 'right',
8687
},

src/components/HomepageFeatures/index.tsx

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
import clsx from 'clsx';
22
import Heading from '@theme/Heading';
33
import styles from './styles.module.css';
4+
import Link from '@docusaurus/Link';
45

56
type FeatureItem = {
67
title: string;
78
Svg: React.ComponentType<React.ComponentProps<'svg'>>;
89
description: JSX.Element;
10+
link?: string;
911
};
1012

1113
const FeatureList: FeatureItem[] = [
@@ -30,18 +32,18 @@ const FeatureList: FeatureItem[] = [
3032
),
3133
},
3234
{
33-
title: 'Powered by React',
34-
Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
35+
title: 'Soccer Simulation 2D',
36+
Svg: require('@site/static/img/ss2d.svg').default,
3537
description: (
3638
<>
37-
Extend or customize your website layout by reusing React. Docusaurus can
38-
be extended while reusing the same header and footer.
39+
The RoboCup 2D Simulated Soccer League is the oldest of the RoboCup Soccer Simulation Leagues. It consists of a number of competitions with computer simulated soccer matches as the main event.
3940
</>
4041
),
42+
link: 'https://rcsoccersim.github.io/'
4143
},
4244
];
4345

44-
function Feature({title, Svg, description}: FeatureItem) {
46+
function Feature({title, Svg, description, link}: FeatureItem) {
4547
return (
4648
<div className={clsx('col col--4')}>
4749
<div className="text--center">
@@ -50,6 +52,13 @@ function Feature({title, Svg, description}: FeatureItem) {
5052
<div className="text--center padding-horiz--md">
5153
<Heading as="h3">{title}</Heading>
5254
<p>{description}</p>
55+
{link && (
56+
<Link
57+
className="button button--secondary button--lg"
58+
to={link}>
59+
Learn More
60+
</Link>
61+
)}
5362
</div>
5463
</div>
5564
);

src/pages/index.module.css

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,10 @@
2121
align-items: center;
2222
justify-content: center;
2323
}
24+
25+
.heroBanner {
26+
background-image: url('/img/ss2d.svg'); /* Relative to the `static` folder */
27+
background-size: cover; /* Ensures the image covers the entire area */
28+
background-position: center; /* Centers the image */
29+
color: white;
30+
}

src/pages/index.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import styles from './index.module.css';
1010
function HomepageHeader() {
1111
const {siteConfig} = useDocusaurusContext();
1212
return (
13-
<header className={clsx('hero hero--primary', styles.heroBanner)}>
13+
<header className={clsx('hero', styles.heroBanner)}>
1414
<div className="container">
1515
<Heading as="h1" className="hero__title">
1616
{siteConfig.title}
@@ -20,7 +20,7 @@ function HomepageHeader() {
2020
<Link
2121
className="button button--secondary button--lg"
2222
to="/docs/intro">
23-
Docusaurus Tutorial - 5min ⏱️
23+
CLSF Tutorial
2424
</Link>
2525
</div>
2626
</div>

0 commit comments

Comments
 (0)