Skip to content

Add Source CARLA Windows build documentation #139

@YuSun-go

Description

@YuSun-go

Which module or test case is this related to?
CARLA integration and co-simulation setup within FIX framework (CarlaEnv / SUMO–CARLA workflow)


Describe the issue
The current repository lacks clear and complete documentation for building CARLA on Windows from source.
Users may encounter difficulties due to:

  • Multiple CARLA versions (e.g., 0.9.15 vs 0.9.16) and tag selection
  • Dependency requirements (Visual Studio, Unreal Engine, Python environment)
  • Build steps (setup.bat, make PythonAPI, make launch, make package)

As a result, new users may face build failures or confusion when building Source Carla version on Windows.


Suggested change
Add a structured markdown documentation that provides:

  • Step-by-step instructions to build CARLA on Windows from source
  • Clear explanation of required dependencies and environment setup
  • Guidance on selecting the correct CARLA version/tag
  • Common issues and troubleshooting tips

Environment (if relevant to documentation)

  • Python version: 3.10
  • C++ compiler: Visual Studio 2019 (x64) !!!
  • CARLA version: 0.9.15 (source build) !!!
  • Unreal Engine version: 4.26 (recommended for CARLA 0.9.x) !!!
  • OS: Windows 10/11 !!!

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions