https://github.com/jonathanlinat/dockerized-trenchbroom
🐋 A dockerized version of kduske's TrenchBroom source code
https://github.com/jonathanlinat/dockerized-trenchbroom
build cpp docker trenchbroom
Last synced: about 2 months ago
JSON representation
🐋 A dockerized version of kduske's TrenchBroom source code
- Host: GitHub
- URL: https://github.com/jonathanlinat/dockerized-trenchbroom
- Owner: jonathanlinat
- License: mit
- Created: 2023-11-13T15:39:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-20T17:40:31.000Z (almost 2 years ago)
- Last Synced: 2025-04-11T06:17:23.818Z (7 months ago)
- Topics: build, cpp, docker, trenchbroom
- Language: Shell
- Homepage:
- Size: 9.77 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Dockerized 🐋 TrenchBroom
This repository contains the [TrenchBroom](https://github.com/TrenchBroom/TrenchBroom) source code set up for Docker. TrenchBroom is a level editor for multiple games.
[Docker](https://www.docker.com) is used here to simplify building the application. With Docker, developers can compile and build the application without manually installing all dependencies.
> ⚠️ **Disclaimer**: This setup is currently only compatible with Linux environments. Support for Windows and macOS is planned for the near future.
## Structure of the Project
The project utilizes a `TrenchBroom` directory, which is a Git clone of the TrenchBroom source. When the `build.sh` script is run, it compiles the content of the `TrenchBroom` directory.
```text
.
├── TrenchBroom/
│ └── build/
│ └── /
│ └── /
│ └── /
│ └── ...
├── .gitignore
├── build.sh
├── Dockerfile.linux
├── LICENSE
└── README.md
```
## Getting Started
Ensure you have [Docker Engine](https://docs.docker.com/engine/) installed and operational. An alternative user-friendly interface for managing Docker elements is [Docker Desktop](https://docs.docker.com/desktop/).
> ⚠️ **Technical Note**: For an optimized building experience, it may be necessary to adjust your Docker resource allocations, including CPU, Memory, and Disk Space. Increasing these limits in Docker settings can significantly enhance performance, especially for resource-intensive tasks, and avoid failing building processes.
### How to Use
1. Clone this repository:
```bash
git clone https://github.com/jonathanlinat/dockerized-trenchbroom.git
```
2. Navigate to the cloned directory:
```bash
cd dockerized-trenchbroom
```
3. Clone the official TrenchBroom source code or a fork into this project:
```bash
git clone --recursive https://github.com/TrenchBroom/TrenchBroom.git
```
> **Note**: To clone a specific branch, append `-b ` to the command.
After this step, you should have a directory named `TrenchBroom`, as shown in the project structure above.
4. Compile the application:
Open your terminal and execute the following, optionally replacing:
- `` with `linux`
- `` with `Debug` or your desired type (like `Release`, `RelWithDebInfo` or `MinSizeRel`)
- `` with `TrenchBroom` or your desired target (like `GenerateManual`)
```bash
./build.sh
```
This will initiate the Docker-based build process. The resulting binary will be placed in `TrenchBroom/build////`.
With these steps, you can easily compile TrenchBroom using Docker, ensuring a consistent and streamlined build process.
## License
**Dockerized 🐋 TrenchBroom** is [MIT licensed](LICENSE).