Skip to content

Latest commit

 

History

History
197 lines (147 loc) · 6.32 KB

BuildPlugins.md

File metadata and controls

197 lines (147 loc) · 6.32 KB
Raw

Building Plugins

  1. Windows
  2. Mac OSX
  3. Linux
  4. Prebuilt External Libraries
  5. Tips

Building on Windows

Prerequisites (Win)

  1. Install cmake version 3.18 or later.
    Make sure to choose one of the "Add CMake to the System PATH ..." options as shown below.
    CMakeInstallation

  2. Install Visual Studio 2017.

  3. Install git. For example: SourceTree

  4. Build Poco (static libraries).

    • Download Poco 1.10.1 and extract the file in a folder.
    • Start "Developer Command Prompt for VS 2017" and go to where Poco was extracted.
    • Execute the following in the command prompt:
    $ mkdir cmake-build
$ cd cmake-build
$ cmake .. -DBUILD_SHARED_LIBS=OFF -G "Visual Studio 15 2017" -A x64
$ cmake --build . --config Release && cmake --build . --config Debug

    To build Poco libraries with other configurations, see Poco's Getting Started.

  5. Add Poco_DIR environment variable to point to the Poco root folder above.

Build Steps (Win)

Start "Developer Command Prompt for VS 2017" and execute the following:

$ git clone https://github.com/unity3d-jp/MeshSync
$ cd MeshSync\Plugin~\Build
$ cmake -G "Visual Studio 15 2017" -A x64 ..
$ msbuild MeshSyncPlugin.sln /t:Build /p:Configuration=Release /p:Platform=x64 /m /nologo

For a regular "Command Prompt", there is a script: VsDevCmd_2017.bat under the Build folder, which if executed, will turn the prompt into a "Developer Command Prompt for VS 2017".

Notes

The build process will try to link againts Poco's release libraries in the following order:

  1. Release
  2. MinSizeRel
  3. RelWithDebInfo

Building on Mac OSX

Prerequisites (Mac)

  1. Install XCode.

  2. Install XCode Command Line tools.

    xcode-select --install

  3. Install Homebrew.

  4. Install cmake version 3.20.4 or later.

    brew install cmake

  5. Install git. For example: SourceTree

  6. Build Poco (static libraries).

    • Download Poco 1.10.1 and extract the file in a folder.
    • Open a terminal and go to where Poco was extracted.
    • Execute the following in the command prompt:
    $ mkdir cmake-build
$ cd cmake-build
$ cmake .. -DBUILD_SHARED_LIBS=OFF -DCMAKE_BUILD_TYPE=Release && cmake --build . 
$ cmake .. -DBUILD_SHARED_LIBS=OFF -DCMAKE_BUILD_TYPE=Debug && cmake --build .

    For other types of Poco configurations, see Poco's Getting Started.

  7. Add Poco_DIR environment variable to point to the Poco root folder above. For example:

    export Poco_DIR=~/MySDK/poco

    It might be convenient to add this command to ~/.bash_profile.

  8. Install tbb via Homebrew

    $ brew install tbb

    Currently, the used version is stable 2020_U1.

Build Steps (Mac)

Open a terminal and execute the following

$ git clone https://github.com/unity3d-jp/MeshSync
$ cd MeshSync/Plugin~/Build
$ cmake -GXcode ..
$ xcodebuild -scheme mscore -configuration Release build

Building on Linux

Prerequisites (Linux)

  1. Make sure C++17 development is supported, and define CC and CXX environment variables to point to C++17 dev tools.
    For example, by installing devtoolset-7 in in CentOS 7, and then defining CC and CXX environment variables as follows:

    export CC=/opt/rh/devtoolset-7/root/usr/bin/gcc
export CXX=/opt/rh/devtoolset-7/root/usr/bin/g++

  2. Install cmake version 3.18 or later.
    Example:

    wget https://github.com/Kitware/CMake/releases/download/v3.18.4/cmake-3.18.4.tar.gz    
tar zxvf cmake-3.18.4.tar.gz
cd cmake-3.18.4
./bootstrap --prefix=/usr/local
make -j$(nproc)
make install

  3. Install git.

  4. Build Poco (static libraries).

    • Download Poco 1.10.1 and extract the file in a folder.
    • Open a terminal and go to where Poco was extracted.
    • Execute the following in the command prompt:
    $ mkdir cmake-build
$ cd cmake-build
$ cmake .. -DBUILD_SHARED_LIBS=OFF -DCMAKE_BUILD_TYPE=Release -DCMAKE_POSITION_INDEPENDENT_CODE=ON && cmake --build . 
$ cmake .. -DBUILD_SHARED_LIBS=OFF -DCMAKE_BUILD_TYPE=Debug -DCMAKE_POSITION_INDEPENDENT_CODE=ON && cmake --build .

    For other types of Poco configurations, see Poco's Getting Started.

  5. Add Poco_DIR environment variable to point to the Poco root folder above. For example:

    export Poco_DIR=~/MySDK/poco

    It might be convenient to add this command to ~/.bash_profile.

Build Steps (Linux)

Open a terminal and execute the following

$ git clone https://github.com/unity3d-jp/MeshSync
$ cd MeshSync/Plugin~/Build
$ cmake .. -DCMAKE_BUILD_TYPE=Release && cmake --build .

Prebuilt External Libraries

MeshSync plugin requires other libraries, which have been prebuilt and put inside the External folder for convenience. Follow the links below for the steps to rebuild them.

  1. zstd

Tips

There is a test project that can be created by specifying -DBUILD_TESTS=ON.

  1. Windows 
    $ cmake -G "Visual Studio 15 2017" -A x64 .. -DBUILD_TESTS=ON
  2. Mac 
    $ cmake -GXcode .. -DBUILD_TESTS=ON
  3. Linux 
    $ cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=ON && cmake --build .

When this project is executed, it will send data to MeshSyncServer in Unity.

MeshSyncTest