Mod Organizer

Simple Ruby API letting you handle an instance of Mod Organizer.

Install

Via gem

$ gem install mod_organizer

Via a Gemfile

$ gem 'mod_organizer'

Usage

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:

mod_organizer = ModOrganizer.new('C:/Program Files/Mod Organizer', instance_name: 'MyInstance')

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

Automated tests are done using rspec.

Do execute them, first install development dependencies:

bundle install

Then execute rspec

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 for more information.