modsvaskr 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49c9d23f41a3e7e6b7f60f4961e402e28e2136074f6e01e62da3d9a36ec41fce
-  data.tar.gz: 276d691af40d723b2412951654299e7a4d745ac83de2e4c76bd2df1baba4c3a6
+  metadata.gz: 2c41c160023d7591e52e7b93fde57bc33462627d61714384aa3051c8f8052f99
+  data.tar.gz: 4e30b5822a983d6e57772ba65e19d7b8b657163c5b3c4d275bb55a61376c9e2c
 SHA512:
-  metadata.gz: 15c41045b26d2c8d05ab3ec94aa06420745a121402f08a5a0fb3aec1d7ab0bab0a459cb69a9083d34cdcb5b06574ea45a7cedd982be8a9503c791cfe82bff9df
-  data.tar.gz: 9c6370ad8b2f54728beb175a10887227193ad27817237db090d9a99e5a8f1d5eb5c0adac790c5596bb5cfbbd566f6750be665a60ab5e1ef06396a5dec72e0cbf
+  metadata.gz: 61ced31f7a9f75bb9679e47045cdfd38d6071f1eb91587cab8a3aa83c8c6d2de559402e3995b65f020a1acf6ce31d2ca96e31341960906c87f0717991a669f1e
+  data.tar.gz: c7e3610bc8f62f290fa586e66489f5f4e69b40942814a0ba56237716c925cb5ee7878152f58f9dfc94746242d84dd48bd67f96a37e903db3169cafd19ee2f533

data/bin/modsvaskr

@@ -1,11 +1,11 @@
-#!/usr/bin/env ruby
-# require 'mod_organizer'
-require 'modsvaskr/config'
-require 'modsvaskr/ui'
-
-begin
-  Modsvaskr::Ui.new(config: Modsvaskr::Config.new('./modsvaskr.yaml')).run
-rescue
-  puts 'Press Enter to exit.'
-  $stdin.gets
-end
+#!/usr/bin/env ruby
+# require 'mod_organizer'
+require 'modsvaskr/config'
+require 'modsvaskr/ui'
+
+begin
+  Modsvaskr::Ui.new(config: Modsvaskr::Config.new('./modsvaskr.yaml')).run
+rescue
+  puts 'Press Enter to exit.'
+  $stdin.gets
+end

data/lib/modsvaskr/config.rb

