Skip to content

Commit

Permalink
updated readme for precompiled versions
Browse files Browse the repository at this point in the history
  • Loading branch information
WouterJansen committed Jul 15, 2024
1 parent 708c820 commit 24525ef
Show file tree
Hide file tree
Showing 7 changed files with 116 additions and 53 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,12 @@ You can also find the presentation of the live tutorial of Cosys-AirSim at ANNSI
Some more details on our changes can be found in the [changelog](https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/CHANGELOG.md).

## How to Get It
This branch uses a custom Unreal Engine version! Please read the documentation carefully.


### Windows
#### Download and install from precompiled plugin - Windows/Linux
* [Download and install it](https://cosys-lab.github.io/install_precompiled)
#### Install and use from source - Windows
* [Install/Build it](https://cosys-lab.github.io/install_windows)
### Linux
#### Install and use from source - Linux
* [Install/Build it](https://cosys-lab.github.io/install_linux)

## How to Use It
Expand Down
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,12 @@ You can also find the presentation of the live tutorial of Cosys-AirSim at ANNSI
Some more details on our changes can be found in the [changelog](https://github.com/Cosys-Lab/Cosys-AirSim/blob/main/CHANGELOG.md).

## How to Get It
This branch uses a custom Unreal Engine version! Please read the documentation carefully.


### Windows
#### Download and install from precompiled plugin - Windows/Linux
* [Download and install it](https://cosys-lab.github.io/install_precompiled)
#### Install and use from source - Windows
* [Install/Build it](https://cosys-lab.github.io/install_windows)
### Linux
#### Install and use from source - Linux
* [Install/Build it](https://cosys-lab.github.io/install_linux)

## How to Use It
Expand Down
8 changes: 8 additions & 0 deletions docs/install_precompiled.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Download and install precompiled Plugin

If you wish to not build the plugin from source, you can download the precompiled plugin from the [releases page](https://github.com/Cosys-Lab/Cosys-AirSim/releases) for the right version of Unreal you are using.
It does not come with a environment so you will need to create your own Unreal project. Follow this [step-by-step guide](unreal_custenv.md).

The releases page also comes with additional downloads and links to the several API implementations for ROS(2) and the Python and Matlab API clients for that specific version of the Cosys-AirSim plugin.


24 changes: 11 additions & 13 deletions docs/unreal_blocks.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,36 @@

# Setup Blocks Environment for AirSim

Blocks environment is available in repo in folder `Unreal/Environments/Blocks` and is designed to be lightweight in size. That means its very basic but fast.
Blocks environment is available in repo in folder `Unreal/Environments/Blocks` and is designed to be lightweight in size. That means it is very basic but fast.

Here are quick steps to get Blocks environment up and running:

## Windows
## Windows from Source

1. Make sure you have [built or installed Unreal and built AirSim](install_windows.md).
2. Navigate to folder `AirSim\Unreal\Environments\Blocks` and run `update_from_git.bat`.
3. Double click on generated .sln file to open in Visual Studio.
4. Make sure `Blocks` project is the startup project, build configuration is set to `DebugGame_Editor` and `Win64`. Hit F5 to run.
5. Press the Play button in Unreal Editor and you will see something like in below video. Also see the other documentation for how to use it.
4. Make sure `Blocks` project is the startup project, build configuration is set to `DevelopmentEditor_Editor` and `Win64`. Hit F5 to run.
5. Press the Play button in Unreal Editor. Also see the other documentation for how to use it.

### Changing Code and Rebuilding
For Windows, you can just change the code in Visual Studio, press F5 and re-run. There are few batch files available in folder `AirSim\Unreal\Environments\Blocks` that lets you sync code, clean etc.

## Linux
## Linux from Source
1. Make sure you have [built or installed the Unreal Engine and AirSim](install_linux.md).
2. Navigate to folder `AirSim\Unreal\Environments\Blocks` and run `update_from_git.sh`.
3. Navigate to your UnrealEngine repo folder and run `Engine/Binaries/Linux/UE4Editor` which will start Unreal Editor.
4. On first start you might not see any projects in UE4 editor. Click on Projects tab, Browse button and then navigate to `AirSim/Unreal/Environments/Blocks/Blocks.uproject`.
5. If you get prompted for incompatible version and conversion, select In-place conversion which is usually under "More" options. If you get prompted for missing modules, make sure to select No so you don't exit.
5. If you get prompted for incompatible version and conversion, select In-place conversion which is usually under "More" options. If you get prompted for missing modules, make sure to select _No_, so you don't exit.
6. Finally, when prompted with building AirSim, select Yes. Now it might take a while so go get some coffee :).
7. Press the Play button in Unreal Editor and you will see something like in below video. Also see the other documentation for how to use it.

[![Blocks Demo Video](images/blocks_video.png)](https://www.youtube.com/watch?v=-r_QGaxMT4A)
7. Press the Play button in Unreal Editor. Also see the other documentation for how to use it.

### Changing Code and Rebuilding
For Linux, make code changes in AirLib or Unreal/Plugins folder and then run `./build.sh` to rebuild. This step also copies the build output to Blocks sample project. You can then follow above steps again to re-run.

## Chosing Your Vehicle: Car or Multirotor
By default AirSim spawns multirotor. You can easily change this to car and use all of AirSim goodies. Please see [using car](using_car.md) guide.
## Choosing Your Vehicle: Car or Multirotor
By default, AirSim spawns multirotor. You can easily change this to car and use all of AirSim goodies. Please see [using car](using_car.md) guide.

## FAQ
#### I see warnings about like "_BuitData" file is missing.
These are intermediate files and you can safely ignore it.
#### I see warnings about like "_BuiltData" file is missing.
These are intermediate files and, you can safely ignore it.
Loading

0 comments on commit 24525ef

Please sign in to comment.