Update README

This commit is contained in:
nsubiron 2017-07-27 13:00:09 +02:00
parent 001f97f8a3
commit a1a11ec93e
1 changed files with 48 additions and 40 deletions

View File

@ -1,48 +1,56 @@
CARLA UE4 Plugin
================
CARLA
=====
Plugin for Unreal Engine 4.
See [CHANGELOG](CHANGELOG.md).
Setup
-----
#### Linux
The following has been tested only in Ubuntu 16.04.
Install clang 3.9
sudo apt-get install -y build-essential
wget -O - http://apt.llvm.org/llvm-snapshot.gpg.key|sudo apt-key add -
sudo apt-get update
sudo apt-get install -y clang-3.9 clang++-3.9
You may need to change your default clang version to compile Unreal
sudo ln -s /usr/bin/clang-3.9 /usr/bin/clang
sudo ln -s /usr/bin/clang++-3.9 /usr/bin/clang++
Download and install Unreal Engine 4.15
git clone --depth=1 -b 4.15 https://github.com/Epic... ~/UnrealEngine_4.15
cd ~/UnrealEngine_4.15
./Setup.sh && ./GenerateProjects.sh && make
Clone CARLA to your project
cd path/to/your/ue4-project
mkdir -p Plugins && cd Plugins
git clone --depth=1 ...... Carla
cd Carla
Now run Setup,sh (will build all the dependencies, takes a while) and make
./Setup.sh
make
Recommended to do a check to see if everything worked fine
make check
Now build your project with Unreal normally.
#### Windows
Not yet available.
Run-time settings
-----------------
See [Resources/Example.CarlaSettings.ini](Resources/Example.CarlaSettings.ini).
Compiling a UE4 project with CARLA plugin
-----------------------------------------
Clone or copy the files of this repository under the folder
`<project-root>/Plugins/Carla`.
Build CarlaServer located at `<project-root>/Plugins/Carla/Source/CarlaServer`,
follow the instructions [here](Source/CarlaServer/README.md) to build all the
necessary dependencies too.
Now compile the Unreal project.
#### Linux
Opening the .uproject file with UE4Editor usually triggers a recompile. If not
you can follow the next steps to do it manually.
Generate project files
$ <unreal-installation-path>/GenerateProjectFiles.sh -project="<full-path-to-the-project-root-folder>/<project-name>.uproject" -game -engine
Build project in the in-editor configuration
$ cd <project-root-folder>
$ make <project-name>Editor
Now you can launch the editor.
#### Windows
Usually double-clicking the .uproject file triggers a recompile.
To build from Visual Studio, right-click the project file and select "Generate
Visual Studio Files". Open the generated solution (.sln) and compile. You can
change the build configuration to development/debug both in-editor and
standalone game.