@@ -1,79 +1,78 @@
-require 'yaml'
-require 'modsvaskr/game'
-require 'modsvaskr/xedit'
-
-module Modsvaskr
-
-  # Configuration
-  class Config
-
-    # Constructor
-    #
-    # Parameters::
-    # * *file* (String): File containing configuration
-    def initialize(file)
-      @config = YAML.load(File.read(file)) || {}
-      # Parse all game types plugins
-      # Hash<Symbol, Class>
-      @game_types = Hash[
-        Dir.glob("#{__dir__}/games/*.rb").map do |game_type_file|
-          require game_type_file
-          base_name = File.basename(game_type_file, '.rb')
-          [
-            base_name.to_sym,
-            Games.const_get(base_name.split('_').collect(&:capitalize).join.to_sym)
-          ]
-        end
-      ]
-    end
-
-    # Get the games list
-    #
-    # Result::
-    # * Array<Game>: List of games
-    def games
-      unless defined?(@games)
-        @games = (@config['games'] || []).map do |game_info|
-          game_type = game_info['type'].to_sym
-          raise "Unknown game type: #{game_type}. Available ones are #{@game_types.keys.join(', ')}" unless @game_types.key?(game_type)
-          @game_types[game_type].new(self, game_info)
-        end
-      end
-      @games
-    end
-
-    # Return the xEdit path
-    #
-    # Result::
-    # * String: The xEdit path
-    def xedit_path
-      @config['xedit']
-    end
-
-    # Return the 7-Zip path
-    #
-    # Result::
-    # * String: The 7-Zip path
-    def seven_zip_path
-      @config['7zip']
-    end
-
-    # Return the automated keys to apply
-    #
-    # Result::
-    # * Array<String>: The list of automated keys
-    def auto_keys
-      @config['auto_keys'] || []
-    end
-
-    # Return the no_prompt flag
-    #
-    # Result::
-    # * Boolean: no_prompt flag
-    def no_prompt
-      @config['no_prompt'] || false
-    end
-
-  end
-
-end
+require 'yaml'
+require 'modsvaskr/game'
+require 'modsvaskr/xedit'
+
+module Modsvaskr
+
+  # Configuration
+  class Config
+
+    # Constructor
+    #
+    # Parameters::
+    # * *file* (String): File containing configuration
+    def initialize(file)
+      @config = YAML.safe_load(File.read(file)) || {}
+      # Parse all game types plugins
+      # Hash<Symbol, Class>
+      @game_types = Dir.glob("#{__dir__}/games/*.rb").map do |game_type_file|
+        require game_type_file
+        base_name = File.basename(game_type_file, '.rb')
+        [
+          base_name.to_sym,
+          Games.const_get(base_name.split('_').collect(&:capitalize).join.to_sym)
+        ]
+      end.to_h
+    end
+
+    # Get the games list
+    #
+    # Result::
+    # * Array<Game>: List of games
+    def games
+      unless defined?(@games)
+        @games = (@config['games'] || []).map do |game_info|
+          game_type = game_info['type'].to_sym
+          raise "Unknown game type: #{game_type}. Available ones are #{@game_types.keys.join(', ')}" unless @game_types.key?(game_type)
+
+          @game_types[game_type].new(self, game_info)
+        end
+      end
+      @games
+    end
+
+    # Return the xEdit path
+    #
+    # Result::
+    # * String: The xEdit path
+    def xedit_path
+      @config['xedit']
+    end
+
+    # Return the 7-Zip path
+    #
+    # Result::
+    # * String: The 7-Zip path
+    def seven_zip_path
+      @config['7zip']
+    end
+
+    # Return the automated keys to apply
+    #
+    # Result::
+    # * Array<String>: The list of automated keys
+    def auto_keys
+      @config['auto_keys'] || []
+    end
+
+    # Return the no_prompt flag
+    #
+    # Result::
+    # * Boolean: no_prompt flag
+    def no_prompt
+      @config['no_prompt'] || false
+    end
+
+  end
+
+end

data/lib/modsvaskr/encoding.rb

@@ -1,5 +1,6 @@
 module Modsvaskr
 
+  # Provide helpers to encode Windows and Linux strings to UTF-8
   module Encoding
 
     # Convert a string to UTF-8
@@ -8,7 +9,7 @@ module Modsvaskr
     # * *str* (String): The string to convert
     # Result::
     # * String: The converted string
-    def self.to_utf8(str)
+    def self.to_utf_8(str)
       orig_encoding = str.encoding
       encoding = nil
       begin
@@ -21,6 +22,7 @@ module Modsvaskr
         str.force_encoding(orig_encoding)
       end
       raise "Unknown encoding for string #{str[0..127].inspect}" if encoding.nil?
+
       str.encode('UTF-8', encoding)
     end
 

data/lib/modsvaskr/game.rb

