modsvaskr 0.2.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29dad9a5413e803a1980b6d0d9aa4f71e66c8c233c0398b30eacb03c3a35d563
-  data.tar.gz: 0b9fb7f2efd87394746327fd79783717cb0871eb83f5447a395b411e8c8adfd9
+  metadata.gz: 3b3bda4db035df3b3289829342c1a70a47be0191de49f35e72c2e25f6e8aaada
+  data.tar.gz: bed82e160e1310241b870e8545a08913b81caf210f5388121afd1fc465ad01c1
 SHA512:
-  metadata.gz: 55cc0a939035ec8dbebb92f4d2e96f168faeb81b486370122951c795933088214ec90585fb6fe2a62d2cb6be55a86a1ab4d7062c43a5a7056abe4292ecbb82d5
-  data.tar.gz: aeb1f38ccfa4cf5f1e0362b350ad8f219e6ac92b2a3c5bf1027e4a03a3f45242d5a00fc02fc3425d420e8e72669e3c3135f415ad4b926692ef45581bb494af24
+  metadata.gz: 35e165ef5571a0a54c47393aea22ec848e42be1d6d27940f8a23e24fba00b35da00677049b474d1370ba7b4fadf4de9088089ec8cb582ceb8c2c1de489490cf5
+  data.tar.gz: '08ade008d6263b3bef50df32efeda147e409e2f9c7644177ccaa03c112a9aafdb4f54e3102eb98b56814e6fbe42210d72df176d7e4feb0cb2341f3117faf72aa'

data/bin/modsvaskr

@@ -1,11 +1,12 @@
 #!/usr/bin/env ruby
-# require 'mod_organizer'
+require 'English'
 require 'modsvaskr/config'
 require 'modsvaskr/ui'
 
 begin
   Modsvaskr::Ui.new(config: Modsvaskr::Config.new('./modsvaskr.yaml')).run
 rescue
+  puts "An exception has occurred: #{$ERROR_INFO}\n#{$ERROR_INFO.backtrace.join("\n")}"
   puts 'Press Enter to exit.'
   $stdin.gets
 end

data/lib/modsvaskr/config.rb

@@ -1,3 +1,4 @@
+require 'mod_organizer'
 require 'yaml'
 require 'modsvaskr/game'
 require 'modsvaskr/xedit'
@@ -73,6 +74,19 @@ module Modsvaskr
       @config['no_prompt'] || false
     end
 
+    # Return the ModOrganizer instance, if configured.
+    #
+    # Result::
+    # * ModOrganizer or nil: The ModOrganizer instance, or nil if none
+    def mod_organizer
+      return nil unless @config['mod_organizer']
+
+      ModOrganizer.new(
+        @config['mod_organizer']['installation_dir'],
+        instance_name: @config['mod_organizer']['instance_name']
+      )
+    end
+
   end
 
 end

data/lib/modsvaskr/game.rb

@@ -203,6 +203,29 @@ module Modsvaskr
       [load_order[form_id / 16_777_216], form_id % 16_777_216]
     end
 
+    # Clean a list plugins.
+    # Make sure they are cleaned in the right order, according to the load order.
+    # Put the cleaned plugins in a cleaned_plugins subfolder.
+    # Make sure that subsequent plugins to be cleaned are cleaned with the previously cleaned plugins in the list.
+    #
+    # Parameters::
+    # * *plugins* (Array<String>): List of plugins to be cleaned
+    def clean_plugins(plugins)
+      return if plugins.empty?
+
+      esp = (load_order & plugins).first
+      log "Clean #{esp}"
+      FileUtils.cp "#{path}/Data/#{esp}", "#{path}/Data/#{esp}.backup"
+      begin
+        xedit.quick_auto_clean(esp)
+        clean_plugins(plugins - [esp])
+        FileUtils.mkdir_p "#{path}/Data/cleaned_plugins"
+        FileUtils.mv "#{path}/Data/#{esp}", "#{path}/Data/cleaned_plugins/#{esp}"
+      ensure
+        FileUtils.mv "#{path}/Data/#{esp}.backup", "#{path}/Data/#{esp}"
+      end
+    end
+
   end
 
 end

