Marisa Lago Ballesteros
95893e3768
Some checks failed
Continuous Integration / macOS | Debug (push) Has been cancelled
Continuous Integration / Linux Clang 11 | Debug (push) Has been cancelled
Continuous Integration / Visual Studio 2022 | Debug (push) Has been cancelled
Continuous Integration / Linux GCC 12 | RelWithDebInfo (push) Has been cancelled
Continuous Integration / Linux GCC 9 | RelWithDebInfo (push) Has been cancelled
Continuous Integration / Visual Studio 2022 | RelWithDebInfo (push) Has been cancelled
Continuous Integration / macOS | Release (push) Has been cancelled
Continuous Integration / Linux Clang 15 | Release (push) Has been cancelled
Continuous Integration / Linux Clang Latest | Release (push) Has been cancelled
Continuous Integration / Linux GCC Latest | Release (push) Has been cancelled
Continuous Integration / Update Latest successful build (push) Has been cancelled
82 lines
2.3 KiB
Markdown
82 lines
2.3 KiB
Markdown
## Welcome to VKDoom!
|
|
|
|
VKDoom is a source port based on the DOOM engine with a focus on Vulkan and modern computers.
|
|
|
|
Please see license files for individual contributor licenses.
|
|
|
|
**Addendum by Marisa**: This fork was supposed to be a continuation of the original VKDoom by dpJudas et al, as it was officially abandoned. New features are no longer on the table, I feel I've done enough of that already between 2018 and 2023. At the very least some bugs were fixed for the sake of stability, so now this is currently the only port that can play **Codename: DEMOLITIONIST**.
|
|
|
|
### Releases
|
|
|
|
No automated builds or releases are offered, you have to do it yourself.
|
|
|
|
### Build Guide
|
|
|
|
## Prep
|
|
For Windows, you need the latest version of Visual Studio, Windows SDK, Git, and CMake to build VKDoom.
|
|
|
|
For Linux, you need the following:
|
|
* libsdl2-dev
|
|
* libopenal-dev
|
|
* libvpx-dev
|
|
* git
|
|
* cmake
|
|
|
|
For Mac, the following project is recommended, as it contains all the dependencies and makes building easy: https://github.com/ZDoom/zdoom-macos-deps
|
|
|
|
## Clone the repo
|
|
After you have the packages installed, `cd` into your projects directory, and do the following to clone:
|
|
|
|
```sh
|
|
git clone https://github.com/OrdinaryMagician/VkDoom_m VkDoom
|
|
```
|
|
|
|
Afterwards, `cd` into it
|
|
|
|
```sh
|
|
cd VkDoom
|
|
```
|
|
|
|
Make a build folder, then `cd` into it
|
|
|
|
```sh
|
|
mkdir build
|
|
cd build
|
|
```
|
|
|
|
## Building
|
|
|
|
### Windows
|
|
For Windows, run the following to prepare your build environment and the second command will build:
|
|
|
|
```sh
|
|
cmake -A x64 ..
|
|
cmake --build . --config Release -- -maxcpucount
|
|
```
|
|
|
|
(replace x64 with ARM64 if you're building on ARM64)
|
|
|
|
### Linux - Ninja (Recommended)
|
|
For 'ninja', make sure the ninja package is installed on your distro (ex: Debian: `sudo apt install ninja`) - then run the following to prepare your build environment and the second command will build:
|
|
```sh
|
|
cmake .. -DCMAKE_BUILD_TYPE=Release -G Ninja
|
|
ninja -j $(nproc)
|
|
```
|
|
|
|
### Linux - Make
|
|
For 'make', run the following to prepare your build environment and the second command will build:
|
|
|
|
```sh
|
|
cmake .. -DCMAKE_BUILD_TYPE=Release
|
|
make -j $(nproc)
|
|
```
|
|
|
|
### Mac OS
|
|
For Mac, if you're using zdoom-macos-deps, simply cd into it and type the following:
|
|
|
|
```sh
|
|
./build.py --target vkdoom
|
|
```
|
|
|
|
### Licensed under the GPL v3
|
|
##### https://www.gnu.org/licenses/quick-guide-gplv3.en.html
|