hytale 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca11b549d14d2bd553261112ed5d9397d3521677ea5ecbd4595960c821e805e6
-  data.tar.gz: 6f52dcc127393200cfdf3cd3332c5404dbfa168c02e3299b24c5e444450b4a1c
+  metadata.gz: 00d6560e486235a55ab2450d656b61421b6fddb8b9b40c3c3226a1df754f8724
+  data.tar.gz: 81194f4a57ffb54903a48f2d6361e101ab35049245cd654e7631e81f30949187
 SHA512:
-  metadata.gz: 29a3bcf4aad9b01adc248bc014b2cede5221950b72152e3e18add25ba7858776885ddfaf799406f0da88ace286abb20577cd30e1786c37f4348783cb7c0db388
-  data.tar.gz: 34f3c99f23607f0e5ef6577ca4a0699037591302bafb58865392d9cd4293cbaa878938e1eee8c222207407d179389620c2f07a77f9c5af6d772d82eb8b95ac75
+  metadata.gz: 80355bb885697efd829c1807ba7ae3d91436fb654ee1a40f0af1a4d3de0a5f6794ffa0801e3b06f5f832b8b01b7d27cccc25c0d8b96882fee57a32eb283696af
+  data.tar.gz: d219d3d0363f5e4fd79d1affb96e272c53a5e3565d0ede2a9a2837e269aa449441324dbd55b44c9f6dd07c1bf2930ca415baffe29e1926b2ba8a3590f22ca9ef

data/README.md

@@ -4,7 +4,7 @@
 
   <p>
     <a href="https://rubygems.org/gems/hytale"><img alt="Gem Version" src="https://img.shields.io/gem/v/hytale"></a>
-    <a href="https://github.com/marcoroth/hytale-ruby/blob/main/LICENSE.txt"><img alt="License" src="https://img.shields.io/github/license/marcoroth/hytale"></a>
+    <a href="https://github.com/marcoroth/hytale-ruby/blob/main/LICENSE.txt"><img alt="License" src="https://img.shields.io/github/license/marcoroth/hytale-ruby"></a>
   </p>
 
   <p>Read and parse Hytale game data including settings, saves, players, and launcher logs.<br/>Cross-platform support for macOS, Windows, and Linux.</p>
@@ -295,10 +295,10 @@ save = Hytale.client.save("New World")
 player = save.players.first
 
 player.name                # => "marcoroth"
-player.uuid                # => "79816d74-0500-4dad-9767-06af86c17243"
+player.uuid                # => "00000000-0000-0000-0000-000000000000"
 player.position            # => (590.75, 123.0, 374.2)
 player.game_mode           # => "Adventure"
-player.discovered_zones    # => ["Zone1_Spawn", "Zone1_Tier1", ...]
+player.discovered_zones    # => [Zone::Region, Zone::Region, ...]
 player.skin                # => PlayerSkin object
 player.avatar_preview_path # => "/path/to/CachedAvatarPreviews/uuid.png"
 ```
@@ -333,10 +333,24 @@ end
 |------|-------------|
 | `hotbar` | 9-slot quick access bar |
 | `storage` | Main inventory (36 slots) |
+| `backpack` | Optional backpack storage (if equipped) |
 | `armor` | Head, chest, hands, legs |
 | `utility` | Utility items (4 slots) |
 | `tools` | Builder/editor tools |
 
+**Check if player has a backpack:**
+
+```ruby
+player.inventory.backpack?  # => true/false
+```
+
+**ItemStorage type checks:**
+
+```ruby
+player.inventory.backpack.empty?   # => true (type is "Empty" - no backpack equipped)
+player.inventory.backpack.simple?  # => true (type is "Simple" - backpack equipped)
+```
+
 **Item properties:**
 
 ```ruby
