Join 10350+ others. No spamming.
I promise!

Follow us at github.



cristicbz/rust-doom

1277

cristicbz / rust-doom

Rust

A Doom Renderer written in Rust.


READ ME

Build Status

Rust Doom

A little Doom 1 & 2 Renderer written in Rust. I wanted to learn the language and was inspired by Notch's Dart Doom renderer, who is using his project to learn Dart better. That said, pull requests are most welcome!

The code is mostly based on the endlessly useful Doom Wiki and the Unofficial Doom Specs. It is not a port of the original Doom C source code into Rust; I'm doing my best to make the code as idiomatic as possible and have not looked at the original in a long time.

Note: You need a WAD file to try this. Get a shareware one if you don't own the game.

Screenshots

Zig-zag Screenshot Doom 2 Screenshot

Build Instructions

Rust Doom should always build on the latest stable version of Rust (but is also tested on beta and nightly), which you can install using any of the methods described on the Rust website.

Currently the only non-rust dependencies are SDL2 and SDL2_ttf. You can install them using your system's package manager:

  • Ubuntu/Debian: sudo apt-get install libsdl2-dev libsdl2-ttf-dev
  • Mac OS: brew install sdl2 sdl2_ttf

Then, to build, run cargo in the project's root (where Cargo.toml is):

cargo build --release

Note that you'll need a WAD file (which contains the game's levels and art assets). If you own the game (or are willing to buy it for a few quid/bucks), you'll find the WAD in your game folder. If not, you can use the shareware ones floating around on the interwebs. Or, though I would not know of such things, you may be able to obtain the originals for free in less.... savoury parts of the internet.

Copy the WAD file to the repo root (where Cargo.toml is). Then, to run:

target/release/rs_doom --iwad your_wad_file.wad

Without any flags it will try to load the first level of 'doom1.wad'. You can specify which level to load, FOV and resolution preferences using the flags. Run with '-h' for a list of options.

Goals

(subject to change)

  • Modern OpenGL 3 renderer. No immediate mode shenanigans: it's all VBO-s and shaders. Unlike some GL ports, the floors are actually rendered as convex polygons computed from the BSP. The downside of this (or upside depending on your perspective) is that some visual glitches (like slime trails) don't show up.
  • Correct 256 color palette. Uses the original palette and colormaps to replicate the original lighting effects (mostly you'll notice things get darker in visible steps and they also get greyer as they get darker). Doing 256 color palette lookups in a fragment shader is wonderfully anachronistic.
  • Free flying camera. Mouse & keyboard control for full 6 degrees of freedom.
  • 100% safe code. No pesky unsafe blocks anywhere.

Contributing

A Makefile is provided for convenient testing, please run make test to ensure all subcrates are working.

Todo

  • BSP -> convex subsector conversion.
  • Flats (floors & ceiling) texture mapping.
  • Wall texture mapping.
  • Wall texture alignment.
  • Scrolling walls.
  • Animated flats.
  • Animated walls.
  • Lighting effects (flickering, flashing, glow etc.)
  • Sky rendering.
  • Sprite rendering.
  • Correct player movement (falling etc.)
  • Player-flat collisions.
  • Player-wall collisions.
  • Sprite-player and sprite-sprite collisions.
  • Sprite animations.
  • BSP frustum culling.