Skip to content

Latest commit

 

History

History
113 lines (94 loc) · 6.03 KB

Build.md

File metadata and controls

113 lines (94 loc) · 6.03 KB
Raw

Build / Install Instructions

Install on all platforms using vcpkg

You can download and install assimp using the vcpkg dependency manager:

    git clone https://github.com/Microsoft/vcpkg.git
    cd vcpkg
    ./bootstrap-vcpkg.sh
    ./vcpkg integrate install
    ./vcpkg install assimp

The assimp port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please create an issue or pull request on the vcpkg repository.

Install on Ubuntu

You can install the Asset-Importer-Lib via apt:

sudo apt-get update
sudo apt-get install libassimp-dev

Install pyassimp

You need to have pip installed:

pip install pyassimp

Manual build instructions

Install CMake

Asset-Importer-Lib can be built for a lot of different platforms. We are using cmake to generate the build environment for these via cmake. So you have to make sure that you have a working cmake-installation on your system. You can download it at https://cmake.org/ or for linux install it via

sudo apt-get install cmake

Get the source

Make sure you have a working git-installation. Open a command prompt and clone the Asset-Importer-Lib via:

git clone https://github.com/assimp/assimp.git

Build from source:

cd assimp
cmake CMakeLists.txt 
cmake --build .

Note that by default this builds a shared library into the bin directory. If you want to build it as a static library see the build options at the bottom of this file.

Build instructions for Windows with Visual-Studio

First, you have to install Visual-Studio on your windows-system. You can get the Community-Version for free here: https://visualstudio.microsoft.com/de/downloads/ To generate the build environment for your IDE open a command prompt, navigate to your repo and type:

cmake CMakeLists.txt

This will generate the project files for the visual studio. All dependencies used to build Asset-Importer-Lib shall be part of the repo. If you want to use you own zlib installation this is possible as well. Check the options for it.

Build instructions for Windows with UWP

See https://stackoverflow.com/questions/40803170/cmake-uwp-using-cmake-to-build-universal-windows-app

Build instructions for Linux / Unix

Open a terminal and got to your repository. You can generate the makefiles and build the library via:

cmake CMakeLists.txt
make -j4

The option -j describes the number of parallel processes for the build. In this case make will try to use 4 cores for the build.

If you want to use an IDE for linux you can try QTCreator for instance.

Build instructions for MinGW

Older versions of MinGW's compiler (e.g. 5.1.0) do not support the -mbig_obj flag required to compile some of assimp's files, especially for debug builds. Version 7.3.0 of g++-mingw-w64 & gcc-mingw-w64 appears to work.

Please see CMake Cross Compiling for general information on CMake Toolchains.

Some users have had success building assimp using MinGW on Linux using polly.

The following toolchain, which is not maintained by assimp, seems to work on Linux: linux-mingw-w64-gnuxx11.cmake

The following toolchain may or may not be helpful for building assimp using MinGW on Windows (untested): mingw-cxx17.cmake

Besides the toolchain, compilation should be the same as for Linux / Unix.

CMake build options

The cmake-build-environment provides options to configure the build. The following options can be used:

  • ASSIMP_HUNTER_ENABLED (default OFF): Enable Hunter package manager support.
  • BUILD_SHARED_LIBS (default ON): Generation of shared libs (dll for windows, so for Linux). Set this to OFF to get a static lib.
  • ASSIMP_BUILD_FRAMEWORK (default OFF, MacOnly): Build package as Mac OS X Framework bundle.
  • ASSIMP_DOUBLE_PRECISION (default OFF): All data will be stored as double values.
  • ASSIMP_OPT_BUILD_PACKAGES (default OFF): Set to ON to generate CPack configuration files and packaging targets.
  • ASSIMP_ANDROID_JNIIOSYSTEM (default OFF): Android JNI IOSystem support is active.
  • ASSIMP_NO_EXPORT (default OFF): Disable Assimp's export functionality.
  • ASSIMP_BUILD_ZLIB (default OFF): Build our own zlib.
  • ASSIMP_BUILD_ALL_EXPORTERS_BY_DEFAULT (default ON): Build Assimp with all exporters enabled.
  • ASSIMP_BUILD_ALL_IMPORTERS_BY_DEFAULT (default ON): Build Assimp with all importers enabled.
  • ASSIMP_BUILD_ASSIMP_TOOLS (default OFF): If the supplementary tools for Assimp are built in addition to the library.
  • ASSIMP_BUILD_SAMPLES (default OFF): If the official samples are built as well (needs Glut).
  • ASSIMP_BUILD_TESTS (default ON): If the test suite for Assimp is built in addition to the library.
  • ASSIMP_COVERALLS (default OFF): Enable this to measure test coverage.
  • ASSIMP_INSTALL (default ON): Install Assimp library. Disable this if you want to use Assimp as a submodule.
  • ASSIMP_WARNINGS_AS_ERRORS (default ON): Treat all warnings as errors.
  • ASSIMP_ASAN (default OFF): Enable AddressSanitizer.
  • ASSIMP_UBSAN (default OFF): Enable Undefined Behavior sanitizer.
  • ASSIMP_BUILD_DOCS (default OFF): Build documentation using Doxygen. OBSOLETE, see https://github.com/assimp/assimp-docs
  • ASSIMP_INJECT_DEBUG_POSTFIX (default ON): Inject debug postfix in .a/.so/.lib/.dll lib names
  • ASSIMP_IGNORE_GIT_HASH (default OFF): Don't call git to get the hash.
  • ASSIMP_INSTALL_PDB (default ON): Install MSVC debug files.
  • USE_STATIC_CRT (default OFF): Link against the static MSVC runtime libraries.
  • ASSIMP_BUILD_DRACO (default OFF): Build Draco libraries. Primarily for glTF.
  • ASSIMP_BUILD_ASSIMP_VIEW (default ON, if DirectX found, OFF otherwise): Build Assimp view tool (requires DirectX).