Update documentation
This commit is contained in:
nsubiron
parent
361ba17a40
commit
12d994707a
|
|
@ -4,10 +4,11 @@ CARLA Server
|
|||
Build
|
||||
-----
|
||||
|
||||
Some scripts are provided for building CarlaServer on Linux
|
||||
Some scripts are provided for building and testing CarlaServer on Linux
|
||||
|
||||
$ Setup.sh
|
||||
$ make
|
||||
$ make check
|
||||
|
||||
The setup script downloads and compiles all the required dependencies. The
|
||||
Makefile calls CMake to build CarlaServer and installs it under "Util/Install".
|
||||
|
|
|
|||
|
|
@ -16,6 +16,5 @@ hierarchy overriding earlier values.
|
|||
Take a look at the [CARLA Settings example](Example.CarlaSettings.ini).
|
||||
|
||||
IMPORTANT: If you are in editor, you most probably want to disable networking.
|
||||
Otherwise the game will hang until a client connects. Copy
|
||||
"Example.CarlaSettings.ini" to "CARLAUE4/Config/CarlaSettings.ini" and set
|
||||
`UseNetworking=false`.
|
||||
Otherwise the game will hang until a client connects. Set `UseNetworking=false`
|
||||
in "./Unreal/CarlaUE4/Config/CarlaSettings.ini".
|
||||
|
|
|
|||
|
|
@ -1,12 +1,6 @@
|
|||
How to add assets
|
||||
=================
|
||||
|
||||
Static content should be added to `Content/Static` to be processed as LFS.
|
||||
Static content includes
|
||||
|
||||
* Files that once added won't change (often), like the meshes, materials, etc.
|
||||
* Big files (~ >1MB).
|
||||
|
||||
Adding a vehicle
|
||||
----------------
|
||||
|
||||
|
|
|
|||
|
|
@ -41,31 +41,36 @@ Check Unreal's documentation
|
|||
["Building On Linux"](https://wiki.unrealengine.com/Building_On_Linux) if any of
|
||||
the steps above fail.
|
||||
|
||||
Setup CARLA plugin
|
||||
------------------
|
||||
Build CARLA
|
||||
-----------
|
||||
|
||||
Go to "CARLAUE4/Plugins/Carla" folder and run the setup script. This downloads
|
||||
and compile all the dependencies, takes a while
|
||||
Run the setup script to download the content and build all dependencies. It
|
||||
takes a while
|
||||
|
||||
$ ./Setup.sh
|
||||
|
||||
Now you can use the Makefile to compile and test the code. However, the rebuild
|
||||
script of the main project will do that already, see next section.
|
||||
Download Epic Games' Automotive Materials package and install it under
|
||||
"Unreal/CarlaUE4/Content/AutomotiveMaterials".
|
||||
[How to download automotive materials](how_to_download_automotive_materials.md).
|
||||
|
||||
You can run the unit tests to check if everything worked fine (note that these
|
||||
tests launch the python client, they require python3 and protobuf for python3
|
||||
installed)
|
||||
NOTE: Due to license restrictions, pedestrians are not include in the CARLA open
|
||||
source project (only in the compiled binaries). Some warnings may appear when
|
||||
starting the project related to this. We are working to find a solution.
|
||||
|
||||
$ make check
|
||||
|
||||
Build and launch CARLAUE4
|
||||
-------------------------
|
||||
|
||||
In the root folder of CARLAUE4 you can find "Rebuild.sh" script. This deletes
|
||||
all intermediate files, rebuilds whole CARLA, and launches the editor. Use it
|
||||
every time you update CARLA.
|
||||
To build CARLA, use the rebuild script. This script deletes all intermediate
|
||||
files, rebuilds whole CARLA, and launches the editor. Use it too for making a
|
||||
clean rebuild of CARLA
|
||||
|
||||
$ UE4_ROOT=~/UnrealEngine_4.17 ./Rebuild.sh
|
||||
|
||||
It looks at the environment variable `UE4_ROOT` to find the right version of
|
||||
Unreal Engine. You can also add this variable to your "~/.bashrc" or similar.
|
||||
|
||||
Test (Optional)
|
||||
---------------
|
||||
|
||||
A set of unit tests is available for testing the CarlaServer library (note that
|
||||
these tests launch the python client, they require python3 and protobuf for
|
||||
python3 installed, as well as ports 2000 and 4000 available)
|
||||
|
||||
$ make check
|
||||
|
|
|
|||
|
|
@ -1,66 +1,4 @@
|
|||
How to build CARLA on Windows
|
||||
=============================
|
||||
|
||||
**Building CARLA on Windows is not yet fully supported. Compilation is tedious
|
||||
and fails often. We recommend to use the Linux version if possible.**
|
||||
|
||||
Install Unreal Engine 4.17 and Visual Studio 2015. (Later versions of Visual
|
||||
Studio work, but you will need to adapt "Rebuild.bat" to find the right
|
||||
"vcvarsall.bat").
|
||||
|
||||
For running Rebuild.bat some Linux utilities are required (like make, cmake,
|
||||
rm...), it is recommended to install Cygwin or a similar environment.
|
||||
|
||||
Setup CARLA plugin
|
||||
------------------
|
||||
|
||||
A setup script is not yet available. You need to compile yourself boost,
|
||||
protobuf and googletest, and install them under ./Util/Build as
|
||||
|
||||
Util/
|
||||
Build/
|
||||
boost-install/
|
||||
googletest-install/
|
||||
protobuf-install/
|
||||
|
||||
|
||||
You can also download the precompiled binaries of these libraries
|
||||
[here](http://datasets.cvc.uab.es/CARLA/CarlaUE4_Dependencies_Win64.zip)
|
||||
(requires password).
|
||||
|
||||
Some Unix utilities need to be installed for the build system to work, including
|
||||
Make and CMake.
|
||||
|
||||
Build and launch CARLAUE4
|
||||
-------------------------
|
||||
|
||||
Once the dependencies are there, you just need to run the rebuild script
|
||||
(double-click works). This script deletes all intermediate files, rebuilds CARLA
|
||||
plugin, and launches the editor. You will be prompted a couple of times.
|
||||
|
||||
$ Rebuild.bat
|
||||
|
||||
If it warns you about plugin CARLA not being compatible, ignore the warning and
|
||||
do not disable the plugin.
|
||||
|
||||
If the rebuild script fails, you will need to
|
||||
[build CARLA plugin](#Build CARLA Plugin) yourself. Then build CARLAUE4 from
|
||||
Visual Studio.
|
||||
|
||||
Other
|
||||
-----
|
||||
|
||||
#### Build CARLA Plugin
|
||||
|
||||
Go to the folder CARLAUE4/Plugins/Carla, and open a terminal there.
|
||||
|
||||
Dependencies need to be installed under ./Util/Build.
|
||||
|
||||
Configure your environment running "vcvarsall.bat". For Visual Studio 2015, this
|
||||
script is located at (don't forget the "amd64" part)
|
||||
|
||||
$ "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\vcvarsall.bat" amd64
|
||||
|
||||
Then run make
|
||||
|
||||
$ make
|
||||
Coming soon...
|
||||
|
|
|
|||
|
|
@ -0,0 +1,16 @@
|
|||
How to download automotive materials
|
||||
====================================
|
||||
|
||||
Epic Games' [Automotive Materials][automatlink] package can be downloaded for
|
||||
free from the Unreal Engine Marketplace.
|
||||
|
||||
NOTE: Unfortunately, Unreal's Marketplace is only available on Windows, so you
|
||||
need a Windows machine to download this package.
|
||||
|
||||
1. Install Epic Games Launcher from [www.unrealengine.com](https://www.unrealengine.com).
|
||||
2. Buy the [Automotive Materials][automatlink] package for $0.
|
||||
3. Create a new dummy project and add the Automotive Materials package to it.
|
||||
4. Inside the "Content" folder of the newly created project, you can find the "AutomotiveMaterials" folder. Copy this folder to the CARLA project
|
||||
- `{NewProject}/Content/AutomotiveMaterials` --> `{CARLA}/Unreal/CarlaUE4/Content/AutomotiveMaterials`
|
||||
|
||||
[automatlink]: https://www.unrealengine.com/marketplace/automotive-material-pack
|
||||
|
|
@ -1,43 +1,4 @@
|
|||
How to make a release
|
||||
=====================
|
||||
|
||||
Increase version
|
||||
----------------
|
||||
|
||||
* CarlaUE4/Plugins/Carla
|
||||
- Increase version in `Plugins/Carla/Carla.uplugin`.
|
||||
- Update `Plugins/Carla/CHANGELOG.md`.
|
||||
- Commit changes.
|
||||
- Add tag, `git tag -a X.X.X`, this opens a text editor, fill in the latest adds in CHANGELOG.md.
|
||||
- `git push && git push --tags`
|
||||
|
||||
* CarlaUE4
|
||||
- Increase version in `Config/DefaultGame.ini` (try to keep same version as in plugin).
|
||||
- Update `CHANGELOG.md`.
|
||||
- Commit changes, including the latest commit to the Carla plugin.
|
||||
- Add tag, `git tag -a X.X.X`, this opens a text editor, fill in the latest adds in CHANGELOG.md.
|
||||
- `git push && git push --tags`
|
||||
|
||||
Build and package latest version
|
||||
--------------------------------
|
||||
|
||||
* Pull latest version of CarlaUE4 AND Plugins/Carla (probably should be on branch dev)
|
||||
- `git pull && (cd Plugins/Carla/ && git pull)`
|
||||
* Run `./Rebuild.sh`, this deletes all intermediate data and rebuilds CarlaServer and CarlaUE4 (including plugins). It will launch the editor when it's done.
|
||||
* Remove or comment-out `Config/CarlaSettings.ini`
|
||||
* For each level that is going to be packaged
|
||||
- Open the level, select the road generator
|
||||
- Check "Save Road Map to Disk"
|
||||
- Press "Trigger Road Map Generation"
|
||||
* On the top-left menu select "File > Package Project > Linux", select the folder in which Unreal will generate the build. This will take a while.
|
||||
* Go to `<path-you-select-for-packaging>/LinuxNoEditor`, copy there the following files
|
||||
- `Plugins/Carla/Docs/release_readme.md` --> `README.md`
|
||||
- `Plugins/Carla/Docs/Example.CarlaSettings.ini` --> `CarlaSettings.ini`
|
||||
- `Saved/<level-name>.png` --> `<level-name>.png`
|
||||
- `Saved/<level-name>.txt` --> `<level-name>.txt`
|
||||
* Generate the archive `CARLAUE4_X.X.X.tag.gz` with all the files in the folder (where X.X.X is the latest version number).
|
||||
* Copy it to
|
||||
- `//NASBACKUP/synthia-bck/CARLA/Releases/CARLAUE4_X.X.X.tag.gz`
|
||||
- `//NASBACKUP/synthia-www/CARLA/CARLAUE4_X.X.X.tag.gz`
|
||||
* Done :)
|
||||
|
||||
Coming soon...
|
||||
|
|
|
|||
|
|
@ -1,34 +1,15 @@
|
|||
CARLA Documentation
|
||||
===================
|
||||
|
||||
This is the documentation of both CARLAUE4 and the CARLA plugin.
|
||||
#### Using CARLA
|
||||
|
||||
The _CARLA plugin_ is a plugin for Unreal Engine 4.17 that contains most of the
|
||||
code and functionality of CARLA. It is meant to be independent of the project
|
||||
assets, although some parts are designed with the current assets in mind. It can
|
||||
be added to any project and provides the base classes to be used in your
|
||||
project.
|
||||
* [How to run CARLA server and client](release_readme.md)
|
||||
* [CARLA Settings](carla_settings.md)
|
||||
|
||||
_CARLAUE4_ is an Unreal Engine project containing all the assets and mounted
|
||||
scenes. It includes the CARLA plugin.
|
||||
#### Compiling
|
||||
|
||||
To download the whole project use [git lfs](https://git-lfs.github.com/)
|
||||
(replace `<user>` with your bitbucket username)
|
||||
|
||||
git lfs clone --recursive https://<user>@bitbucket.org/carla-cvc/carla-ue4.git CarlaUE4
|
||||
|
||||
Once CARLA is built, be sure to configure
|
||||
[CARLA Settings](carla_settings.md) before hitting play.
|
||||
|
||||
Index
|
||||
-----
|
||||
|
||||
#### Setup
|
||||
|
||||
* [How to run CarlaUE4 binary](release_readme.md)
|
||||
* [How to build on Linux](how_to_build_on_linux.md)
|
||||
* [How to build on Windows](how_to_build_on_windows.md)
|
||||
* [CARLA Settings](carla_settings.md)
|
||||
|
||||
#### Development
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue