Blame
|
1 | # Building Pointcaster |
||||||
| 2 | ||||||||
|
3 | Source code for Pointcaster is available on [Github](https://github.com/matth-av/pointcaster). Start by cloning the repository: |
||||||
|
4 | ```sh |
||||||
|
5 | git clone https://github.com/matth-av/pointcaster.git |
||||||
|
6 | cd pointcaster |
||||||
| 7 | ``` |
|||||||
|
8 | |||||||
|
9 | ## Linux |
||||||
| 10 | ||||||||
|
11 | Builds on Linux use a containerised development environment created using the [Dockerfile](https://github.com/matth-av/pointcaster/blob/qt/Dockerfile) in the root of the repository. This handles download and configuration of all dependencies. Either [Docker](https://docs.docker.com/engine/install/) or [Podman](https://podman.io/docs/installation) must be installed and configured on your system to proceed. |
||||||
|
12 | |||||||
|
13 | The container image can be pulled from Pointcaster servers: |
||||||
|
14 | ```sh |
||||||
|
15 | docker pull cr.pointcaster.net/pointcaster-dev |
||||||
| 16 | ``` |
|||||||
| 17 | ||||||||
| 18 | Or you can build it yourself (but it will take a while): |
|||||||
| 19 | ```sh |
|||||||
| 20 | docker build -t pointcaster-dev . |
|||||||
| 21 | ``` |
|||||||
| 22 | ||||||||
| 23 | It can be run directly to create release builds: |
|||||||
| 24 | ```sh |
|||||||
|
25 | docker run --rm -v ./:/pointcaster:Z cr.pointcaster.net/pointcaster-dev \ |
||||||
|
26 | ./scripts/build-linux-release.sh |
||||||
|
27 | ``` |
||||||
|
28 | The `-v` argument ensures the repository is mounted inside the container. |
||||||
|
29 | |||||||
|
30 | For a development shell, invoke `bash` or `fish`, then you can configure and build using `cmake`: |
||||||
|
31 | ```sh |
||||||
|
32 | docker run --rm -it -v ./:/pointcaster:Z cr.pointcaster.net/pointcaster-dev bash |
||||||
|
33 | ``` |
||||||
| 34 | Then from inside: |
|||||||
| 35 | ```sh |
|||||||
|
36 | cmake --preset linux-release |
||||||
|
37 | cmake --build build/linux-release |
||||||
|
38 | cmake --build build/linux-release --target install |
||||||
|
39 | cmake --build build/linux-release --target package |
||||||
|
40 | ``` |
||||||
| 41 | ||||||||
|
42 | The install target places a portable build at `build/linux-release/install/bin/pointcaster`, and the package target creates an AppImage at `dist/pointcaster-<version>-linux-release.AppImage`, both of which can be run from outside the container. |
||||||
|
43 | > [!TIP] |
||||||
|
44 | > The docker image is used as a base for a [Development Container](https://containers.dev/) in IDEs that support it. Visual Studio Code will automatically install extensions needed for C++, CMake and QML. See the [devcontainer.json](https://github.com/matth-av/pointcaster/blob/qt/.devcontainer/devcontainer.json). |
||||||
|
45 | |||||||
|
46 | ## Windows |
||||||
|
47 | ### Windows Builds Using Docker |
||||||
|
48 | Automated Windows builds use [Docker](https://docs.docker.com/engine/install/) to configure the build environment. [`scripts/windows.Dockerfile`](https://github.com/matth-av/pointcaster/blob/qt/scripts/windows.Dockerfile) installs Visual Studio Build Tools and other binary dependencies in a Windows container. This is how release builds are produced, but if you are looking to develop Pointcaster or a Pointcaster plugin you'll most likely want to build and debug using an IDE - in which case you might prefer [installing dependencies manually](#windows-builds-in-an-ide). |
||||||
|
49 | |||||||
|
50 | The following commands assume you have a working docker installation capable of running Windows containers on the command line. |
||||||
|
51 | |||||||
|
52 | The container image can be pulled from Pointcaster servers: |
||||||
| 53 | ```sh |
|||||||
| 54 | docker pull cr.pointcaster.net/pointcaster-dev |
|||||||
| 55 | ``` |
|||||||
| 56 | ||||||||
| 57 | Or you can build it yourself (but it will take a while): |
|||||||
|
58 | ```sh |
||||||
|
59 | docker build -t pointcaster-dev . |
||||||
|
60 | ``` |
||||||
|
61 | |||||||
|
62 | To produce a Pointcaster release package: |
||||||
|
63 | ``` |
||||||
|
64 | docker run -v ./:C:\pointcaster cr.pointcaster.net/pointcaster-dev \ |
||||||
| 65 | .\scripts-build-windows-release.ps1 |
|||||||
|
66 | ``` |
||||||
|
67 | The `-v` argument ensures the repository is mounted inside the container. |
||||||
| 68 | ||||||||
|
69 | For a development shell: |
||||||
| 70 | ``` |
|||||||
|
71 | docker run -it -v ./:C:\pointcaster cr.pointcaster.net/pointcaster-dev powershell |
||||||
|
72 | ``` |
||||||
|
73 | And from inside the container: |
||||||
| 74 | ```sh |
|||||||
|
75 | cmake --preset windows-release |
||||||
|
76 | cmake --build build/windows-release |
||||||
|
77 | cmake --build build/windows-release --target install |
||||||
|
78 | cmake --build build/windows-release --target package |
||||||
|
79 | ``` |
||||||
|
80 | The install target places a portable build at `build/windows-release/install/pointcaster.exe`, and the package target creates a zip archive at `dist/pointcaster-<version>-windows-release.zip`. |
||||||
|
81 | > [!TIP] |
||||||
| 82 | > You might benefit from passing some docker args to fully utilise available resources, e.g.: |
|||||||
| 83 | > ```sh |
|||||||
| 84 | > docker run --memory=20G --cpus=16 ... |
|||||||
| 85 | > ``` |
|||||||
| 86 | ||||||||
|
87 | ### Windows Builds in an IDE |
||||||
|
88 | #### Development Dependencies |
||||||
|
89 | To build Pointcaster on Windows using an IDE like Visual Studio, you'll need to install the following libraries on your host: |
||||||
| 90 | - Qt ~~QtVersion~~, with the 'shadertools', 'quick3d' and 'tasktree' modules |
|||||||
| 91 | - oneAPI Threading Building Blocks (oneTBB) ~~TbbVersion~~ |
|||||||
| 92 | - Python ~~PythonVersion~~ |
|||||||
| 93 | - Jinja ~~Jinja2Version~~ |
|||||||
|
94 | - NVIDIA CUDA Toolkit ~~CudaVersion~~ |
||||||
|
95 | |||||||
|
96 | Additionally, your environment will need CMake, vcpkg, Ninja, and MSVC from Visual Studio 2022. |
||||||
|
97 | These are all included in Visual Studio's 'Desktop Development with C++' Workload. |
||||||