doom 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77ff94b86295598915c520657fb36512c6fc091d24d6660cc8dea588a8939062
-  data.tar.gz: 3b3632ab2f9adbd0d8d4078c71f5c9f941943dd30d96c951bb27e803256a87d1
+  metadata.gz: cb48bcb7558c2e4f4ab959b16dbd857d2a1b6a3b9a9cc76c19a08ec91bdeb93e
+  data.tar.gz: 610f42cf954c60048a0c4030d96a8e8ceb2872aba90e90a141b2179329867c05
 SHA512:
-  metadata.gz: 61d4a1cf4f3542c3ce93d4dc624b2cc36c4d93be39a9d65cc832198be7bbd04b9bd86cc7723d13181b80907809005571d7a9f85217e628d6f5a5b7a02e35908a
-  data.tar.gz: 514bc92b65f0934cbf31828e4553d6978d86932afa690f70b89a69ed6d6bbe71cb98e0d3bfbe86916e0c799498366eedcad2f74904f78be84fc3d559f43a8dd3
+  metadata.gz: 1ff09fd05c29a5c49b7d41285424d58b8b46dbf995e1f18106d571f18866762e8b20ecb47d472dc2cb2be8f2fc8cdea5eb0b3a2dedae55d5b1881bbcb796088b
+  data.tar.gz: 41d4fcb793f3b25fb57f2d50c02f5eee1a56cb40a40baf2a9f7e0831634f43aa4777abf80968130c44593055dbaea23bd3257e7d4b509a068af2c92e1e16698d

data/README.md

@@ -1,159 +1,119 @@
-# Ruby Doom
+# DOOM Ruby
 
-A Ruby gem that ports the classic Doom game to Ruby, focusing on core gameplay without sound or networking features.
+A faithful ruby port of the DOOM (1993) rendering engine to Ruby.
 
-## Installation
+![DOOM Ruby Screenshot](screenshot.png)
 
-Add this line to your application's Gemfile:
+## Features
 
-```ruby
-gem 'doom'
-```
+- Pure Ruby implementation of DOOM's BSP rendering engine
+- Accurate wall, floor, and ceiling rendering with proper texture mapping
+- Sprite rendering with depth-correct clipping
+- Original DOOM lighting and colormap support
+- Mouse look and WASD movement controls
+- Supports original WAD files (shareware and registered)
 
-And then execute:
+## Installation
 
 ```bash
-$ bundle install
+gem install doom
 ```
 
-Or install it yourself as:
+## Quick Start
+
+Just run `doom` - it will offer to download the free shareware version:
 
 ```bash
-$ gem install doom
+doom
 ```
 
-## Requirements
-
-- Ruby 2.6 or higher
-- A legal copy of Doom for the WAD files (e.g., DOOM.WAD)
-
-## Usage
-
-### Command Line Interface
-
-The gem includes two command-line tools:
-
-#### WAD Explorer
-
-The `wad` command allows you to explore WAD files:
+Or specify your own WAD file:
 
 ```bash
-# Show general information about a WAD file
-$ wad -i DOOM.WAD
-
-# List all maps in a WAD file
-$ wad -l DOOM.WAD
+doom /path/to/doom.wad
+```
 
-# Show details for a specific map
-$ wad -m E1M1 DOOM.WAD
+## Controls
 
-# List all textures in a WAD file
-$ wad -t DOOM.WAD
+| Key | Action |
+|-----|--------|
+| W / Up Arrow | Move forward |
+| S / Down Arrow | Move backward |
+| A | Strafe left |
+| D | Strafe right |
+| Left Arrow | Turn left |
+| Right Arrow | Turn right |
+| Mouse | Look around (click to capture) |
+| Escape | Release mouse / Quit |
 
-# Show details for a specific texture
-$ wad -x STARTAN1 DOOM.WAD
+## Requirements
 
-# List all sprites in a WAD file
-$ wad -s DOOM.WAD
+- Ruby 3.1 or higher
+- Gosu gem (for window/graphics)
+- SDL2 (native library required by Gosu)
 
-# Show details for a specific sprite
-$ wad -p TROOA1 DOOM.WAD
+### Installing SDL2
 
-# Show help
-$ wad -h
+**macOS:**
+```bash
+brew install sdl2
 ```
 
-#### Game Launcher
-
-The `doom` command allows you to start the game:
-
+**Ubuntu/Debian:**
 ```bash
-# Start the game with default settings
-$ doom DOOM.WAD
-
-# Start the game with a specific map
-$ doom -m E1M1 DOOM.WAD
-
-# Start the game with a custom window size
-$ doom -w 800 -h 600 DOOM.WAD
-
-# Start the game in fullscreen mode
-$ doom -f DOOM.WAD
-
-# Show help
-$ doom --help
+sudo apt-get install build-essential libsdl2-dev libgl1-mesa-dev libfontconfig1-dev
 ```
 