@@ -349,6 +363,79 @@ item.durability_percent # => 14.9
 item.damaged?           # => true
 ```
 
+### Zones and Regions
+
+Hytale organizes the world into zones (biomes) and regions (areas within zones):
+
+**Zones (biomes):**
+
+**List all zones (requires game to be installed):**
+
+```ruby
+Hytale::Client::Zone.all
+# => [#<Zone id="Emerald_Wilds">, #<Zone id="Howling_Sands">, ...]
+```
+
+**Find a specific zone:**
+
+```ruby
+zone = Hytale::Client::Zone.find("Emerald_Wilds")
+zone.id      # => "Emerald_Wilds"
+zone.name    # => "Emerald Wilds"
+```
+
+**Get all regions in a zone:**
+
+```ruby
+zone.regions
+# => [#<Zone::Region id="Zone1_Spawn">, #<Zone::Region id="Zone1_Tier1">, ...]
+```
+
+**Regions (areas within zones):**
+
+**List all regions:**
+
+```ruby
+Hytale::Client::Zone::Region.all
+# => [#<Zone::Region id="Zone1_Spawn">, #<Zone::Region id="Zone1_Tier1">, ...]
+```
+
+**Find a specific region:**
+
+```ruby
+region = Hytale::Client::Zone::Region.find("Zone1_Tier1")
+region.id          # => "Zone1_Tier1"
+region.name        # => "Drifting Plains"
+region.region_name # => "Drifting Plains"
+```
+
+**Navigate to parent zone:**
+
+```ruby
+region.zone        # => #<Zone id="Emerald_Wilds">
+region.zone.name   # => "Emerald Wilds"
+```
+
+**Player discovered zones:**
+
+```ruby
+player.discovered_zones.each do |region|
+  puts "#{region.name} (#{region.zone.name})"
+end
+# => First Gate of the Echo (Emerald Wilds)
+# => Drifting Plains (Emerald Wilds)
+```
+
+**Zone/Region mapping:**
+
+| Zone | Region Prefix | Example Regions |
+|------|---------------|-----------------|
+| Emerald Wilds | Zone1_* | Zone1_Spawn, Zone1_Tier1, Zone1_Tier2, Zone1_Tier3 |
+| Howling Sands | Zone2_* | Zone2_Tier1, Zone2_Tier2, Zone2_Tier3 |
+| Whisperfrost Frontiers | Zone3_* | Zone3_Tier1, Zone3_Tier2, Zone3_Tier3 |
+| Devastated Lands | Zone4_* | Zone4_Tier4, Zone4_Tier5 |
+| Oceans | Oceans | Oceans |
+
 ### Memories (Discovered Creatures)
 
 Track discovered NPCs and creatures:
@@ -625,8 +712,8 @@ chunk = region.each_chunk.first
 
 chunk.block_types      # => ["Rock_Stone", "Soil_Dirt", "Soil_Grass", ...]
 chunk.terrain_type     # => :grassland
-chunk.has_water?       # => false
-chunk.has_vegetation?  # => true
+chunk.water?           # => false
+chunk.vegetation?      # => true
 chunk.local_x          # => 15
 chunk.local_z          # => 8
 chunk.world_x          # => -272
@@ -793,6 +880,34 @@ process.pid      # => 12345
 | `player_skins` | List all cached PlayerSkin objects |
 | `player_skin(uuid)` | Find PlayerSkin by UUID |
 
+### Hytale::Client::Zone
+
+| Method | Description |
+|--------|-------------|
+| `all` | List all Zone objects (from locale) |
+| `find(id)` | Find Zone by ID, returns nil if not found |
+| `new(id)` | Create a Zone::Base instance |
+
+### Hytale::Client::Zone::Base
+
+| Method | Description |
+|--------|-------------|
+| `id` | Zone ID (e.g., "Emerald_Wilds") |
+| `name` | Translated zone name (e.g., "Emerald Wilds") |
+| `regions` | All Region objects belonging to this zone |
+
+### Hytale::Client::Zone::Region
+
+| Method | Description |
+|--------|-------------|
+| `all` | List all Region objects (from locale) |
+| `find(id)` | Find Region by ID, returns nil if not found |
+| `id` | Region ID (e.g., "Zone1_Tier1") |
+| `name` | Translated region name (e.g., "Drifting Plains") |
+| `region_name` | Same as `name` |
+| `zone` | Parent Zone::Base object |
+| `zone_name` | Parent zone's translated name |
+
 ### Hytale::Client::Map
 
 | Method | Description |
@@ -839,8 +954,8 @@ process.pid      # => 12345
 | `block_types` | Block type IDs found in chunk |
 | `block_palette` | Parsed palette (index → block name) |
 | `terrain_type` | Detected terrain (`:grassland`, `:water`, etc.) |
-| `has_water?` | Contains water blocks |
-| `has_vegetation?` | Contains plant/grass blocks |
+| `water?` | Contains water blocks |
+| `vegetation?` | Contains plant/grass blocks |
 | `to_ascii_map` | 16x16 ASCII representation |
 
 ### Hytale::Client::Map::Block
@@ -1169,8 +1284,8 @@ Hytale.client.player_skins
 **Find a specific skin:**
 
 ```ruby