data/lib/modsvaskr/ui.rb

@@ -1,5 +1,6 @@
 require 'English'
 require 'curses_menu'
+require 'launchy'
 require 'modsvaskr/logger'
 require 'modsvaskr/tests_runner'
 require 'modsvaskr/run_cmd'
@@ -20,8 +21,12 @@ module Modsvaskr
     def initialize(config:)
       log "Launch Modsvaskr UI v#{Modsvaskr::VERSION} - Logs in #{Logger.log_file}"
       @config = config
+      @mod_organizer = @config.mod_organizer
     end
 
+    # Time that should be before any file time of mods (used for sorting)
+    TIME_BEGIN = Time.parse('2000-01-01')
+
     # Run the UI
     def run
       last_modsvaskr_version = nil
@@ -44,7 +49,13 @@ module Modsvaskr
         end
       end
       CursesMenu.new(
-        "Modsvaskr v#{Modsvaskr::VERSION} - Stronghold of Mods#{!last_modsvaskr_version.nil? && last_modsvaskr_version != Modsvaskr::VERSION ? " - !!! New version available: #{last_modsvaskr_version}" : ''}",
+        "Modsvaskr v#{Modsvaskr::VERSION} - Stronghold of Mods#{
+          if !last_modsvaskr_version.nil? && last_modsvaskr_version != Modsvaskr::VERSION
+            " - !!! New version available: #{last_modsvaskr_version}"
+          else
+            ''
+          end
+        }",
         key_presses:
       ) do |main_menu|
         @config.games.each do |game|
@@ -53,6 +64,27 @@ module Modsvaskr
               "Modsvaskr v#{Modsvaskr::VERSION} - Stronghold of Mods > #{game.name}",
               key_presses:
             ) do |game_menu|
+              game_menu.item 'Plugins' do
+                selected_esps = {}
+                CursesMenu.new(
+                  "Modsvaskr v#{Modsvaskr::VERSION} - Stronghold of Mods > #{game.name} > Plugins",
+                  key_presses:
+                ) do |plugins_menu|
+                  game.load_order.each.with_index do |esp, idx|
+                    plugins_menu.item "[#{selected_esps.key?(esp) ? '*' : ' '}] #{idx} - #{esp}" do
+                      if selected_esps.key?(esp)
+                        selected_esps.delete(esp)
+                      else
+                        selected_esps[esp] = nil
+                      end
+                      :menu_refresh
+                    end
+                  end
+                  plugins_menu.item "Clean #{selected_esps.size} selected plugins" do
+                    game.clean_plugins(selected_esps.keys)
+                  end
+                end
+              end
               game_menu.item 'Testing' do
                 # Read tests info
                 tests_runner = TestsRunner.new(@config, game)
@@ -176,6 +208,102 @@ module Modsvaskr
             end
           end
         end
