doomgeneric-rs

This was primarily a test whether a doom port could be integrated into rust without much hassle (to later integrate with another platform).

The awesome doom port doomgeneric was used as a basis.

This repo was originally started as piston-doom and later turned into a standalone lib. Therefore this is technically a fork of that repo with the piston-components removed.

---

This lib uses doomgeneric as a submodule. If you clone this repo locally, make sure to also initialize that submodule. Otherwise building doomgeneric will fail!

The basics are to create a struct that implements the trait game::DoomGeneric and pass it to game::init(...). Afterwards you'll need to run game::tick() afterwards in a loop.

This library does not support multiple instances. Running game::init(...) will pass your struct to the library and keeps it around forever (to use when doomgeneric c functions are called).

A very basic, incomplete usage example:

struct MyDoomGame {
  // Some fields, like channels to e.g. poll input from or send received framebuffers to
}

impl doomgeneric::game::DoomGeneric for MyDoomGame {
 // Implement all required functions here, they are essentially events from doom
}

fn main() {
  let my_game = MyDoomGame {};
  let args: Vec<String> = std::env::args().collect();
  doomgeneric::game::init(&args, my_game);
  loop {
    doomgeneric::game::tick();
  }
}

For more detailed, see the readme of piston-doom and its main.rs for a full, yet short implementation of the above principles.

---

CLI flags (e.g. -iwad)

init takes a slice of args passed straight to doomgeneric_Create, so doom's normal CLI flags work:

doomgeneric::game::init(&["doom", "-iwad", "/path/to/DOOM1.WAD"], my_game);

By convention, argv[0] is the program name.

Custom resolution

Default is 640x400. Override at build time via env vars (consumed by build.rs and forwarded to the C compiler as -DDOOMGENERIC_RESX=...):

DOOMGENERIC_RESX=320 DOOMGENERIC_RESY=200 cargo build

Doom's renderer targets 320x200 internally and scales 2x; multiples of 320x200 (320x200, 640x400, 960x600) render most cleanly. Other sizes may show HUD/status-bar artifacts.