From 832d02a418a61ad46c7e863dfca95158fd0c790f Mon Sep 17 00:00:00 2001 From: Wouter Heerwegh Date: Tue, 20 Sep 2022 16:01:48 +0200 Subject: [PATCH] Docs version changes --- UE4Project/Config/DefaultGame.ini | 1 + docker/download_FSDSSimulator_binary.sh | 6 +++--- docs/docker_ubuntu.md | 8 ++++---- docs/getting-started-with-ros.md | 2 +- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/UE4Project/Config/DefaultGame.ini b/UE4Project/Config/DefaultGame.ini index c681bf8d..c22ce7d1 100644 --- a/UE4Project/Config/DefaultGame.ini +++ b/UE4Project/Config/DefaultGame.ini @@ -8,6 +8,7 @@ LicensingTerms=GPL V2 ProjectDisplayedTitle=NSLOCTEXT("[/Script/EngineSettings]", "8F8B6B2A472F9FDFB69E2B8CFAE8C4E0", "Formula Student Driverless Simulator") ProjectDebugTitleInfo=NSLOCTEXT("[/Script/EngineSettings]", "F31D7C524A9E9BC66DD2AA922D309408", "Formula Student Driverless Simulator (debug)") CopyrightNotice=This program is free software; you can redistribute it and/ormodify it under the terms of the GNU General Public License as published by the Free Software Foundation +ProjectVersion=2.2.0 [/Script/UnrealEd.ProjectPackagingSettings] Build=IfProjectHasCode diff --git a/docker/download_FSDSSimulator_binary.sh b/docker/download_FSDSSimulator_binary.sh index d7256120..26fb725c 100644 --- a/docker/download_FSDSSimulator_binary.sh +++ b/docker/download_FSDSSimulator_binary.sh @@ -1,5 +1,5 @@ # Shell script to download Simulator bins from github; For custom versions of simulator path has to be updated sudo apt-get install unzip -wget -c https://github.com/FS-Driverless/Formula-Student-Driverless-Simulator/releases/download/v2.1.0/fsds-v2.1.0-linux.zip -unzip fsds-v2.1.0-linux.zip -rm fsds-v2.1.0-linux.zip \ No newline at end of file +wget -c https://github.com/FS-Driverless/Formula-Student-Driverless-Simulator/releases/download/v2.2.0/fsds-v2.2.0-linux.zip +unzip fsds-v2.2.0-linux.zip +rm fsds-v2.2.0-linux.zip \ No newline at end of file diff --git a/docs/docker_ubuntu.md b/docs/docker_ubuntu.md index 5c365883..dac79b4b 100644 --- a/docs/docker_ubuntu.md +++ b/docs/docker_ubuntu.md @@ -30,7 +30,7 @@ After building the image, verify that the image exists by runnig: ``` #### Run FSDS inside the Docker container -Get [the binary](https://github.com/FS-Driverless/Formula-Student-Driverless-Simulator/releases/download/v2.1.0/fsds-v2.1.0-linux.zip), or package your own project in Ubuntu. +Get [the binary](https://github.com/FS-Driverless/Formula-Student-Driverless-Simulator/releases/download/v2.2.0/fsds-v2.2.0-linux.zip), or package your own project in Ubuntu. You can either download the latest version yourself, or use the `download_FSDSSimulator_binary.sh` helper script. Now, run fsds inside the Docker container: @@ -41,15 +41,15 @@ Now, run fsds inside the Docker container: Replace the variables as follows: * `DOCKER_IMAGE_NAME`: Same as `target_image` parameter in previous step. By default, enter `fsdsairsim_binary:vulkan-ubuntu18.04` - * `UNREAL_BINARY_SHELL_SCRIPT`: for FSDSsimulator enviroment, it will be `fsds-v2.1.0-linux/FSDS.sh` + * `UNREAL_BINARY_SHELL_SCRIPT`: for FSDSsimulator enviroment, it will be `fsds-v2.2.0-linux/FSDS.sh` * `UNREAL_BINARY_ARGUMENTS`: For FSDSsimulator, most relevant would be `-windowed`, `-ResX`, `-ResY`. [See here all options](https://docs.unrealengine.com/en-us/Programming/Basics/CommandLineArguments). -For FSDSsimulator, you can do a `$ ./run_airsim_image_binary.sh fsdsairsim_binary:vulkan-ubuntu18.04 fsds-v2.1.0-linux/FSDS.sh -windowed -ResX=1080 -ResY=720` +For FSDSsimulator, you can do a `$ ./run_airsim_image_binary.sh fsdsairsim_binary:vulkan-ubuntu18.04 fsds-v2.2.0-linux/FSDS.sh -windowed -ResX=1080 -ResY=720` To run in headless mode, use suffix `-- headless` at the end: ```bash -$ ./run_airsim_image_binary.sh fsds-v2.1.0-linux/FSDS.sh -- headless +$ ./run_airsim_image_binary.sh fsds-v2.2.0-linux/FSDS.sh -- headless ``` You need to have a `settings.json` file in the current working directory from where you run `./run_airsim_image_binary.sh`. \ No newline at end of file diff --git a/docs/getting-started-with-ros.md b/docs/getting-started-with-ros.md index 8066ae75..f933aba3 100644 --- a/docs/getting-started-with-ros.md +++ b/docs/getting-started-with-ros.md @@ -45,7 +45,7 @@ ln -s /mnt/c/Users/developer/Formula-Student-Driverless-Simulator ~/Formula-Stud ``` Now, checkout the version equal to the simulator. -If you are running for example simulator packaged version v2.1.0, run `git checkout tags/v2.1.0` to get the ROS brige to the same version +If you are running for example simulator packaged version v2.2.0, run `git checkout tags/v2.2.0` to get the ROS brige to the same version ## Preparing AirLib