@@ -1,203 +1,208 @@
-require 'yaml'
-require 'modsvaskr/logger'
-require 'modsvaskr/run_cmd'
-
-module Modsvaskr
-
-  # Common functionality for any Game
-  class Game
-
-    include Logger, RunCmd
-
-    # Constructor
-    #
-    # Parameters::
-    # * *config* (Config): The config
-    # * *game_info* (Hash<String,Object>): Game info:
-    #   * *name* (String): Game name
-    #   * *path* (String): Game installation dir
-    #   * *launch_exe* (String): Executable to be launched
-    #   * *min_launch_time_secs* (Integer): Minimum expected lauch time for the game, in seconds [default: 10]
-    #   * *tests_poll_secs* (Integer): Interval in seconds to be respected between 2 test statuses polling [default: 5]
-    #   * *timeout_frozen_tests_secs* (Integer): Timeout in seconds of a frozen game [default: 300]
-    #   * *timeout_interrupt_tests_secs* (Integer): Timeout in seconds for the player to interrupt a tests session before restarting the game [default: 10]
-    def initialize(config, game_info)
-      @config = config
-      # Set default values here
-      @game_info = {
-        'min_launch_time_secs' => 10,
-        'tests_poll_secs' => 5,
-        'timeout_frozen_tests_secs' => 300,
-        'timeout_interrupt_tests_secs' => 10
-      }.merge(game_info)
-      @name = name
-      @pid = nil
-      init if self.respond_to?(:init)
-    end
-
-    # Return the game name
-    #
-    # Result::
-    # * String: Game name
-    def name
-      @game_info['name']
-    end
-
-    # Return the game path
-    #
-    # Result::
-    # * String: Game path
-    def path
-      @game_info['path']
-    end
-
-    # Return the launch executable
-    #
-    # Result::
-    # * String: Launch executable
-    def launch_exe
-      @game_info['launch_exe']
-    end
-
-    # Return the tests polling interval
-    #
-    # Result::
-    # * Integer: Tests polling interval
-    def tests_poll_secs
-      @game_info['tests_poll_secs']
-    end
-
-    # Return the timeout to detect a frozen game
-    #
-    # Result::
-    # * Integer: Timeout to detect a frozen game
-    def timeout_frozen_tests_secs
-      @game_info['timeout_frozen_tests_secs']
-    end
-
-    # Return the timeout before restarting a game tests session
-    #
-    # Result::
-    # * Integer: Timeout before restarting a game tests session
-    def timeout_interrupt_tests_secs
-      @game_info['timeout_interrupt_tests_secs']
-    end
-
-    # Return an xEdit instance for this game
-    #
-    # Result::
-    # * Xedit: The xEdit instance
-    def xedit
-      @xedit = Xedit.new(@config.xedit_path, path) unless defined?(@xedit)
-      @xedit
-    end
-
-    # Launch the game, and wait for launch to be successful
-    #
-    # Parameters::
-    # * *autoload* (Boolean or String): If false, then launch the game using the normal launcher. If String, then use AutoLoad to load a given saved file (or empty to continue latest save) [default: false].
-    def launch(autoload: false)
-      # Launch the game
-      @idx_launch = 0 unless defined?(@idx_launch)
-      if autoload
-        log "[ Game #{name} ] - Launch game (##{@idx_launch}) using AutoLoad #{autoload}..."
-        autoload_file = "#{path}/Data/AutoLoad.cmd"
-        if File.exist?(autoload_file)
-          run_cmd({
-            dir: path,
-            exe: 'Data\AutoLoad.cmd',
-            args: [autoload]
-          })
-        else
-          log "[ Game #{name} ] - Missing file #{autoload_file}. Can't use AutoLoad to load game automatically. Please install the AutoLoad mod."
-        end
-      else
-        log "[ Game #{name} ] - Launch game (##{@idx_launch}) using configured launcher (#{launch_exe})..."
-        run_cmd({
-          dir: path,
-          exe: launch_exe
-        })
-      end
-      @idx_launch += 1
-      # The game launches asynchronously, so just wait a little bit and check for the process existence
-      sleep @game_info['min_launch_time_secs']
-      tasklist_stdout = nil
-      loop do
-        tasklist_stdout = `tasklist | find "#{running_exe}"`.strip
-        break unless tasklist_stdout.empty?
-        log "[ Game #{name} ] - #{running_exe} is not running. Wait for its startup..."
-        sleep 1
-      end
-      @pid = Integer(tasklist_stdout.split(' ')[1])
-      log "[ Game #{name} ] - #{running_exe} has started with PID #{@pid}"
-    end
-
-    # Is the game currently running?
-    #
-    # Result::
-    # * Boolean: Is the game currently running?
-    def running?
-      if @pid
-        running = true
-        begin
-          # Process.kill does not work when the game has crashed (the process is still detected as zombie)
-          # running = Process.kill(0, @pid) == 1
-          tasklist_stdout = `tasklist | find "#{running_exe}"`.strip
-          running = !tasklist_stdout.empty?
-          # log "[ Game #{name} ] - Tasklist returned no #{running_exe}:\n#{tasklist_stdout}" unless running
-        rescue Errno::ESRCH
-          log "[ Game #{name} ] - Got error while waiting for #{running_exe} PID #{@pid}: #{$!}"
-          running = false
-        end
-        @pid = nil unless running
-        running
-      else
-        false
-      end
-    end
-
-    # Kill the game, and wait till it is killed
-    def kill
-      if @pid
-        first_time = true
-        while @pid do
-          system "taskkill #{first_time ? '' : '/F '}/pid #{@pid}"
-          first_time = false
-          sleep 1
-          if running?
-            log "[ Game #{name} ] - #{running_exe} is still running (PID #{@pid}). Wait for its kill..."
-            sleep 5
-          end
-        end
-      else
-        log "[ Game #{name} ] - Game not started, so nothing to kill."
-      end
-    end
-
-    # Get the load order.
-    # Keep a cache of it.
-    #
-    # Result::
-    # * Array<String>: List of all active plugins, including masters
-    def get_load_order
-      @cache_load_order = load_order unless defined?(@cache_load_order)
-      @cache_load_order
-    end
-
-    # Get the mod and base id corresponding to a given form id.
-    # Uses load order to determine it.
-    #
-    # Parameters::
-    # * *form_id* (String or Integer): Form ID, either as hexadecimal string, or numercial value
-    # Result::
-    # * String: Plugin name
-    # * Integer: Base form id, independent from the load order
-    def decode_form_id(form_id)
-      form_id = form_id.to_i(16) if form_id.is_a?(String)
-      [get_load_order[form_id / 16_777_216], form_id % 16_777_216]
-    end
-
-
-  end
-
-end
+require 'yaml'
+require 'modsvaskr/logger'
+require 'modsvaskr/run_cmd'
+
+module Modsvaskr
+
+  # Common functionality for any Game
+  class Game
+
+    include RunCmd
+    include Logger
+
+    # Constructor
+    #
+    # Parameters::
+    # * *config* (Config): The config
+    # * *game_info* (Hash<String,Object>): Game info:
+    #   * *name* (String): Game name
+    #   * *path* (String): Game installation dir
+    #   * *launch_exe* (String): Executable to be launched
+    #   * *min_launch_time_secs* (Integer): Minimum expected lauch time for the game, in seconds [default: 10]
+    #   * *tests_poll_secs* (Integer): Interval in seconds to be respected between 2 test statuses polling [default: 5]
+    #   * *timeout_frozen_tests_secs* (Integer): Timeout in seconds of a frozen game [default: 300]
+    #   * *timeout_interrupt_tests_secs* (Integer): Timeout in seconds for the player to interrupt a tests session before restarting the game [default: 10]
+    def initialize(config, game_info)
+      @config = config
+      # Set default values here
+      @game_info = {
+        'min_launch_time_secs' => 10,
+        'tests_poll_secs' => 5,
+        'timeout_frozen_tests_secs' => 300,
+        'timeout_interrupt_tests_secs' => 10
+      }.merge(game_info)
+      @name = name
+      @pid = nil
+      init if respond_to?(:init)
+    end
+
+    # Return the game name
+    #
+    # Result::
+    # * String: Game name
+    def name
+      @game_info['name']
+    end
+
+    # Return the game path
+    #
+    # Result::
+    # * String: Game path
+    def path
+      @game_info['path']
+    end
+
+    # Return the launch executable
+    #
+    # Result::
+    # * String: Launch executable
+    def launch_exe
+      @game_info['launch_exe']
+    end
+
+    # Return the tests polling interval
+    #
+    # Result::
+    # * Integer: Tests polling interval
+    def tests_poll_secs
+      @game_info['tests_poll_secs']
+    end
+
+    # Return the timeout to detect a frozen game
+    #
+    # Result::
+    # * Integer: Timeout to detect a frozen game
+    def timeout_frozen_tests_secs
+      @game_info['timeout_frozen_tests_secs']
+    end
+
+    # Return the timeout before restarting a game tests session
+    #
+    # Result::
+    # * Integer: Timeout before restarting a game tests session
+    def timeout_interrupt_tests_secs
+      @game_info['timeout_interrupt_tests_secs']
+    end
+
+    # Return an xEdit instance for this game
+    #
+    # Result::
+    # * Xedit: The xEdit instance
+    def xedit
+      @xedit = Xedit.new(@config.xedit_path, path) unless defined?(@xedit)
+      @xedit
+    end
+
+    # Launch the game, and wait for launch to be successful
+    #
+    # Parameters::
+    # * *autoload* (Boolean or String): If false, then launch the game using the normal launcher. If String, then use AutoLoad to load a given saved file (or empty to continue latest save) [default: false].
+    def launch(autoload: false)
+      # Launch the game
+      @idx_launch = 0 unless defined?(@idx_launch)
+      if autoload
+        log "[ Game #{name} ] - Launch game (##{@idx_launch}) using AutoLoad #{autoload}..."
+        autoload_file = "#{path}/Data/AutoLoad.cmd"
+        if File.exist?(autoload_file)
+          run_cmd(
+            {
+              dir: path,
+              exe: 'Data\AutoLoad.cmd',
+              args: [autoload]
+            }
+          )
+        else
+          log "[ Game #{name} ] - Missing file #{autoload_file}. Can't use AutoLoad to load game automatically. Please install the AutoLoad mod."
+        end
+      else
+        log "[ Game #{name} ] - Launch game (##{@idx_launch}) using configured launcher (#{launch_exe})..."
+        run_cmd(
+          {
+            dir: path,
+            exe: launch_exe
+          }
+        )
+      end
+      @idx_launch += 1
+      # The game launches asynchronously, so just wait a little bit and check for the process existence
+      sleep @game_info['min_launch_time_secs']
+      tasklist_stdout = nil
+      loop do
+        tasklist_stdout = `tasklist | find "#{running_exe}"`.strip
+        break unless tasklist_stdout.empty?
+
+        log "[ Game #{name} ] - #{running_exe} is not running. Wait for its startup..."
+        sleep 1
+      end
+      @pid = Integer(tasklist_stdout.split[1])
+      log "[ Game #{name} ] - #{running_exe} has started with PID #{@pid}"
+    end
+
+    # Is the game currently running?
+    #
+    # Result::
+    # * Boolean: Is the game currently running?
+    def running?
+      if @pid
+        running = true
+        begin
+          # Process.kill does not work when the game has crashed (the process is still detected as zombie)
+          # running = Process.kill(0, @pid) == 1
+          tasklist_stdout = `tasklist | find "#{running_exe}"`.strip
+          running = !tasklist_stdout.empty?
+          # log "[ Game #{name} ] - Tasklist returned no #{running_exe}:\n#{tasklist_stdout}" unless running
+        rescue Errno::ESRCH
+          log "[ Game #{name} ] - Got error while waiting for #{running_exe} PID #{@pid}: #{$ERROR_INFO}"
+          running = false
+        end
+        @pid = nil unless running
+        running
+      else
+        false
+      end
+    end
+
+    # Kill the game, and wait till it is killed
+    def kill
+      if @pid
+        first_time = true
+        while @pid
+          system "taskkill #{first_time ? '' : '/F '}/pid #{@pid}"
+          first_time = false
+          sleep 1
+          if running?
+            log "[ Game #{name} ] - #{running_exe} is still running (PID #{@pid}). Wait for its kill..."
+            sleep 5
+          end
+        end
+      else
+        log "[ Game #{name} ] - Game not started, so nothing to kill."
+      end
+    end
+
+    # Get the load order.
+    # Keep a cache of it.
+    #
+    # Result::
+    # * Array<String>: List of all active plugins, including masters
+    def load_order
+      @cache_load_order = read_load_order unless defined?(@cache_load_order)
+      @cache_load_order
+    end
+
+    # Get the mod and base id corresponding to a given form id.
+    # Uses load order to determine it.
+    #
+    # Parameters::
+    # * *form_id* (String or Integer): Form ID, either as hexadecimal string, or numercial value
+    # Result::
+    # * String: Plugin name
+    # * Integer: Base form id, independent from the load order
+    def decode_form_id(form_id)
+      form_id = form_id.to_i(16) if form_id.is_a?(String)
+      [load_order[form_id / 16_777_216], form_id % 16_777_216]
+    end
+
+  end
+
+end