-### Ruby API
-
-You can also use the Ruby API in your own code:
-
-```ruby
-require 'doom'
-
-# Load a WAD file
-loaders = Doom.load_wad('path/to/DOOM.WAD')
-
-# Access WAD information
-wad_loader = loaders[:wad]
-puts "WAD type: #{wad_loader.wad_type}"
-puts "Number of lumps: #{wad_loader.lumps.size}"
-
-# Access map information
-map_loader = loaders[:maps]
-puts "Available maps: #{map_loader.maps.join(', ')}"
-
-# Load a specific map
-map_data = map_loader.load_map('E1M1')
-puts "Number of things in E1M1: #{map_data[:things].size}"
-
-# Access texture information
-texture_loader = loaders[:textures]
-puts "Available textures: #{texture_loader.texture_names.join(', ')}"
-
-# Access sprite information
-sprite_loader = loaders[:sprites]
-puts "Available sprites: #{sprite_loader.sprite_names.join(', ')}"
+**Fedora:**
+```bash
+sudo dnf install SDL2-devel mesa-libGL-devel fontconfig-devel gcc-c++
 ```
 
-## Features
+**Arch Linux:**
+```bash
+sudo pacman -S sdl2 mesa
+```
 
-### Phase 1: WAD File Loader
+**Windows:**
+No additional setup needed - the gem includes SDL2.
 
-- WAD file parsing
-- Map data extraction
-- Texture information parsing
-- Sprite data handling
+## Development
 
-### Phase 2: Rendering Engine (Current)
+```bash
+git clone https://github.com/khasinski/doom-rb.git
+cd doom-rb
+bundle install
+ruby bin/doom doom1.wad
+```
 
-- Window management
-- BSP rendering
-- Texture mapping
-- Sprite rendering
-- HUD implementation
-- Basic game loop
+Run specs:
 
-### Future Phases
+```bash
+bundle exec rspec
+```
 
-- Game mechanics
-- Advanced game loop and state management
-- Polishing
+## Technical Details
 
-## Development
+This implementation includes:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- **BSP Traversal**: Front-to-back rendering using the map's BSP tree
+- **Visplanes**: Floor/ceiling rendering with R_CheckPlane splitting
+- **Drawsegs**: Wall segment tracking for proper sprite clipping
+- **Texture Mapping**: Perspective-correct texture coordinates
+- **Lighting**: Distance-based light diminishing with colormaps
 
-To install this gem onto your local machine, run `bundle exec rake install`.
+## Legal
 
-## Contributing
+DOOM is a registered trademark of id Software LLC. This is an unofficial fan project.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/khasinski/doom-rb.
+The shareware version of DOOM (Episode 1) is freely distributable. For the full game,
+please purchase DOOM from [Steam](https://store.steampowered.com/app/2280/Ultimate_Doom/),
+[GOG](https://www.gog.com/pl/game/doom_doom_ii), or other retailers.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+GPL-2.0 - Same license as the original DOOM source code.
 
-## Legal
+## Author
 
-Users must own a legal copy of Doom for the WAD files. This project complies with id Software's terms regarding Doom content.
+Chris Hasinski ([@khasinski](https://github.com/khasinski))

data/bin/doom

@@ -1,70 +1,59 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "doom"
-require "optparse"
-
-options = {
-  map: nil,
-  width: 640,
-  height: 480,
-  fullscreen: false
-}
-
-parser = OptionParser.new do |opts|
-  opts.banner = "Usage: doom [options] WAD_FILE"
-
-  opts.on("-m", "--map MAP", "Start the game with a specific map") do |map|
-    options[:map] = map
-  end
-
-  opts.on("-w", "--width WIDTH", Integer, "Set the window width (default: 640)") do |width|
-    options[:width] = width
-  end
-
-  opts.on("-h", "--height HEIGHT", Integer, "Set the window height (default: 480)") do |height|
-    options[:height] = height
-  end
-
-  opts.on("-f", "--fullscreen", "Start in fullscreen mode") do
-    options[:fullscreen] = true
-  end
-
-  opts.on("--help", "Show this help message") do
-    puts opts
-    exit
-  end
+# Enable YJIT if available (Ruby 3.1+) for better performance
+if defined?(RubyVM::YJIT) && RubyVM::YJIT.respond_to?(:enable)
+  RubyVM::YJIT.enable
 end
 
-parser.parse!
-
-if ARGV.empty?
-  puts "Error: WAD file is required"
-  puts parser
-  exit 1
+# Parse arguments before loading heavy dependencies
+wad_path = ARGV[0]
+
+# Show help (before loading anything)
+if wad_path == '-h' || wad_path == '--help'
+  puts "DOOM - Ruby port of the classic 1993 game"
+  puts
+  puts "Usage: doom [OPTIONS] [WAD_FILE]"
+  puts
+  puts "Options:"
+  puts "  -h, --help     Show this help message"
+  puts "  -v, --version  Show version"
+  puts
+  puts "If no WAD file is specified, doom will look for doom1.wad in:"
+  puts "  1. Current directory"
+  puts "  2. ~/.doom/"
+  puts
+  puts "If not found, you'll be prompted to download the shareware version."
+  puts
+  puts "Controls:"
+  puts "  W/Up      - Move forward"
+  puts "  S/Down    - Move backward"
+  puts "  A         - Strafe left"
+  puts "  D         - Strafe right"
+  puts "  Left      - Turn left"
+  puts "  Right     - Turn right"
+  puts "  Mouse     - Look around (click to capture)"
+  puts "  Escape    - Release mouse / Quit"
+  exit 0
 end
 
-wad_file = ARGV[0]
-unless File.exist?(wad_file)
-  puts "Error: WAD file '#{wad_file}' not found"
-  exit 1
+if wad_path == '-v' || wad_path == '--version'
+  require_relative '../lib/doom/version'
+  puts "DOOM Ruby v#{Doom::VERSION}"
+  exit 0
 end
 
+# Now load the full library
+require_relative '../lib/doom'
+
 begin
-  puts "Starting Doom with WAD file: #{wad_file}"
-  puts "Map: #{options[:map] || 'Default'}"
-  puts "Window size: #{options[:width]}x#{options[:height]}"
-  puts "Fullscreen: #{options[:fullscreen]}"
-  
-  Doom.start_game(
-    wad_file,
-    options[:map],
-    options[:width],
-    options[:height],
-    options[:fullscreen]
-  )
-rescue Doom::Error => e
+  # Find or download WAD
+  wad_path = Doom::WadDownloader.ensure_wad_available(wad_path)
+  Doom.run(wad_path)
+rescue Doom::WadDownloader::DownloadError => e
   puts "Error: #{e.message}"
   exit 1
-end
+rescue Interrupt
+  puts "\nQuitting..."
+  exit 0
+end

data/lib/doom/game/player_state.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+module Doom
+  module Game
+    # Tracks player state for HUD display and weapon rendering
+    class PlayerState
+      # Weapons
+      WEAPON_FIST = 0
+      WEAPON_PISTOL = 1
+      WEAPON_SHOTGUN = 2
+      WEAPON_CHAINGUN = 3
+      WEAPON_ROCKET = 4
+      WEAPON_PLASMA = 5
+      WEAPON_BFG = 6
+      WEAPON_CHAINSAW = 7
+
+      # Weapon symbols for graphics lookup
+      WEAPON_NAMES = {
+        WEAPON_FIST => :fist,
+        WEAPON_PISTOL => :pistol,
+        WEAPON_SHOTGUN => :shotgun,
+        WEAPON_CHAINGUN => :chaingun,
+        WEAPON_ROCKET => :rocket,
+        WEAPON_PLASMA => :plasma,
+        WEAPON_BFG => :bfg,
+        WEAPON_CHAINSAW => :chainsaw
+      }.freeze
+
+      # Attack durations (in frames at 35fps)
+      ATTACK_DURATIONS = {
+        WEAPON_FIST => 12,
+        WEAPON_PISTOL => 8,
+        WEAPON_SHOTGUN => 20,
+        WEAPON_CHAINGUN => 4,
+        WEAPON_ROCKET => 16,
+        WEAPON_PLASMA => 6,
+        WEAPON_BFG => 40,
+        WEAPON_CHAINSAW => 4
+      }.freeze
+
+      attr_accessor :health, :armor, :max_health, :max_armor
+      attr_accessor :ammo_bullets, :ammo_shells, :ammo_rockets, :ammo_cells
+      attr_accessor :max_bullets, :max_shells, :max_rockets, :max_cells
+      attr_accessor :weapon, :has_weapons
+      attr_accessor :keys
+      attr_accessor :attacking, :attack_frame, :attack_tics
+      attr_accessor :bob_angle, :bob_amount
+      attr_accessor :is_moving
+
+      def initialize
+        reset
+      end
+
+      def reset
+        @health = 100
+        @armor = 0
+        @max_health = 100
+        @max_armor = 200
+
+        # Ammo
+        @ammo_bullets = 50
+        @ammo_shells = 0
+        @ammo_rockets = 0
+        @ammo_cells = 0
+
+        @max_bullets = 200
+        @max_shells = 50
+        @max_rockets = 50
+        @max_cells = 300
+
+        # Start with fist and pistol
+        @weapon = WEAPON_PISTOL
+        @has_weapons = [true, true, false, false, false, false, false, false]
+
+        # No keys
+        @keys = {
+          blue_card: false,
+          yellow_card: false,
+          red_card: false,
+          blue_skull: false,
+          yellow_skull: false,
+          red_skull: false
+        }
+
+        # Attack state
+        @attacking = false
+        @attack_frame = 0
+        @attack_tics = 0
+
+        # Weapon bob
+        @bob_angle = 0.0
+        @bob_amount = 0.0
+        @is_moving = false
+      end
+
+      def weapon_name
+        WEAPON_NAMES[@weapon]
+      end
+
+      def current_ammo
+        case @weapon
+        when WEAPON_PISTOL, WEAPON_CHAINGUN
+          @ammo_bullets
+        when WEAPON_SHOTGUN
+          @ammo_shells
+        when WEAPON_ROCKET
+          @ammo_rockets
+        when WEAPON_PLASMA, WEAPON_BFG
+          @ammo_cells
+        else
+          nil # Fist/chainsaw don't use ammo
+        end
+      end
+
+      def max_ammo_for_weapon
+        case @weapon
+        when WEAPON_PISTOL, WEAPON_CHAINGUN
+          @max_bullets
+        when WEAPON_SHOTGUN
+          @max_shells
+        when WEAPON_ROCKET
+          @max_rockets
+        when WEAPON_PLASMA, WEAPON_BFG
+          @max_cells
+        else
+          nil
+        end
+      end
+
+      def can_attack?
+        return true if @weapon == WEAPON_FIST || @weapon == WEAPON_CHAINSAW
+
+        ammo = current_ammo
+        ammo && ammo > 0
+      end
+
+      def start_attack
+        return unless can_attack?
+        return if @attacking
+
+        @attacking = true
+        @attack_frame = 0
+        @attack_tics = 0
+
+        # Consume ammo
+        case @weapon
+        when WEAPON_PISTOL
+          @ammo_bullets -= 1 if @ammo_bullets > 0
+        when WEAPON_SHOTGUN
+          @ammo_shells -= 1 if @ammo_shells > 0
+        when WEAPON_CHAINGUN
+          @ammo_bullets -= 1 if @ammo_bullets > 0
+        when WEAPON_ROCKET
+          @ammo_rockets -= 1 if @ammo_rockets > 0
+        when WEAPON_PLASMA
+          @ammo_cells -= 1 if @ammo_cells > 0
+        when WEAPON_BFG
+          @ammo_cells -= 40 if @ammo_cells >= 40
+        end
+      end
+
+      def update_attack
+        return unless @attacking
+
+        @attack_tics += 1
+
+        # Calculate which frame we're on based on tics
+        duration = ATTACK_DURATIONS[@weapon] || 8
+        frame_count = @weapon == WEAPON_FIST ? 3 : 4
+
+        tics_per_frame = duration / frame_count
+        @attack_frame = (@attack_tics / tics_per_frame).to_i
+
+        # Attack finished?
+        if @attack_tics >= duration
+          @attacking = false
+          @attack_frame = 0
+          @attack_tics = 0
+        end
+      end
+
+      def update_bob(delta_time)
+        if @is_moving
+          # Increase bob while moving
+          @bob_angle += delta_time * 10.0
+          @bob_amount = [@bob_amount + delta_time * 16.0, 6.0].min
+        else
+          # Decay bob when stopped
+          @bob_amount = [@bob_amount - delta_time * 12.0, 0.0].max
+        end
+      end
+
+      def weapon_bob_x
+        Math.cos(@bob_angle) * @bob_amount
+      end
+
+      def weapon_bob_y
+        Math.sin(@bob_angle * 2) * @bob_amount * 0.5
+      end
+
+      def health_level
+        # 0 = dying, 4 = full health
+        case @health
+        when 80..200 then 4
+        when 60..79 then 3
+        when 40..59 then 2
+        when 20..39 then 1
+        else 0
+        end
+      end
+
+      def switch_weapon(weapon_num)
+        return unless weapon_num >= 0 && weapon_num < 8
+        return unless @has_weapons[weapon_num]
+        return if @attacking
+
+        @weapon = weapon_num
+      end
+    end
+  end
+end