+        unless @mod_organizer.nil?
+          main_menu.item 'Mods Organizer' do
+            CursesMenu.new(
+              'Modsvaskr - Stronghold of Mods > Mods Organizer',
+              key_presses:
+            ) do |mo_menu|
+              # Show status
+              mo_menu.item 'Run Mod Organizer' do
+                @mod_organizer.run
+              end
+              mo_menu.item "#{@mod_organizer.mod_names.size} mods (#{@mod_organizer.mod_names.select { |mod_name| @mod_organizer.mod(name: mod_name).enabled? }.size} enabled)" do
+                CursesMenu.new(
+                  'Modsvaskr - Stronghold of Mods > Mods Organizer > Mods',
+                  key_presses:
+                ) do |mods_menu|
+                  mod_names = @mod_organizer.mods_list
+                  idx_size = (mod_names.size - 1).to_s.size
+                  mod_names.each.with_index do |mod_name, idx|
+                    mod = @mod_organizer.mod(name: mod_name)
+                    # need_update = false
+                    mods_menu.item(
+                      proc do
+                        sections = {
+                          enabled_cell: {
+                            text: mod.enabled? ? 'X' : ' ',
+                            begin_with: '[',
+                            end_with: ']',
+                            fixed_size: 3
+                          },
+                          idx_cell: {
+                            text: idx.to_s,
+                            fixed_size: idx_size
+                          },
+                          name_cell: {
+                            text: mod_name,
+                            color_pair: CursesMenu::COLORS_GREEN,
+                            fixed_size: 64
+                          },
+                          categories_cell: {
+                            text: mod.categories.map { |category| "[#{category}]" }.join(' '),
+                            fixed_size: 16
+                          },
+                          esps_cell: {
+                            text: "#{mod.plugins.size} plugins",
+                            fixed_size: 10
+                          }
+                        }
+                        mod.sources.sort_by { |source| source.download.nil? ? TIME_BEGIN : source.download.downloaded_date }.each.with_index do |source, src_idx|
+                          source_name = src_idx.zero? ? '' : '+ '
+                          source_name <<
+                            case source.type
+                            when :nexus_mods
+                              "Nexus Mod #{source.nexus_mod_id}/" +
+                                if source.download&.nexus_file_name
+                                  source.download&.nexus_file_name
+                                elsif source.file_name
+                                  source.file_name
+                                else
+                                  '<Unknown file>'
+                                end
+                            when :unknown
+                              source.file_name || '<Unknown source>'
+                            else
+                              raise "Unknown source type: #{source.type} for #{mod.name}"
+                            end
+                          sections["source_#{src_idx}".to_sym] = {
+                            text: source_name,
+                            color_pair: CursesMenu::COLORS_WHITE
+                          }
+                        end
+                        CursesMenu::CursesRow.new(sections)
+                      end,
+                      actions: proc do
+                        actions = {}
+                        # TODO: Use downloads' URL instead of mod's URL as it is very often more accurate
+                        if mod.url
+                          actions['v'] = {
+                            name: 'Visit',
+                            execute: proc { Launchy.open(mod.url) }
+                          }
+                        end
+                        actions
+                      end
+                    )
+                  end
+                  mods_menu.item 'Back' do
+                    :menu_exit
+                  end
+                end
+              end
+              mo_menu.item 'Back' do
+                :menu_exit
+              end
+            end
+          end
+        end
         main_menu.item 'See logs' do
           CursesMenu.new(
             'Modsvaskr - Stronghold of Mods > Logs',

data/lib/modsvaskr/version.rb

@@ -1,5 +1,5 @@
 module Modsvaskr
 
-  VERSION = '0.2.1'
+  VERSION = '1.1.0'
 
 end

data/lib/modsvaskr/xedit.rb

@@ -1,5 +1,6 @@
 require 'csv'
 require 'modsvaskr/encoding'
+require 'modsvaskr/logger'
 require 'modsvaskr/run_cmd'
 
 module Modsvaskr
@@ -7,6 +8,7 @@ module Modsvaskr
   # Helper to use an instance of xEdit
   class Xedit
 
+    include Logger
     include RunCmd
 
     # String: Installation path
@@ -49,6 +51,24 @@ module Modsvaskr
       @runs[script] = nil
     end
 
+    # Run a QuickAutoClean of a given plugin
+    #
+    # Parameters::
+    # * *esp* (String): Plugin to autoclean
+    def quick_auto_clean(esp)
+      # TODO: Find a way to select the right esp automatically
+      out "Please double-click on the following plugin: #{esp}"
+      run_cmd(
+        {
+          dir: @install_path,
+          exe: 'SSEEdit.exe'
+        },
+        args: %w[
+          -quickautoclean
+        ]
+      )
+    end
+
     # Parse a CSV that has been dumped by a previous run of xEdit
     #
     # Parameters::

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modsvaskr
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-31 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses_menu
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: elder_scrolls_plugin
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: mod_organizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -100,28 +128,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.41'
+        version: '1.47'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.41'
+        version: '1.47'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.16'
+        version: '2.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.16'
+        version: '2.18'
 description: Command-line UI handling a full Mods' ecosystem for Bethesda's games.
 email:
 - muriel@x-aeon.com