Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-04-05 19:36:45 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

📝 Updated documentation

Browse source
This commit is contained in:
Edgar 2024-11-01 12:48:04 +01:00
parent a17c6ec15f
commit 6ad41bb27c
No known key found for this signature in database
GPG key ID: 3C2E1F2C1C353131
5 changed files with 86 additions and 78 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
BUILD.md
View file

@ -7,7 +7,7 @@ SPDX-License-Identifier: Apache-2.0
# General Build Information
*Last Updated on March 8, 2021*
*Last Updated on 21-10-2024*
## OS Specific Build Guides
@ -34,7 +34,6 @@ These dependencies need not be installed manually. They are automatically downlo
- [QuaZip](https://sourceforge.net/projects/quazip/files/quazip/): 0.7.3
- [SDL2](https://www.libsdl.org/download-2.0.php): 2.0.3
- [Intel Threading Building Blocks](https://www.threadingbuildingblocks.org/): 4.3
- [vcpkg](https://github.com/hifi-archive/vcpkg):
- [VHACD](https://github.com/virneo/v-hacd)
- [zlib](http://www.zlib.net/): 1.28 (Win32 only)
- [nvtt](https://github.com/hifi-archive/nvidia-texture-tools): 2.1.1 (customized)
@ -78,23 +77,23 @@ information files (~7GB).
Note: Installing Qt Creator is optional but recommended if you will be editing QML files.
### VCPKG
### Conan
Overte uses vcpkg to download and build dependencies.
You do not need to install vcpkg.
Overte uses conan to download and build dependencies.
Conan can be downloaded from here: https://conan.io/downloads
Building the dependencies can be lengthy and the resulting files will be stored in your OS temp directory.
However, those files can potentially get cleaned up by the OS, so in order to avoid this and having to redo the lengthy build step, you can set an environment variable.
Building the dependencies can be lengthy and the resulting files will be stored in your home directory.
To move them to a different location, you can set the `CONAN_HOME` variable to any folder where you wish to install the dependencies.
Linux:
```bash
export HIFI_VCPKG_BASE=/path/to/directory
export CONAN_HOME=/path/to/directory
```
Windows:
```bash
set HIFI_VCPKG_BASE=/path/to/directory
set CONAN_HOME=/path/to/directory
```
Where `/path/to/directory` is the path to a directory where you wish the build files to get stored.
@ -139,28 +138,13 @@ BUILD_GLOBAL_SERVICES=STABLE
#### Generate Files
Create a build directory in the root of your checkout and then run the CMake build from there. This will keep the rest of the directory clean.
```bash
mkdir build
cd build
cmake ..
conan install . -s build_type=Release -b missing -of build
cmake --preset conan-release
```
If CMake gives you the same error message repeatedly after the build fails, try removing `CMakeCache.txt`.
#### Generating a release/debug only vcpkg build
In order to generate a release or debug only vcpkg package, you could use the use the `VCPKG_BUILD_TYPE` define in your CMake generate command. Building a release only vcpkg can drastically decrease the total build time.
For release only vcpkg:
`cmake .. -DVCPKG_BUILD_TYPE=release`
For debug only vcpkg:
`cmake .. -DVCPKG_BUILD_TYPE=debug`
### Variables
Any variables that need to be set for CMake to find dependencies can be set as ENV variables in your shell profile, or passed directly to CMake with a `-D` flag appended to the `cmake ..` command.
@ -168,7 +152,7 @@ Any variables that need to be set for CMake to find dependencies can be set as E
For example, to pass the QT_CMAKE_PREFIX_PATH variable (if not using the vcpkg'ed version) during build file generation:
```bash
cmake .. -DQT_CMAKE_PREFIX_PATH=/usr/local/qt/5.12.3/lib/cmake
cmake --preset conan-release -DQT_CMAKE_PREFIX_PATH=/usr/local/qt/5.12.3/lib/cmake
```
### Finding Dependencies

80
BUILD_LINUX.md
View file

@ -7,7 +7,7 @@ SPDX-License-Identifier: Apache-2.0
# Build Linux
*Last Updated on January 6, 2022*
*Last Updated on 21-10-2024*
Please read the [general build guide](BUILD.md) for information on dependencies required for all platforms. Only Linux specific instructions are found in this file.
@ -48,6 +48,12 @@ sudo apt-get install cmake -y
```
Verify CMake was installed by running `cmake --version`.
- Conan
See https://conan.io/downloads for download instructions
Verify Conan was installed by running `conan --version`.
### Install build dependencies:
- OpenSSL:
```bash
@ -64,6 +70,29 @@ Verify OpenGL:
- Then run `glxinfo | grep "OpenGL version"`.
- QT 5:
```bash
sudo apt-get install -y qtbase5-dev \
qtbase5-private-dev \
qtwebengine5-dev \
qtwebengine5-dev-tools \
qtmultimedia5-dev \
libqt5opengl5-dev \
libqt5webchannel5-dev \
libqt5websockets5-dev \
qtxmlpatterns5-dev-tools \
qttools5-dev \
libqt5xmlpatterns5-dev \
libqt5svg5-dev \
qml-module-qtwebchannel \
qml-module-qtquick-controls \
qml-module-qtquick-controls2 \
qml-module-qt-labs-settings \
qml-module-qtquick-dialogs \
qml-module-qtwebengine
```
### Extra dependencies to compile Interface on a server
@ -105,19 +134,6 @@ git fetch --tags
git tag
```
### Using a custom Qt build
Qt binaries are only provided for Ubuntu. In order to build on other distributions, a Qt5 install
needs to be provided by setting the `OVERTE_QT_PATH` environment variable to a directory containing
a Qt install.
### Using the system's Qt
The system's Qt can be used, if the development packages are installed, by setting the
`OVERTE_USE_SYSTEM_QT` environment variable. The minimum recommended version is Qt 5.15.2, which is
also the last version available in the Qt 5 branch. It is expected that Linux distributions will have
Qt 5.15.2 available for a long time.
### Architecture support
If the build is intended to be packaged for distribution, the `OVERTE_CPU_ARCHITECTURE`
@ -130,22 +146,40 @@ For packaging, it is recommended to set it to a different value, for example `-m
Setting `OVERTE_CPU_ARCHITECTURE` to an empty string will use the default compiler settings and yield maximum compatibility.
### Prepare conan
The next step is setting up conan
First, create a conan profile
```bash
conan profile detect --force
```
Next, add the overte remote to conan
```bash
conan remote add overte https://git.anotherfoxguy.com/api/packages/overte/conan -f
```
Optionally you can let conan automatically install the required system packages
```bash
echo "tools.system.package_manager:mode = install" >> ~/.conan2/global.conf
echo "tools.system.package_manager:sudo = True" >> ~/.conan2/global.conf
```
### Compiling
Create the build directory:
Install the dependencies with conan
```bash
cd overte
mkdir build
cd build
conan install . -s build_type=Release -b missing -pr:b=default -of build
```
Prepare makefiles:
```bash
cmake ..
cmake --preset conan-release
```
If cmake fails with a vcpkg error, then delete `~/overte-files/vcpkg/`.
#### Server
To compile the Domain server:
@ -192,9 +226,3 @@ Running Interface:
Go to "localhost" in the running Interface to visit your newly launched Domain server.
### Notes
If your goal is to set up a development environment, it is desirable to set the directory that vcpkg builds into with the `HIFI_VCPKG_BASE` environment variable.
For example, you might set `HIFI_VCPKG_BASE` to `/home/$USER/vcpkg`.
By default, vcpkg will build in the `~/overte-files/vcpkg/` directory.

42
BUILD_WIN.md
View file

@ -1,13 +1,13 @@
<!--
Copyright 2013-2019 High Fidelity, Inc.
Copyright 2019-2021 Vircadia contributors
Copyright 2021-2022 Overte e.V.
Copyright 2021-2024 Overte e.V.
SPDX-License-Identifier: Apache-2.0
-->
# Build Windows
*Last Updated on 15 Apr 2021*
*Last Updated on 21-10-2024*
This is a stand-alone guide for creating your first Overte build for Windows 64-bit.
@ -36,29 +36,29 @@ On the right on the Summary toolbar, select the following components.
If you do not wish to use the Python installation bundled with Visual Studio, you can download the installer from [here](https://www.python.org/downloads/). Ensure that you get version 3.6.6 or higher.
## Step 2. Python Dependencies
## Step 2. Python Dependencies and conan
In an administrator command-line that can access Python's pip you will need to run the following command:
`pip install distro`
`pip install distro conan`
If you do not use an administrator command-line, you will get errors.
## Step 3. Installing CMake
Download and install the latest version of CMake 3.15.
Download and install the latest version of CMake.
* Note that earlier versions of CMake will work, but there is a specific bug related to the interaction of Visual Studio 2019 and CMake versions prior to 3.15 that will cause Visual Studio to rebuild far more than it needs to on every build
Download the file named win64-x64 Installer from the [CMake Website](https://cmake.org/download/). You can access the installer on this [3.15 Version page](https://cmake.org/files/v3.15/). During installation, make sure to check "Add CMake to system PATH for all users" when prompted.
Download the file named cmake-[version]-windows-x86_64.msi Installer from the [CMake Website](https://cmake.org/download/). During installation, make sure to check "Add CMake to system PATH for all users" when prompted.
## Step 4. (Optional) Node.JS and NPM
Install version 10.15.0 LTS (or greater) of [Node.JS and NPM](<https://nodejs.org/en/download/>).
Install the latest LTS version of [Node.JS and NPM](<https://nodejs.org/en/download/>).
This is required to build the server-console, hifi-screenshare, jsdoc, and for javascript console autocompletion.
## Step 5. (Optional) Install Qt
## Step 5. Install Qt
If you would like to compile Qt instead of using the precompiled package provided during CMake, you can do so now. Install version 5.12.3 of [Qt](<https://www.qt.io/download-open-source>), as well as the following packages:
Install version 5.15.2 of [Qt](<https://www.qt.io/download-open-source>), as well as the following packages:
* Qt 5.15.2
* MSVC 2019 64-bit
* Qt WebEngine
@ -75,25 +75,17 @@ To create this variable:
* Set "Variable name" to `QT_CMAKE_PREFIX_PATH`
* Set "Variable value" to `%QT_INSTALL_DIR%\5.15.2\msvc2019_64\lib\cmake`, where `%QT_INSTALL_DIR%` is the directory you specified for Qt's installation. The default is `C:\Qt`.
## Step 6. (Optional) Create VCPKG environment variable
In the next step, you will use CMake to build Overte. By default, the CMake process builds dependency files in Windows' `%TEMP%` directory, which is periodically cleared by the operating system. To prevent you from having to re-build the dependencies in the event that Windows clears that directory, we recommend that you create a `HIFI_VCPKG_BASE` environment variable linked to a directory somewhere on your machine. That directory will contain all dependency files until you manually remove them.
## Step 6. (Optional) Create conan environment variable
In the next step, you will use conan to install the dependencies required to build Overte. By default, conan will build and install the dependencies in `<username>/.conan2`.
If you want to change that location you can create a `CONAN_HOME` environment variable linked to a directory somewhere on your machine.
To create this variable:
* Navigate to 'Edit the System Environment Variables' Through the Start menu.
* Click on 'Environment Variables'
* Select 'New'
* Set "Variable name" to `HIFI_VCPKG_BASE`
* Set "Variable name" to `CONAN_HOME`
* Set "Variable value" to any directory that you have control over.
Additionally, if you have Visual Studio 2019 installed and _only_ Visual Studio 2019 (i.e., you do not have Visual Studio 2017 installed) you must add an additional environment variable `HIFI_VCPKG_BOOTSTRAP` that will fix a bug in our `vcpkg` pre-build step.
To create this variable:
* Navigate to 'Edit the System Environment Variables' through the Start menu.
* Click on 'Environment Variables'
* Select 'New'
* Set "Variable name" to `HIFI_VCPKG_BOOTSTRAP`
* Set "Variable value" to `1`
## Step 7. Running CMake to Generate Build Files
These instructions only apply to Visual Studio 2019.
@ -110,13 +102,15 @@ Run The Command Prompt from Start and run the following commands:
```Bash
cd "%OVERTE_DIR%"
mkdir build
cd build
cmake .. -G "Visual Studio 16 2019" -A x64
conan install . -b missing -pr=tools/conan-profiles/vs-19-release -of build
conan install . -b missing -pr=tools/conan-profiles/vs-19-debug -of build
cmake --preset conan-default
```
Where `%OVERTE_DIR%` is the directory for the Overte repository.
Note: After running conan I would highly recommend running `conan cache clean "*" -sbd` to clean the build folders created by conan (This saves a lot of disk space)
## Step 8. Making a Build
Open `%OVERTE_DIR%\build\overte.sln` using Visual Studio.

1
winprepareVS19.bat
View file

@ -1,6 +1,7 @@
ECHO Running conan
conan install . -b missing -pr=tools/conan-profiles/vs-19-release -of build
conan install . -b missing -pr=tools/conan-profiles/vs-19-debug -of build
conan cache clean "*" -sbd
ECHO Running cmake
cmake --preset conan-default
ECHO CMake has finished

3
winprepareVS22.bat
View file

@ -1,6 +1,7 @@
ECHO Running conan
conan install . -b missing -pr=tools/conan-profiles/vs-22-release -of build
echo conan install . -b missing -pr=tools/conan-profiles/vs-22-debug -of build
conan install . -b missing -pr=tools/conan-profiles/vs-22-debug -of build
conan cache clean "*" -sbd
ECHO Running cmake
cmake --preset conan-default
ECHO CMake has finished