-skin = Hytale.client.player_skin("79816d74-0500-4dad-9767-06af86c17243")
-skin.uuid  # => "79816d74-0500-4dad-9767-06af86c17243"
+skin = Hytale.client.player_skin("00000000-0000-0000-0000-000000000000")
+skin.uuid  # => "00000000-0000-0000-0000-000000000000"
 ```
 
 **Appearance:**

data/lib/hytale/client/launcher_log/launcher_log_session.rb

@@ -24,7 +24,9 @@ module Hytale
         def profile_uuid
           profile_entry = entries.find { |e| e.message&.include?("setting current profile") }
 
-          profile_entry&.message&.match(/to (\S+)/)&.[](1)
+          return nil unless profile_entry
+
+          profile_entry.message&.match(/to (\S+)/)&.[](1)
         end
 
         def game_launched?

data/lib/hytale/client/launcher_log.rb

@@ -48,12 +48,18 @@ module Hytale
 
       def current_profile_uuid
         profile_entry = entries.reverse.find { |e| e.message&.include?("setting current profile") }
-        profile_entry&.message&.match(/to (\S+)/)&.[](1)
+
+        return nil unless profile_entry
+
+        profile_entry.message&.match(/to (\S+)/)&.[](1)
       end
 
       def current_channel
         channel_entry = entries.reverse.find { |e| e.message&.include?("setting channel") }
-        channel_entry&.attributes&.[]("channel")
+
+        return nil unless channel_entry
+
+        channel_entry.attributes&.[]("channel")
       end
 
       def last_game_launch
@@ -61,7 +67,6 @@ module Hytale
       end
 
       def sessions
-        # Group entries by launcher start
         sessions = []
         current_session = nil
 

data/lib/hytale/client/map/chunk.rb

@@ -63,26 +63,26 @@ module Hytale
           @block_palette ||= extract_palette
         end
 
-        def has_block?(block_type)
+        def block?(block_type)
           block_types.include?(block_type)
         end
 
-        def has_water?
+        def water?
           block_types.any? { |t| t.include?("Water") }
         end
 
-        def has_vegetation?
+        def vegetation?
           block_types.any? { |t| t.include?("Plant") || t.include?("Grass") || t.include?("Tree") }
         end
 
         def terrain_type
-          if has_water?
+          if water?
             :water
           elsif block_types.any? { |t| t.include?("Sand") }
             :desert
           elsif block_types.any? { |t| t.include?("Snow") || t.include?("Ice") }
             :snow
-          elsif has_vegetation?
+          elsif vegetation?
             :grassland
           else
             :rocky
@@ -195,9 +195,7 @@ module Hytale
         def cache_path(texture_scale: 16, shading: true)
           return nil unless region
 
-          save_name = region.path.split("/").find do |p|
-            p.include?("Saves")
-          end&.then { |_| region.path.split("Saves/")[1]&.split("/")&.first } || "unknown"
+          save_name = region.path.split("/").find { |p| p.include?("Saves") }&.then { |_| region.path.split("Saves/")[1]&.split("/")&.first } || "unknown"
           world_name = region.path.split("/worlds/")[1]&.split("/")&.first || "default"
 
           cache_dir = File.join(
@@ -217,14 +215,17 @@ module Hytale
 
         def cached?(texture_scale: 16, shading: true)
           path = cache_path(texture_scale: texture_scale, shading: shading)
+
           path && File.exist?(path)
         end
 
         def clear_cache!
           path = cache_path
+
           return unless path
 
           dir = File.dirname(path)
+
           FileUtils.rm_rf(dir) if File.directory?(dir)
         end
 
@@ -238,6 +239,7 @@ module Hytale
           return nil unless type_id
 
           block_type = get_or_create_block_type(type_id)
+
           Block.new(block_type, x: x, y: y, z: z, chunk: self)
         end
 
@@ -643,7 +645,7 @@ module Hytale
                 index_position = position + 1 + length + 2
                 index = begin
                   search_data[index_position].ord
-                rescue StandardError
+                rescue StandardError # rubocop:disable Metrics/BlockNesting
                   nil
                 end
 

data/lib/hytale/client/map/renderer.rb

@@ -415,12 +415,10 @@ module Hytale
             ChunkyPNG::Color.rgb(194, 178, 128)
           when /Snow/, /Ice/
             ChunkyPNG::Color.rgb(240, 240, 255)
-          when /Dirt/
+          when /Dirt/, /Wood/
             ChunkyPNG::Color.rgb(139, 90, 43)
           when /Stone/, /Rock/
             ChunkyPNG::Color.rgb(128, 128, 128)
-          when /Wood/
-            ChunkyPNG::Color.rgb(139, 90, 43)
           when /Plant/
             ChunkyPNG::Color.rgb(34, 139, 34)
           when /Ore/

data/lib/hytale/client/player/inventory.rb

@@ -16,6 +16,10 @@ module Hytale
           @storage ||= ItemStorage.new(data["Storage"] || {})
         end
 
+        def backpack
+          @backpack ||= ItemStorage.new(data["Backpack"] || {})
+        end
+
         def hotbar
           @hotbar ||= ItemStorage.new(data["HotBar"] || {})
         end
@@ -35,8 +39,12 @@ module Hytale
         def active_hotbar_slot = data["ActiveHotbarSlot"]
         def sort_type = data["SortType"]
 
+        def backpack?
+          backpack&.simple?
+        end
+
         def all_items
-          [storage, hotbar, armor, utility, tools].flat_map(&:items)
+          [storage, backpack, hotbar, armor, utility, tools].flat_map(&:items)
         end
 
         def to_h = data

data/lib/hytale/client/player/item_storage.rb

@@ -13,6 +13,14 @@ module Hytale
         def capacity = data["Capacity"]
         def type = data["Id"]
 
+        def empty?
+          type == "Empty"
+        end
+
+        def simple?
+          type == "Simple"
+        end
+
         def items
           (data["Items"] || {}).map do |slot, item_data|
             Item.new(item_data, slot: slot.to_i)

data/lib/hytale/client/player.rb

@@ -57,7 +57,9 @@ module Hytale
       end
 
       def discovered_zones
-        player_data.dig("PlayerData", "DiscoveredZones") || []
+        @discovered_zones ||= (player_data.dig("PlayerData", "DiscoveredZones") || []).map do |id|
+          Hytale::Client::Zone::Region.new(id)
+        end
       end
 
       def respawn_points

data/lib/hytale/client/settings.rb

@@ -10,7 +10,6 @@ module Hytale
         @path = path
       end
 
-      # Display settings
       def fullscreen? = data["Fullscreen"]
       def maximized? = data["Maximized"]
       def window_width = data["WindowWidth"]
@@ -21,12 +20,10 @@ module Hytale
       def unlimited_fps? = data["UnlimitedFps"]
       def field_of_view = data["FieldOfView"]
 
-      # Rendering settings
       def rendering
         @rendering ||= RenderingSettings.new(data["RenderingSettings"] || {})
       end
 
-      # Input settings
       def input_bindings
         @input_bindings ||= InputBindings.new(data["InputBindings"] || {})
       end
@@ -35,22 +32,18 @@ module Hytale
         @mouse_settings ||= MouseSettings.new(data["MouseSettings"] || {})
       end
 
-      # Audio settings
       def audio
         @audio ||= AudioSettings.new(data["AudioSettings"] || {})
       end
 
-      # Gameplay settings
       def gameplay
         @gameplay ||= GameplaySettings.new(data["GameplaySettings"] || {})
       end
 
-      # Builder tools settings
       def builder_tools
         @builder_tools ||= BuilderToolsSettings.new(data["BuilderToolsSettings"] || {})
       end
 
-      # UI preferences
       def hide_hud? = data["HideHud"]
       def hide_hotbar? = data["HideHotbar"]
       def hide_compass? = data["HideCompass"]

data/lib/hytale/client/zone/region.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Hytale
+  module Client
+    module Zone
+      class Region
+        class << self
+          def all
+            Locale.regions.keys.map { |id| new(id) }
+          end
+
+          def find(id)
+            new(id) if Locale.region_name(id)
+          end
+        end
+
+        attr_reader :id
+
+        def initialize(id)
+          @id = id
+        end
+
+        def name
+          Locale.region_name(id) || id
+        end
+
+        def zone
+          zone_id = REGION_PREFIX_TO_ZONE.find { |prefix, _| id.start_with?(prefix) }&.last
+
+          Zone.new(zone_id) if zone_id
+        end
+
+        def to_s = name
+        def inspect = "#<Zone::Region id=#{id.inspect} name=#{name.inspect}>"
+
+        def ==(other)
+          case other
+          when Region then id == other.id
+          when String then id == other
+          else false
+          end
+        end
+
+        alias eql? ==
+
+        def hash
+          id.hash
+        end
+      end
+    end
+  end
+end

data/lib/hytale/client/zone.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Hytale
+  module Client
+    module Zone
+      ZONE_TO_REGION_PREFIX = {
+        "Emerald_Wilds" => "Zone1",
+        "Howling_Sands" => "Zone2",
+        "Whisperfrost_Frontiers" => "Zone3",
+        "Devastated_Lands" => "Zone4",
+        "Oceans" => "Oceans",
+      }.freeze
+
+      REGION_PREFIX_TO_ZONE = ZONE_TO_REGION_PREFIX.invert.freeze
+
+      class << self
+        def all
+          Locale.zones.keys.map { |id| new(id) }
+        end
+
+        def find(id)
+          new(id) if Locale.zone_name(id)
+        end
+
+        def new(id)
+          Zone::Base.new(id)
+        end
+      end
+
+      class Base
+        attr_reader :id
+
+        def initialize(id)
+          @id = id
+        end
+
+        def name
+          Locale.zone_name(id) || id
+        end
+
+        def regions
+          prefix = ZONE_TO_REGION_PREFIX[id]
+
+          return [] unless prefix
+
+          Region.all.select { |region| region.id.start_with?(prefix) }
+        end
+
+        def to_s = name
+        def inspect = "#<Zone id=#{id.inspect} name=#{name.inspect}>"
+
+        def ==(other)
+          case other
+          when Base then id == other.id
+          when String then id == other
+          else false
+          end
+        end
+
+        alias eql? ==
+
+        def hash
+          id.hash
+        end
+      end
+    end
+  end
+end

data/lib/hytale/server/process.rb

@@ -3,6 +3,9 @@
 module Hytale
   module Server
     class Process
+      def self.running?
+        false
+      end
     end
   end
 end

data/lib/hytale/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hytale
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hytale
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Marco Roth
@@ -123,6 +123,8 @@ files:
 - lib/hytale/client/world.rb
 - lib/hytale/client/world/client_effects.rb
 - lib/hytale/client/world/death_settings.rb
+- lib/hytale/client/zone.rb
+- lib/hytale/client/zone/region.rb
 - lib/hytale/server.rb
 - lib/hytale/server/process.rb
 - lib/hytale/version.rb