https://github.com/jacmoe/pxlwolf
Seriously overengineered Wolfenstein-like raycast engine
https://github.com/jacmoe/pxlwolf
allegro5 cpp17 ldtk pixels raycaster
Last synced: 10 months ago
JSON representation
Seriously overengineered Wolfenstein-like raycast engine
- Host: GitHub
- URL: https://github.com/jacmoe/pxlwolf
- Owner: jacmoe
- License: mit
- Created: 2020-12-20T17:44:56.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-04-05T09:14:22.000Z (about 3 years ago)
- Last Synced: 2024-04-16T04:20:11.191Z (about 2 years ago)
- Topics: allegro5, cpp17, ldtk, pixels, raycaster
- Language: C++
- Homepage:
- Size: 50.2 MB
- Stars: 5
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
* pxlwolf [Moved to codeberg]
*Achtung*: This repository will not be updated.
Development will maybe continue at -> https://codeberg.org/jacmoe/pxlwolf
----------------------------------------------------------------------------------
# The
# ██████╗ ██╗ ██╗██╗ ██╗ ██╗ ██████╗ ██╗ ███████╗
# ██╔══██╗╚██╗██╔╝██║ ██║ ██║██╔═══██╗██║ ██╔════╝
# ██████╔╝ ╚███╔╝ ██║ ██║ █╗ ██║██║ ██║██║ █████╗
# ██╔═══╝ ██╔██╗ ██║ ██║███╗██║██║ ██║██║ ██╔══╝
# ██║ ██╔╝ ██╗███████╗╚███╔███╔╝╚██████╔╝███████╗██║
# ╚═╝ ╚═╝ ╚═╝╚══════╝ ╚══╝╚══╝ ╚═════╝ ╚══════╝╚═╝
# project
# https://github.com/jacmoe/pxlwolf
#
# (c) 2020 - 2025 Jacob Moena
#
# MIT License
#
# pxlwolf
Seriously overengineered Wolfenstein-like raycast engine
## TOC
- [Screenshots](#Screenshots)
- [PixelWolf](#PixelWolf)
- [Level Editing in LDtk](#Level-Editing-in-LDtk)
- [Goals](#Goals)
- [Features](#Goals)
- [Implemented features](#Implemented-features)
- [Planned features](#Planned-features)
- [Dependencies](#Dependencies)
- [External dependencies](#External-dependencies)
- [Bundled dependencies](#Bundled-dependencies)
- [Credits](#Credits)
## Screenshots
### PixelWolf
![Clutter creates an atmosphere][clutter]
![Static sprites][sprites]
![Textured floor and ceiling][corridor]
![PixelWolf][pxlwolf]
### Level Editing in LDtk
Pxlwolf uses the [LDtk Level Designer Toolkit][ldtk_link] to create and edit levels.
![LDTK][ldtk]
First four levels of Wolfenstein 3D.
![Wolfenstein Levels][ldtklevels]
Taking care of the details.
![Static sprites and pickups][detailing]
## Goals
- Explore raycasting, including height-mapping and animated tiles.
- Learn how to use modern C++ features, and move from C++98 to C++17 and beyond.
- Create a complete game, and not just a tech demo.
- Use third-party code whenever possible, but keep things simple.
## Features
Here I will write the features of PixelWolf down as I implement them.
### Implemented
### Planned
## Dependencies
PixelWolf is being developed on Linux and Windows.
Compiled using MSVC 2019 on Windows, and GCC 9.3 on Linux.
Uses Visual Studio on Windows, and CMake on Linux.
### External dependencies
|Library|Description|License|
|-------|-----------|-------|
|[Allegro 5.2][allegro]|A game programming library|Zlib license|
#### Windows
The easiest way to get Allegro on Windows is via Nuget, which is why this project uses Visual Studio for Windows.
The PixelWolf solution references two projects, Lua and PhysicsFS, which should be generated using CMake before opening the project.
Use the CMake script in `3rdparty` and choose `3rdparty/vsbuild` as the "where to build the binaries" folder.
Make sure `win32` is chosen as the architecture, otherwise CMake will choose `x64` (and that is not going to work).
After having generated the two projects, you can now open the PixelWolf solution. Maybe in the future, there will be a better way.
#### Linux
Allegro should be available from your package manager. On Ubuntu, perform a simple ```sudo apt-get install liballegro5-dev```
On Linux PixelWolf is fully CMake'd. Simply open the main CMake script using CMake or a CMake-aware program, like VSCode or KDevelop.
### Bundled dependencies
|Library|Description|License|
|-------|-----------|-------|
|[cereal][cereal]|C++11 library for serialization|BSD license|
|[enTT][entt]|C++ entity component system|MIT license|
|[Lua 5.4][lua]|Scripting language|zlib License|
|[PhysicsFS ][physfs]|Archive support for games|zlib license|
|[PhysFS++][physpp]|C++ wrapper for PhysicsFS|zlib license|
|[RapidJSON][rapidjson]|A fast JSON parser/generator for C++|MIT license|
|[Sol][sol]|A C++11 Lua wrapper|MIT License|
|[spdlog][spdlog]|Logging library|MIT license|
|[stb_image][stbimage]|Image loader|Public domain|
The bundled dependencies are all header-only, and doesn't require building, except for `Lua`, `lgui`, and `PhysicsFS`.
On Windows, you need to generate the projects simply by running the `` batch file from the `3rdparty` directory. You need CMake, Doxygen and the Graphviz tools (dot) installed.
On Linux, the CMake script handles all this for you.
## Credits
This project is using code from the [c-raycaster project][cray] - the raycaster and a lot of the pixel related functionality is borrowed from the project. It also uses code from Herrecito's [2.5D Raycaster engine][herrecito] in C. And the overall structure of the project is lifted from Balantkissdev's [Raycaster engine][balantkiss].
[pxlwolf]: https://github.com/jacmoe/pxlwolf/raw/main/screenshots/Screenshot.jpg "Screenshot of PixelWolf"
[corridor]: https://github.com/jacmoe/pxlwolf/raw/main/screenshots/corridor.png "Textured wall and ceiling"
[detailing]: https://github.com/jacmoe/pxlwolf/raw/main/screenshots/detailing.png "Taking care of the details"
[clutter]: https://github.com/jacmoe/pxlwolf/raw/main/screenshots/clutter.png "Creating an atmosphere"
[sprites]: https://github.com/jacmoe/pxlwolf/raw/main/screenshots/sprites.png "Static sprites"
[ldtk]: https://github.com/jacmoe/pxlwolf/raw/main/screenshots/LevelEditing.jpg "Level editing in LDTK"
[ldtklevels]: https://github.com/jacmoe/pxlwolf/raw/main/screenshots/ldtklevels.png "First four levels of Wolf3d"
[ldtk_link]: https://ldtk.io/ "LDtk Level Designer Toolkit"
[herrecito]: https://github.com/herrecito/engine "Herrecito's 2.5D Raycaster engine in C"
[balantkiss]: https://github.com/balintkissdev/raycaster-engine "Balantkissdev's Raycaster engine"
[cray]: https://github.com/ckinvents/c-raycaster "c-raycaster project by ckinvents"
[allegro]: https://liballeg.org/ "A game programming library"
[cereal]: https://uscilab.github.io/cereal/ "C++11 library for serialization"
[entt]: https://github.com/skypjack/entt "C++ entity component system"
[lua]: https://www.lua.org/download.html "Scripting language"
[physfs]: https://www.icculus.org/physfs/ "Archive support for games"
[physpp]: https://github.com/kahowell/physfs-cpp "C++ wrapper for PhysicsFS"
[rapidjson]: https://rapidjson.org/ "A fast JSON parser/generator for C++"
[sol]: https://github.com/ThePhD/sol "A C++11 Lua wrapper"
[spdlog]: https://github.com/gabime/spdlog "Logging library"
[stbimage]: https://github.com/nothings/stb "Image loader"