diff --git a/README.md b/README.md index dc1d8ab..920862c 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ as well as a sample simulated team of robots with some basic strategy. ![Soccer Sim](./docs/docs/images/soccer_sim.png) -*Learn more in the [documentation](https://robocupjuniortc.github.io/rcj-soccer-sim/).* +*Learn more in the [documentation](https://robocupjuniortc.github.io/rcj-soccersim/).* # How do I try this out? @@ -18,9 +18,9 @@ as well as a sample simulated team of robots with some basic strategy. 2. Download [Webots](https://www.cyberbotics.com/#download) from their official website. Currently, version R2022a is stable with the Soccer Simulator. You can find detailed installation procedure on the official [Webots Installation guide](https://cyberbotics.com/doc/guide/installation-procedure). -3. Clone the rcj-soccer-sim repository to your computer by downloading the ZIP file from [here](https://github.com/RoboCupJuniorTC/rcj-soccer-sim/archive/master.zip) or running +3. Clone the rcj-soccersim repository to your computer by downloading the ZIP file from [here](https://github.com/RoboCupJuniorTC/rcj-soccersim/archive/master.zip) or running - git clone https://github.com/RoboCupJuniorTC/rcj-soccer-sim.git + git clone https://github.com/RoboCupJuniorTC/rcj-soccersim.git 4. Finally, run Webots, go to `Tools > Preferences > Python command` and set it to `python` or `python3` to point Webots to Python 3. Depending on your system, the reference to Python 3 can be via the command `python` or `python3`. More information on how to configure Webots to work with Python can be found [here](https://cyberbotics.com/doc/guide/using-python). @@ -48,7 +48,7 @@ avoid any compilation issues. ## Development -We are open to contributions! Have a look at our [issues](https://github.com/RoboCupJuniorTC/rcj-soccer-sim/issues). +We are open to contributions! Have a look at our [issues](https://github.com/RoboCupJuniorTC/rcj-soccersim/issues). Before you make a pull request, make sure the code is formatted with `black` and `isort`, and `flake8` issues are fixed. diff --git a/controllers/rcj_soccer_referee_supervisor/referee/supervisor.py b/controllers/rcj_soccer_referee_supervisor/referee/supervisor.py index 568a010..4fe9bb5 100644 --- a/controllers/rcj_soccer_referee_supervisor/referee/supervisor.py +++ b/controllers/rcj_soccer_referee_supervisor/referee/supervisor.py @@ -47,7 +47,7 @@ def __init__(self): def check_reset_physics_counters(self): # HACK(Richo): Workaround for the following issue - # https://github.com/RoboCupJuniorTC/rcj-soccer-sim/issues/130 + # https://github.com/RoboCupJuniorTC/rcj-soccersim/issues/130 for robot in ROBOT_NAMES: reset_physics_counter = self.robot_reset_physics[robot] if reset_physics_counter > 0: diff --git a/docs/docs/getting_started.md b/docs/docs/getting_started.md index 7e45684..e6fd176 100644 --- a/docs/docs/getting_started.md +++ b/docs/docs/getting_started.md @@ -10,9 +10,9 @@ It's easy, you can set it up in about 10 minutes! 2. Download [Webots](https://www.cyberbotics.com/#download) from their official website. Currently, version R2022a is stable with the Soccer Simulator. You can find detailed installation procedure on the official [Webots Installation guide](https://cyberbotics.com/doc/guide/installation-procedure). -3. Clone the rcj-soccer-sim repository to your computer by downloading the ZIP file from [here](https://github.com/RoboCupJuniorTC/rcj-soccer-sim/archive/master.zip) or running +3. Clone the rcj-soccersim repository to your computer by downloading the ZIP file from [here](https://github.com/RoboCupJuniorTC/rcj-soccersim/archive/master.zip) or running - git clone https://github.com/RoboCupJuniorTC/rcj-soccer-sim.git + git clone https://github.com/RoboCupJuniorTC/rcj-soccersim.git 4. Finally, run Webots, go to `Tools > Preferences > Python command` and set it to `python` or `python3` to point Webots to Python 3. Depending on your system, the reference to Python 3 can be via the command `python` or `python3`. More information on how to configure Webots to work with Python can be found [here](https://cyberbotics.com/doc/guide/using-python). diff --git a/docs/docs/how_to_run_sim.md b/docs/docs/how_to_run_sim.md index 7fb7655..0c3753b 100644 --- a/docs/docs/how_to_run_sim.md +++ b/docs/docs/how_to_run_sim.md @@ -24,7 +24,7 @@ an output in form of either an MPEG-4 video or a HTML site. This guide makes a couple of assumptions: 1. You use an UNIX-like environment (i.e. something like Linux or macOS) -2. You have Webots installed and cloned the `rcj-soccer-sim` repository locally +2. You have Webots installed and cloned the `rcj-soccersim` repository locally (check the [Getting Started](./getting_started.md) guide on how to do so) ## Running Soccer Sim (and Webots) in Automatic Mode @@ -60,21 +60,21 @@ provided by Webots and mentioned in the [official guide](https://cyberbotics.com/doc/guide/installation-procedure#installing-the-docker-image). -Assuming the `rcj-soccer-sim` repository is located in the current directory, +Assuming the `rcj-soccersim` repository is located in the current directory, running Soccer Sim within docker is as simple as executing docker run \ - -v $(pwd)/rcj-soccer-sim:/rcj-soccer-sim \ + -v $(pwd)/rcj-soccersim:/rcj-soccersim \ -e RCJ_SIM_AUTO_MODE=True \ -e RCJ_SIM_REC_FORMATS=x3d \ - cyberbotics/webots:latest /rcj-soccer-sim/run-in-docker.sh /rcj-soccer-sim/worlds/soccer.wbt + cyberbotics/webots:latest /rcj-soccersim/run-in-docker.sh /rcj-soccersim/worlds/soccer.wbt Let us briefly discuss the respective lines. On the first one the `docker` -command starts the Docker container, on the second one, the `rcj-soccer-sim` -folder in the current directory is mapped to `/rcj-soccer-sim` in the +command starts the Docker container, on the second one, the `rcj-soccersim` +folder in the current directory is mapped to `/rcj-soccersim` in the container, on the following two the `RCJ_SIM_AUTO_MODE` and `RCJ_SIM_REC_FORMATS` environment variables are being set and on the last one -the `worlds/soccer.wbt` world from the `rcj-soccer-sim` repository is executed +the `worlds/soccer.wbt` world from the `rcj-soccersim` repository is executed in the Webex environment using the `run-in-docker.sh` script (also part of the very same repository). @@ -82,7 +82,7 @@ very same repository). By default, the output (recording and reflog) of a match is saved in the `reflog/` folder in `controllers/rcj_soccer_referee_supervisor/` of the -`rcj-soccer-sim` repository. This is relatively inconveniet when it comes to +`rcj-soccersim` repository. This is relatively inconveniet when it comes to running multiple games and getting data out of the Docker container and hence the path can be changed using the `RCJ_SIM_OUTPUT_PATH` environment variable. @@ -91,12 +91,12 @@ the container and maps it to the `outputs/` directory in the current working directory on the host: docker run \ - -v $(pwd)/rcj-soccer-sim:/rcj-soccer-sim \ + -v $(pwd)/rcj-soccersim:/rcj-soccersim \ -v $(pwd)/outputs:/tmp/outputs \ -e RCJ_SIM_AUTO_MODE=True \ -e RCJ_SIM_REC_FORMATS=x3d \ -e RCJ_SIM_OUTPUT_PATH=/tmp/outputs/ \ - cyberbotics/webots:latest /rcj-soccer-sim/run-in-docker.sh /rcj-soccer-sim/worlds/soccer.wbt + cyberbotics/webots:latest /rcj-soccersim/run-in-docker.sh /rcj-soccersim/worlds/soccer.wbt ## Environment variables