mod_organizer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d69da7c062ed92dec29a95678101c8dee6b251c32232a2168e1d945f02cb709
+  data.tar.gz: 7231f3afddc4126af0210a2c9ac8f95dc3fd520bd803e753b5a30b46e8fadd4f
+SHA512:
+  metadata.gz: a141e18fcba85d165e87a1c878503cfe7cbb7023feca45cba1afb9dec333fa70bf2d2f1452a1d06c9827ea557af2bcbf9f49970da15713e029fa481015a43039
+  data.tar.gz: f9c7e766e18fe3e652772b0eb617e2dccbdfd8ecbd0d6859b78c4c7e00400fb3b810b074d96aa6bbb295cab246ae82dec5b812bcea7b370e3bafdf3e7bf31f0d

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# [v0.0.1](https://github.com/Muriel-Salvan/mod_organizer/compare/...v0.0.1) (2023-01-07 18:10:56)
+
+### Patches
+
+* [Added releaserc](https://github.com/Muriel-Salvan/mod_organizer/commit/4d802611296415ec0b5e4141d41874590664873c)
+* [Plugins extension are case sensitive](https://github.com/Muriel-Salvan/mod_organizer/commit/1448f7cd127b9c10878cc9b7472617c60c65a2b2)
+
+# 0.0.1
+
+* Initial version
+* Get mods list with plugin details and sources
+* Get downloads information with NexusMods details

data/LICENSE.md

@@ -0,0 +1,31 @@
+
+The license stated herein is a copy of the BSD License (modified on July 1999).
+The AUTHOR mentionned below refers to the list of people involved in the
+creation and modification of any file included in the delivered package.
+This list is found in the file named AUTHORS.
+The AUTHORS and LICENSE files have to be included in any release of software
+embedding source code of this package, or using it as a derivative software.
+
+Copyright (c) 2019 - 2023 Muriel Salvan (muriel@x-aeon.com)
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+   2. Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+   3. The name of the author may not be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
+OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,68 @@
+# Mod Organizer
+
+Simple Ruby API letting you handle an instance of [Mod Organizer](https://www.nexusmods.com/skyrimspecialedition/mods/6194).
+
+## Install
+
+Via gem
+
+``` bash
+$ gem install mod_organizer
+```
+
+Via a Gemfile
+
+``` ruby
+$ gem 'mod_organizer'
+```
+
+## Usage
+
+``` ruby
+require 'mod_organizer'
+
+mod_organizer = ModOrganizer.new('C:/Program Files/Mod Organizer')
+mod_organizer.mod_names.each do |mod_name|
+  puts "Mod #{mod_name} has #{mod_organizer.mod(mod_name:).plugins.size} plugins"
+end
+```
+
+In case your ModOrganizer instance is not installed as portable, then you have to specify the instance name:
+``` ruby
+mod_organizer = ModOrganizer.new('C:/Program Files/Mod Organizer', instance_name: 'MyInstance')
+```
+
+## Change log
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## Testing
+
+Automated tests are done using rspec.
+
+Do execute them, first install development dependencies:
+
+```bash
+bundle install
+```
+
+Then execute rspec
+
+```bash
+bundle exec rspec
+```
+
+## Contributing
+
+Any contribution is welcome:
+* Fork the github project and create pull requests.
+* Report bugs by creating tickets.
+* Suggest improvements and new features by creating tickets.
+
+## Credits
+
+- [Muriel Salvan][link-author]
+
+## License
+
+The BSD License. Please see [License File](LICENSE.md) for more information.

data/lib/default_categories.dat

@@ -0,0 +1,57 @@
+1|Animations|4,51|0
+52|Poses|29|1
+2|Armour|5,54|0
+53|Power Armor|53|2
+3|Audio|33,35,106|0
+38|Music|34,61|0
+39|Voice|36,107|0
+5|Clothing|9,60|0
+41|Jewelry|102|5
+42|Backpacks|49|5
+6|Collectables|10,92|0
+28|Companions|11,66,96|0
+7|Creatures, Mounts, & Vehicles|12,65,83,101|0
+8|Factions|16,25|0
+9|Gameplay|15,24|0
+27|Combat|77|9
+43|Crafting|50,100|9
+48|Overhauls|24,79|9
+49|Perks|27|9
+54|Radio|31|9
+55|Shouts|104|9
+22|Skills & Levelling|46,73|9
+58|Weather & Lighting|56|9
+44|Equipment|44|43
+45|Home/Settlement|45|43
+10|Body, Face, & Hair|17,26|0
+39|Tattoos|57|10
+40|Character Presets|58|0
+11|Items|27,85|0
+32|Mercantile|23,69|0
+37|Ammo|3|11
+19|Weapons|41,55|11
+36|Weapon & Armour Sets|42|11
+23|Player Homes|28,67|0
+25|Castles & Mansions|68|23
+51|Settlements|48|23
+12|Locations|20,21,22,30,47,70,88,89,90,91|0
+4|Cities|53|12
+31|Landscape Changes|58|0
+29|Environment|14,74|0
+30|Immersion|51,78|0
+20|Magic|75,93,94|0
+21|Models & Textures|19,29|0
+33|Modders resources|18,82|0
+13|NPCs|22,33,99|0
+24|Bugfixes|6,95|0
+14|Patches|25,84|24
+35|Utilities|38,39|0
+26|Cheats|8|0
+15|Quests|30,35|0
+16|Races & Classes|34|0
+34|Stealth|76|0
+17|UI|37,42|0
+18|Visuals|40,62|0
+50|Pip-Boy|52|18
+46|Shader Presets|13,97,105|0
+47|Miscellaneous|2,28|0

data/lib/mod_organizer/download.rb

@@ -0,0 +1,76 @@
+require 'memoist'
+
+class ModOrganizer
+
+  # Object storing information about a downloaded file and giving a lazy API on it to save resources
+  class Download
+
+    extend Memoist
+
+    # Constructor
+    #
+    # Parameters::
+    # * *mod_organizer* (ModOrganizer): The Mod Organizer instance this mod has been instantiated for
+    # * *file_name* (String): The file name for this download
+    def initialize(mod_organizer, file_name)
+      @mod_organizer = mod_organizer
+      @file_name = file_name
+    end
+
+    # Full downloaded file path
+    #
+    # Result::
+    # * String or nil: Full downloaded file path, or nil if does not exist
+    def downloaded_file_path
+      full_path = "#{@mod_organizer.downloads_dir}/#{@file_name}"
+      File.exist?(full_path) ? full_path : nil
+    end
+
+    # Download date of the source
+    #
+    # Result::
+    # * Time or nil: Download date of this source, or nil if no file
+    def downloaded_date
+      file_path = downloaded_file_path
+      file_path ? File.mtime(file_path).utc : nil
+    end
+
+    # NexusMods file name
+    #
+    # Result::
+    # * String:: Original file name from NexusMods
+    def nexus_file_name
+      meta_ini['General']['name']
+    end
+
+    # NexusMods mod ID
+    #
+    # Result::
+    # * Integer:: Mod ID from NexusMods
+    def nexus_mod_id
+      meta_ini['General']['modID']
+    end
+
+    # NexusMods file ID
+    #
+    # Result::
+    # * Integer:: File ID from NexusMods
+    def nexus_file_id
+      meta_ini['General']['fileID']
+    end
+
+    private
+
+    # Return the mod's meta ini file.
+    # Cache it for performance.
+    #
+    # Result::
+    # * Hash: The mod's meta ini content
+    def meta_ini
+      IniFile.load("#{@mod_organizer.downloads_dir}/#{@file_name}.meta")
+    end
+    memoize :meta_ini
+
+  end
+
+end

data/lib/mod_organizer/mod.rb

@@ -0,0 +1,104 @@
+require 'inifile'
+require 'memoist'
+require 'mod_organizer/source'
+require 'mod_organizer/utils'
+
+class ModOrganizer
+
+  # Object storing information about a mod a giving a lazy API on it to save resources (API calls, IO reading, files parsing, esp/bsa exploration...)
+  # A mod is an entry in ModOrganizer list.
+  class Mod
+
+    extend Memoist
+
+    # String: Mod's name
+    attr_reader :name
+
+    # Constructor
+    #
+    # Parameters::
+    # * *mod_organizer* (ModOrganizer): The Mod Organizer instance this mod has been instantiated for
+    # * *mod_path* (String): Directory containing the mod information
+    def initialize(mod_organizer, mod_path)
+      @mod_organizer = mod_organizer
+      @path = mod_path
+      @name = File.basename(@path)
+    end
+
+    # Is this mod enabled in Mod Organizer?
+    #
+    # Result::
+    # * Boolean: Is this mod enabled in Mod Organizer?
+    def enabled?
+      @mod_organizer.enabled_mods.include?(@name)
+    end
+
+    # Return the list of ModOrganizer categories this mod belongs to
+    #
+    # Result::
+    # * Array<String>: List of MO categories
+    def categories
+      meta_ini['General']['category'].to_s.split(',').map do |cat_id|
+        cat_int = Integer(cat_id)
+        cat_int.positive? ? @mod_organizer.categories[cat_int] : nil
+      end.compact
+    end
+
+    # Return the list of plugins this mod is containing.
+    # Cache it.
+    #
+    # Result::
+    # * Array<String>: List of plugins belonging to this mod
+    def plugins
+      (
+        files_glob("#{@path}/*.esm") +
+        files_glob("#{@path}/*.esp") +
+        files_glob("#{@path}/*.esl")
+      ).map { |file_name| File.basename(file_name).downcase }
+    end
+    memoize :plugins
+
+    # Return the list of sources this mod belongs to
+    #
+    # Result::
+    # * Array<Source>: List of source information
+    def sources
+      nbr_sources = meta_ini['installedFiles']['size'] || 1
+      nbr_sources.times.map do |install_idx|
+        Source.new(
+          @mod_organizer,
+          nexus_mod_id: meta_ini['installedFiles']["#{install_idx + 1}\\modid"],
+          nexus_file_id: meta_ini['installedFiles']["#{install_idx + 1}\\fileid"],
+          file_name: install_idx == nbr_sources - 1 ? meta_ini['General']['installationFile'] : nil
+        )
+      end
+    end
+    memoize :sources
+
+    # The mod's URL
+    #
+    # Result::
+    # * String or nil: The mod's URL, or nil if none
+    def url
+      ini_url = meta_ini['General']['url']
+      ini_url.nil? || ini_url.empty? ? nil : ini_url
+    end
+
+    private
+
+    include Utils
+
+    # Return the mod's meta ini file.
+    # Cache it for performance.
+    #
+    # Result::
+    # * Hash: The mod's meta ini content (can be empty of no meta)
+    def meta_ini
+      ini_file = "#{@path}/meta.ini"
+      File.exist?(ini_file) ? IniFile.load(ini_file) : IniFile.new(content: '')
+    end
+    memoize :meta_ini
+
+  end
+
+end

data/lib/mod_organizer/source.rb

@@ -0,0 +1,55 @@
+class ModOrganizer
+
+  # Object storing information about the source of a mod and giving a lazy API on it to save resources
+  # A mod source is something (a file from NexusMods, a manual download...) that has provided content for the mod.
+  class Source
+
+    # Integer or nil: NexusMods mod ID, or nil if none
+    attr_reader :nexus_mod_id
+
+    # Integer or nil: NexusMods file ID, or nil if none
+    attr_reader :nexus_file_id
+
+    # String or nil: File name for this source, or nil if none
+    attr_reader :file_name
+
+    # Constructor
+    #
+    # Parameters::
+    # * *mod_organizer* (ModOrganizer): The Mod Organizer instance this mod has been instantiated for
+    # * *nexus_mod_id* (Integer): Corresponding Nexus mod id, or 0 or nil if none
+    # * *nexus_file_id* (Integer): Corresponding Nexus mod file id, or 0 or nil if none
+    # * *file_name* (String): File name that provided content to this mod, or nil if none
+    def initialize(
+      mod_organizer,
+      nexus_mod_id:,
+      nexus_file_id:,
+      file_name:
+    )
+      @mod_organizer = mod_organizer
+      @nexus_mod_id = nexus_mod_id.nil? || nexus_mod_id.zero? ? nil : nexus_mod_id
+      @nexus_file_id = nexus_file_id.nil? || nexus_file_id.zero? ? nil : nexus_file_id
+      @file_name = file_name
+    end
+
+    # The type of source
+    #
+    # Result::
+    # * Symbol: The source's type. Can be:
+    #   * nexus_mods: Content downloaded from NexusMods
+    #   * unknown: Unknown source
+    def type
+      @nexus_mod_id ? :nexus_mods : :unknown
+    end
+
+    # Get the download info corresponding to this source, or nil if none.
+    #
+    # Result::
+    # * Download or nil: Download info, or nil if none
+    def download
+      @file_name ? @mod_organizer.download(file_name: @file_name) : nil
+    end
+
+  end
+
+end

data/lib/mod_organizer/utils.rb

@@ -0,0 +1,23 @@
+class ModOrganizer
+
+  # Module giving some helpers to various ModOrganizer classes
+  module Utils
+
+    # Return all files matching a glob.
+    # Handle special characters correctly.
+    # Don't return . and ..
+    #
+    # Parameters::
+    # * *glob* (String): The glob
+    # Result::
+    # * Array<String>: The list of files matching the glob
+    def files_glob(glob)
+      Dir.glob(glob.gsub('[', '\\[').gsub(']', '\\]'), File::FNM_DOTMATCH).select do |file|
+        basename = File.basename(file)
+        basename != '.' && basename != '..'
+      end
+    end
+
+  end
+
+end

data/lib/mod_organizer/version.rb

@@ -0,0 +1,5 @@
+class ModOrganizer
+
+  VERSION = '1.0.0'
+
+end

data/lib/mod_organizer.rb

@@ -0,0 +1,148 @@
+require 'csv'
+require 'fileutils'
+require 'json'
+require 'logger'
+require 'memoist'
+require 'tmpdir'
+require 'inifile'
+require 'mod_organizer/download'
+require 'mod_organizer/mod'
+require 'mod_organizer/utils'
+
+# Handle a ModOrganizer installation: mods, esps, load order.
+# No concept of Merges.
+# No concept of what is actually present in the game directory (except already installed masters/plugins and load order).
+class ModOrganizer
+
+  extend Memoist
+
+  # String: The game path
+  attr_reader :game_path
+
+  # String: The downloads dir
+  attr_reader :downloads_dir
+
+  # Constructor
+  #
+  # Parameters::
+  # * *mo_dir* (String): Mod Organizer installation directory
+  # * *instance_name* (String or nil): Mod Organizer instance name, or nil in case of a portable installation. [default: nil]
+  # * *logger* (Logger): The logger to be used for log messages [default: Logger.new(STDOUT)]
+  def initialize(
+    mo_dir,
+    instance_name: nil,
+    logger: Logger.new($stdout)
+  )
+    @mo_dir = mo_dir.gsub('\\', '/')
+    @mo_instance_dir = instance_name.nil? ? @mo_dir : "#{ENV.fetch('LOCALAPPDATA')}/ModOrganizer/#{instance_name}"
+    @logger = logger
+    # Read MO ini file
+    mo_ini_file = "#{@mo_instance_dir}/ModOrganizer.ini"
+    raise "Missing ModOrganizer configuration file #{mo_ini_file}" unless File.exist?(mo_ini_file)
+
+    mo_ini = IniFile.load(mo_ini_file)
+    @selected_profile = mo_ini['General']['selected_profile']
+    @selected_profile = ::Regexp.last_match(1) if @selected_profile =~ /^@ByteArray\((.+)\)$/
+    @game_path = mo_ini['General']['gamePath'].gsub('\\', '/')
+    @game_path = ::Regexp.last_match(1) if @game_path =~ /^@ByteArray\((.+)\)$/
+    @profiles_dir = (mo_ini['Settings']['profiles_directory'] || "#{@mo_instance_dir}/profiles").gsub('\\', '/')
+    @mods_dir = (mo_ini['Settings']['mod_directory'] || "#{@mo_instance_dir}/mods").gsub('\\', '/')
+    @overwrite_dir = (mo_ini['Settings']['overwrite_directory'] || "#{@mo_instance_dir}/overwrite").gsub('\\', '/')
+    @downloads_dir = (mo_ini['Settings']['download_directory'] || "#{@mo_instance_dir}/downloads").gsub('\\', '/')
+    @logger.debug "Selected profile: #{@selected_profile}"
+    @logger.debug "Mods directory: #{@mods_dir}"
+    @logger.debug "Downloads directory: #{@downloads_dir}"
+    @logger.debug "Game path: #{@game_path}"
+  end
+
+  # Run an instance of ModOrganizer
+  def run
+    Dir.chdir(@mo_dir) do
+      system 'ModOrganizer.exe'
+    end
+  end
+
+  # Get the list of mod names
+  #
+  # Result::
+  # * Array<String>: List of mods
+  def mod_names
+    files_glob("#{@mods_dir}/*").map { |mod_dir| File.directory?(mod_dir) ? File.basename(mod_dir) : nil }.compact
+  end
+  memoize :mod_names
+
+  # Retrieve a mod
+  #
+  # Parameters::
+  # * *name* (String): The mod name
+  # Result::
+  # * Mod or nil: The mod, or nil if the mod is unknown
+  def mod(name:)
+    mod_dir = "#{@mods_dir}/#{name}"
+    File.exist?(mod_dir) ? Mod.new(self, mod_dir) : nil
+  end
+  memoize :mod
+
+  # Get the ordered MO mods list, sorted from the first being loaded to the last (so opposite from the internal MO file)
+  #
+  # Result::
+  # * Array<String>: Sorted list of mod names
+  def mods_list
+    modlist.map { |mod_name, _enabled| mod_name }
+  end
+  memoize :mods_list
+
+  # Return the list of enabled mods
+  #
+  # Result::
+  # * Array<String>: Enabled mods
+  def enabled_mods
+    cached_enabled_mods = []
+    modlist.each do |(mod_name, mod_enabled)|
+      cached_enabled_mods << mod_name if mod_enabled
+    end
+    cached_enabled_mods
+  end
+  memoize :enabled_mods
+
+  # Get the categories
+  #
+  # Result::
+  # * Hash<Integer, String>: For each category ID, the corresponding category name
+  def categories
+    categories_file = "#{@mo_dir}/categories.dat"
+    categories_file = "#{__dir__}/default_categories.dat" unless File.exist?(categories_file)
+    CSV.read(categories_file, col_sep: '|').to_h { |cat_id, title, _nexus_ids, _parent_id| [cat_id.to_i, title] }
+  end
+  memoize :categories
+
+  # Return a downloaded info of file if it exists
+  #
+  # Parameters::
+  # * *file_name* (String): The base file name for which we want the download info
+  # Result::
+  # * Download: The downloaded information
+  def download(file_name:)
+    downloaded_file = "#{@downloads_dir}/#{file_name}"
+    File.exist?(downloaded_file) ? Download.new(self, file_name) : nil
+  end
+  memoize :download
+
+  private
+
+  include Utils
+
+  # Get the ordered MO mods list, sorted from the first being loaded to the last (so opposite from the internal MO file)
+  #
+  # Result::
+  # * Array<[String, Boolean]>: Sorted list of mod names with their enabled flag
+  def modlist
+    cached_mods_list = []
+    File.read("#{@profiles_dir}/#{@selected_profile}/modlist.txt").split("\n").each do |line|
+      cached_mods_list << [::Regexp.last_match(2), ::Regexp.last_match(1) == '+'] if line =~ /^([+-])(.+)$/
+    end
+    cached_mods_list.reverse
+  end
+  memoize :modlist
+
+end