Skip to content

Latest commit

 

History

History
50 lines (37 loc) · 2.1 KB

README.md

File metadata and controls

50 lines (37 loc) · 2.1 KB

Retro3D

2.5D (pseudo-3D) game engine

2.5D retro game engine. Old school software 3D rendering.

Builds and runs on Windows, Linux and WebAssembly.

TRY IT HERE: http://dungeoncrawler.dx.am/ (Requires a browser with webassembly-support)

alt tag

Features:

  • Raytraced 3D rendering, similar to old games like Wolfenstein (raytracing on a 2D grid).
  • Level scripts and script components, using ChaiScript.
  • WebAssembly support (can run in browser).

How to build

WINDOWS

  • Open CMake GUI (can download from here: https://cmake.org/download/)
  • In "Where is the srouce code", browse to the repository folder containing CMakeLists.txt
  • In "Where to build the binaries", chose any folder (i.e. subfolder "/build")
  • Make sure the directory can be written to (to prevent MSB3073 error)
  • Configure
  • Build
  • Open Visual Studio project
  • Build and run the "Game" project (IN RELEASE CONFIGURATION - Debug will be very slow!)

LINUX

  • Open the terminal and change directory ("cd" command) to the root folder of the repository.
  • Run aptget.sh (or manually do apt-get on the dependencies). Note: if you get "permission denied", execute "chmod +x aptget.sh" in the terminal first.
  • Run CMake: cmake .
  • Build the "Game" project (or make your own project based on that): make Game
  • Go to "projects/samples" and copy the "resources" folder of the samle you want to use into the same folder as the build executable.
  • Run the executable: ./Game

WEB ASSEMBLY

Contributing

Both code contributions, art contributions, bug reports and feature suggestions are more than welcome! See CONTRIBUTING.md for more information.

Thanks to Sebastian Genlund for suggestions and useful feedback!