mmi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 013ded8588d84a0bae1c8220648116e88d5d3953047ccc31b239fd508ce4f4b4
+  data.tar.gz: 8a01d3a0fbada194c797f3b8f7f630853d6c964b7c5c05fbfdf7e51565fa9895
+SHA512:
+  metadata.gz: e7774ec272fbf8cef3887bd3da36cc6f482dee216974996d69f9a2794e3a4a5622a4e8ef0375980073593dcc96f7f6ca0a290db91f43716ed8c6e15f1690f7e6
+  data.tar.gz: d375e06d6174bf417d4938b4136f33d5cacac67ab6c785a6bbf346f1c19b72f24fbeda611ebc7fa101116c662e4fdb812a7332759b765bbebf64dd806e557527

data/README.adoc

@@ -0,0 +1,91 @@
+:toc:
+:toc-placement!:
+
+= MMI
+
+MMI is some Ruby code that should make downloading and installing modloaders, mods, resource packs and other files for Minecraft easier.
+Configuring the downloads/installs is done by reading a YAML file.
+
+Ideally, a user would not need to know or write any YAML to create a configuration file.
+This is still work in progress.
+
+The application is currently CLI-only, but should work on Linux, MacOS and Windows.
+
+toc::[]
+
+= Installation
+
+== Prerequisites
+
+To run the application, Ruby version 2.5+ has to be installed.
+For maximum compatibility, use version 3.0+.
+
+== Steps
+
+Clone the repository and navigate into its root directory.
+
+[source,bash]
+----
+$ git clone https://github.com/expeehaa/mmi.git
+# or
+$ hg clone https://github.com/expeehaa/mmi.git
+
+$ cd mmi
+----
+
+Install gem dependencies.
+
+[source,bash]
+----
+$ bundle install
+----
+
+If you get an error that the lockfile requires `bundler` version 2.0+, install it first.
+
+[source,bash]
+----
+$ gem install bundler
+----
+
+= Basic usage
+
+In the repository root directory, run `exe/mmi`.
+
+[source,text]
+----
+Syntax: exe/mmi <config file> [action=install]
+
+	where action is one of
+		install  - Install the modloader and assets as specified in the config file.
+		validate - Validate the config file.
+		update   - Update the config file interactively.
+----
+
+The script currently does not support any arguments besides the ones listed above.
+Trying to get help by running `exe/mmi --help` or similar will not work.
+
+= Example configs
+
+Example configuration files can be found in `examples/`.
+They are completely working and download and install files into `tmp/` so that your `.minecraft` folder will stay unharmed.
+
+
+= TODOs
+
+* Improve argument parsing.
+* Write tests.
+* Add command to interactively create a config file.
+* Be able to update/change modloader interactively.
+* Be able to remove assets interactively.
+* Think about advising everyone to use another file extension than `.yaml` (e.g. `.mmi`, `.mmiconf`).
+* Try to make a Java-executable `.jar` file using `warbler` and `JRuby`.
+
+= Contributing
+
+Contributions are very welcome.
+If you intend to create a pull request, please choose a branch name describing its changes (i.e. not some generic term like `master` or `fix`, but e.g. `fix_typo` or `add_interactive_update_command`).
+
+Please be aware that I have a very specific code style and am interested in keeping it in this repository.
+Some basic rules are specified in the `.editorconfig` file, which your editor should support.
+Other code style rules may have to be exactly specified in the future.
+When in doubt, take a look at the existing code.

data/exe/mmi

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'psych'
+
+require 'mmi'
+require 'mmi/interactive'
+
+CLI::UI::StdoutRouter.enable
+
+def processor(file)
+	content = Psych.load_file(file)
+	
+	begin
+		Mmi::ModFileProcessor.new(content)
+	rescue Mmi::ValidationError => e
+		puts e
+		Kernel.exit 1
+	end
+end
+
+if ARGV.length>0
+	file         = ARGV.shift
+	action_param = ARGV.shift
+	action       = action_param.nil? ? :install : action_param.to_sym
+	
+	case action
+	when :install
+		processor(file).install
+	when :validate
+		processor(file)
+		
+		puts 'File is valid.'
+	when :update
+		Mmi::Interactive.update(processor(file), file)
+	else
+		STDERR.puts "Unknown action: #{action_param.inspect}."
+		Kernel.exit 1
+	end
+else
+	puts 'No file given.'
+	Kernel.exit 1
+end

data/lib/mmi.rb

@@ -0,0 +1,44 @@
+require 'semver'
+require 'open-uri'
+require 'fileutils'
+require 'digest'
+require 'github_api'
+
+require 'mmi/version'
+require 'mmi/mod_file_processor'
+
+module Mmi
+	MMI_CACHE_DIR = File.join(Dir.home, '.cache', 'mmi')
+	MINECRAFT_DIR = File.join(Dir.home, '.minecraft')
+	
+	def self.cache_dir
+		MMI_CACHE_DIR
+	end
+	
+	def self.minecraft_dir
+		MINECRAFT_DIR
+	end
+	
+	class ValidationError < StandardError; end
+	class MissingAttributeError < ValidationError; end
+	class InvalidAttributeError < ValidationError; end
+	
+	def self.debug(text)
+		if ENV['MMI_ENV']=='dev'
+			puts text
+		end
+	end
+	
+	def self.info(text)
+		puts text
+	end
+	
+	def self.warn(text)
+		puts text
+	end
+	
+	def self.fail!(text)
+		STDERR.puts text
+		Kernel.exit 1
+	end
+end

data/lib/mmi/assets_processor.rb

@@ -0,0 +1,41 @@
+require 'mmi/source/github'
+
+module Mmi
+	class AssetsProcessor
+		attr_reader :profile_dir
+		attr_reader :assets
+		
+		def initialize(profile_dir, assets)
+			@profile_dir = profile_dir
+			
+			assets ||= []
+			
+			if assets.is_a?(Array)
+				@assets = assets.map.with_index do |asset, index|
+					source = asset['source']
+					
+					if source
+						type = source['type']
+						
+						case type
+						when 'github'
+							Source::Github.new(source)
+						else
+							raise Mmi::InvalidAttributeError, %Q{Invalid "source.type" in asset #{index.inspect}: #{type.inspect}}
+						end
+					else
+						raise Mmi::MissingAttributeError, %Q{Missing "source" in asset #{index.inspect}.}
+					end
+				end
+			else
+				raise Mmi::InvalidAttributeError, %Q{Invalid "assets": expected Array or nothing, got #{self.assets.inspect}.}
+			end
+		end
+		
+		def install
+			assets.each do |asset|
+				asset.install(self.profile_dir)
+			end
+		end
+	end
+end

data/lib/mmi/interactive.rb

@@ -0,0 +1,13 @@
+require 'cli/ui'
+require 'mmi'
+require 'mmi/interactive/updater'
+
+module Mmi
+	module Interactive
+		class << self;
+			def update(file_path, processor)
+				Updater.new(file_path, processor).run!
+			end
+		end
+	end
+end

data/lib/mmi/interactive/updater.rb

@@ -0,0 +1,168 @@
+module Mmi
+	module Interactive
+		class Updater
+			attr_accessor :processor
+			attr_accessor :file_path
+			
+			def initialize(processor, file_path=nil)
+				self.processor = processor
+				self.file_path = file_path
+			end
+			
+			def run!
+				while true
+					to_update = CLI::UI::Prompt.ask('What do you want to update?') do |handler|
+						[
+							['assets'                , :assets      ],
+							['quit & save changes'   , :quit_save   ],
+							['quit & discard changes', :quit_discard],
+						].each do |name, result|
+							handler.option(name) do |s|
+								result
+							end
+						end
+					end
+					
+					case to_update
+					when :assets
+						update_assets
+					when :quit_save
+						file_path = CLI::UI::Prompt.ask('Filename', default: self.file_path, is_file: true)
+						yaml      = self.processor.content.to_yaml
+						
+						File.write(File.expand_path(file_path, Dir.pwd), yaml)
+						break
+					when :quit_discard
+						break
+					else
+						raise 'Consider yourself lucky, you found a bug.'
+					end
+				end
+			end
+			
+			def update_assets
+				while true
+					assets = processor.assets.assets
+					
+					choice = CLI::UI::Prompt.ask('Which asset do you want to change?') do |handler|
+						assets.each do |asset|
+							handler.option(asset.display_name) do |s|
+								asset
+							end
+						end
+						
+						handler.option('add' , &:to_sym)
+						handler.option('quit', &:to_sym)
+					end
+					
+					case choice
+					when :quit
+						break
+					when :add
+						add_asset
+					else
+						update_asset(choice)
+					end
+				end
+			end
+			
+			def add_asset
+				source_type = CLI::UI::Prompt.ask('Choose a source type.') do |handler|
+					[
+						'github',
+					].each do |type|
+						handler.option(type, &:to_sym)
+					end
+					
+					handler.option('quit', &:to_sym)
+				end
+				
+				case source_type
+				when :quit
+					false
+				when :github
+					options = {
+						'source' => {
+							'type'     => 'github',
+							'asset_id' => 0,
+						}
+					}
+					
+					options['source']['owner'      ] = CLI::UI::Prompt.ask('Who is the owner of the source repository?').strip
+					options['source']['repo'       ] = CLI::UI::Prompt.ask('What is the name of the source repository?').strip
+					options['source']['install_dir'] = CLI::UI::Prompt.ask('In which directory should the asset be placed?', default: 'mods').strip
+					options['source']['filename'   ] = CLI::UI::Prompt.ask('Under which filename should the asset be saved? (leave empty for release asset name)', allow_empty: true).strip.then do |filename|
+						filename == '' ? nil : filename
+					end
+					
+					options['source'].compact!
+					
+					source = Mmi::Source::Github.new(options['source'])
+					
+					if update_asset(source)
+						self.processor.content['assets'] ||= []
+						
+						self.processor.content['assets'].push(options)
+						self.processor.assets.assets.push(source)
+						
+						true
+					else
+						CLI::UI.puts('Aborting asset addition. No change will be made.', color: CLI::UI::Color::RED)
+						
+						false
+					end
+				end
+			end
+			
+			def update_asset(asset)
+				case asset
+				when Mmi::Source::Github
+					releases = ::Github::Client::Repos::Releases.new.list(owner: asset.owner, repo: asset.repo, per_page: 100)
+					
+					release = CLI::UI::Prompt.ask('Choose a release.') do |handler|
+						releases.select do |release|
+							release.assets.any?
+						end.each do |release|
+							handler.option(release.name) do |s|
+								release
+							end
+						end
+						
+						handler.option('quit', &:to_sym)
+					end
+					
+					case release
+					when :quit
+						false
+					else
+						release_asset = CLI::UI::Prompt.ask('Choose an asset.') do |handler|
+							release.assets.each do |a|
+								handler.option(a.name) do |s|
+									a
+								end
+							end
+							
+							handler.option('quit', &:to_sym)
+						end
+						
+						case release_asset
+						when :quit
+							false
+						else
+							asset.options.delete('release')
+							asset.options.delete('file'   )
+							
+							asset.options['asset_id'] = release_asset.id
+							
+							true
+						end
+					end
+				else
+					CLI::UI.puts('This asset cannot be updated.', color: CLI::UI::Color::RED)
+					
+					false
+				end
+			end
+		end
+	end
+end

data/lib/mmi/mod_file_processor.rb

@@ -0,0 +1,58 @@
+require 'mmi/modloader/none'
+require 'mmi/modloader/fabric'
+require 'mmi/assets_processor'
+
+module Mmi
+	class ModFileProcessor
+		attr_reader :content
+		
+		attr_reader :version
+		attr_reader :profile_dir
+		
+		attr_reader :modloader
+		attr_reader :assets
+		
+		def initialize(content)
+			@content = content
+			
+			@version     = content['version'    ]
+			@profile_dir = content['profile_dir'] || Mmi.minecraft_dir
+			
+			version     = SemVer.parse(self.version)
+			lib_version = SemVer.parse(Mmi::VERSION)
+			
+			if self.version
+				if version.major <= lib_version.major
+					if version.minor > lib_version.minor
+						Mmi.warn %Q{Config file specified "version" #{version}, but MMI is at #{lib_version}. Some features might not be supported.}
+					end
+					
+					ml         = content['modloader']
+					@modloader = if ml
+						case ml['name']
+						when 'none'
+							Modloader::None.new(ml)
+						when 'fabric'
+							Modloader::Fabric.new(ml)
+						else
+							raise Mmi::InvalidAttributeError, %Q{Unkown modloader #{ml['name'].inspect}.}
+						end
+					else
+						Modloader::None.new
+					end
+					
+					@assets = AssetsProcessor.new(self.profile_dir, content['assets'])
+				else
+					raise Mmi::InvalidAttributeError, %Q{Config file specified "version" #{version}, but MMI is at #{lib_version}.}
+				end
+			else
+				raise Mmi::MissingAttributeError, 'Missing "version".'
+			end
+		end
+		
+		def install
+			self.modloader.install
+			self.assets.install
+		end
+	end
+end

data/lib/mmi/modloader/fabric.rb

@@ -0,0 +1,98 @@
+module Mmi
+	module Modloader
+		class Fabric
+			attr_reader :options
+			
+			attr_reader :version
+			attr_reader :install_type
+			attr_reader :mcversion
+			attr_reader :install_dir
+			
+			def initialize(options)
+				@options = options
+				
+				@version      = options['version'          ]
+				@install_type = options['install_type'     ]
+				@mcversion    = options['minecraft_version']
+				@install_dir  = options['install_dir'      ] || Mmi.minecraft_dir
+				
+				if self.version
+					if self.install_type
+						if ['client', 'server'].include?(self.install_type)
+							if self.mcversion
+								# Pass.
+							else
+								raise Mmi::MissingAttributeError, 'Missing "modloader.minecraft_version".'
+							end
+						else
+							raise Mmi::InvalidAttributeError, %Q{Invalid "modloader.install_type". Expecting "client" or "server", got #{self.install_type.inspect}.}
+						end
+					else
+						raise Mmi::MissingAttributeError, 'Missing "modloader.install_type".'
+					end
+				else
+					raise Mmi::MissingAttributeError, 'Missing "modloader.version".'
+				end
+			end
+			
+			def installer_uri
+				"https://maven.fabricmc.net/net/fabricmc/fabric-installer/#{self.version}/fabric-installer-#{self.version}.jar"
+			end
+			
+			def installer_sha512sum_uri
+				"#{installer_uri}.sha512"
+			end
+			
+			def installer_path
+				File.join(Mmi.cache_dir, "fabric-installer-#{self.version}.jar")
+			end
+			
+			def absolute_install_dir
+				File.expand_path(self.install_dir)
+			end
+			
+			def download_installer
+				Mmi.info "Downloading fabric-installer version #{self.version.inspect}."
+				
+				begin
+					FileUtils.mkdir_p(Mmi.cache_dir)
+					
+					expected_hexdigest = URI.open(installer_sha512sum_uri).read
+					
+					if !File.exists?(installer_path) || expected_hexdigest != Digest::SHA512.hexdigest(File.read(installer_path))
+						stream = URI.open(installer_uri)
+						
+						IO.copy_stream(stream, installer_path)
+						
+						actual_hexdigest = Digest::SHA512.hexdigest(File.read(installer_path))
+						
+						if expected_hexdigest == actual_hexdigest
+							# Pass.
+						else
+							Mmi.fail! "Expected fabric installer to have SHA512 sum #{expected_hexdigest.inspect} but received #{actual_hexdigest.inspect}."
+						end
+					else
+						Mmi.info 'Using cached fabric-installer.'
+					end
+				rescue OpenURI::HTTPError => e
+					Mmi.fail! %Q{Error when requesting fabric installer. Maybe "modloader.version" == #{version.inspect} is invalid.\n#{e.inspect}}
+				end
+			end
+			
+			def run_installer
+				FileUtils.mkdir_p(absolute_install_dir)
+				
+				if system('java', '-jar', installer_path, 'client', '-dir', absolute_install_dir, '-noprofile', '-mcversion', self.mcversion)
+					# Pass.
+				else
+					Mmi.fail! 'Failed to install Fabric modloader.'
+				end
+			end
+			
+			def install
+				download_installer
+				run_installer
+			end
+		end
+	end
+end

data/lib/mmi/modloader/none.rb

@@ -0,0 +1,11 @@
+module Mmi
+	module Modloader
+		class None
+			def initialize(options=nil)
+			end
+			
+			def install
+			end
+		end
+	end
+end

data/lib/mmi/source/github.rb

@@ -0,0 +1,91 @@
+module Mmi
+	module Source
+		class Github
+			attr_reader :options
+			
+			attr_reader :owner
+			attr_reader :repo
+			attr_reader :install_dir
+			attr_reader :filename
+			
+			attr_reader :asset_id
+			attr_reader :release
+			attr_reader :file
+			
+			def initialize(options)
+				@options = options
+				
+				@owner       = options['owner'      ]
+				@repo        = options['repo'       ]
+				@asset_id    = options['asset_id'   ]
+				@release     = options['release'    ]
+				@file        = options['file'       ]
+				@install_dir = options['install_dir']
+				@filename    = options['filename'   ]
+				
+				if self.owner
+					if self.repo
+						if self.install_dir
+							if self.asset_id
+								# Pass.
+							else
+								if self.release
+									if self.file
+										# Pass.
+									else
+										raise Mmi::MissingAttributeError, 'Missing "source.file" from asset because "source.asset_id" is not provided.'
+									end
+								else
+									raise Mmi::MissingAttributeError, 'Missing "source.release" from asset because "source.asset_id" is not provided.'
+								end
+							end
+						else
+							raise Mmi::MissingAttributeError, 'Missing "source.install_dir" from asset.'
+						end
+					else
+						raise Mmi::MissingAttributeError, 'Missing "source.repo" from asset.'
+					end
+				else
+					raise Mmi::MissingAttributeError, 'Missing "source.owner" from asset.'
+				end
+			end
+			
+			def repository_url
+				"https://github.com/#{self.owner}/#{self.repo}"
+			end
+			
+			def cached_asset_response
+				@asset_get ||= ::Github::Client::Repos::Releases::Assets.new.get(owner: self.owner, repo: self.repo, id: self.asset_id)
+			end
+			
+			def download_url
+				if self.asset_id
+					cached_asset_response.browser_download_url
+				else
+					"#{repository_url}/releases/download/#{release}/#{file}"
+				end
+			end
+			
+			def install(dir)
+				install_dir = File.expand_path(self.install_dir, dir)
+				filepath    = File.join(install_dir, self.filename || (self.asset_id ? cached_asset_response.name : self.file))
+				
+				Mmi.info "Downloading #{download_url.inspect} into #{filepath.inspect}."
+				
+				FileUtils.mkdir_p(install_dir)
+				
+				begin
+					stream = URI.open(download_url)
+					
+					IO.copy_stream(stream, filepath)
+				rescue OpenURI::HTTPError => e
+					Mmi.fail! %Q{Error when requesting asset.\n#{e.inspect}}
+				end
+			end
+			
+			def display_name
+				repository_url
+			end
+		end
+	end
+end

data/lib/mmi/version.rb

@@ -0,0 +1,3 @@
+module Mmi
+	VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: mmi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- expeehaa
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: semver2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: github_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: cli-ui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description:
+email:
+- expeehaa@outlook.com
+executables:
+- mmi
+extensions: []
+extra_rdoc_files: []
+files:
+- README.adoc
+- exe/mmi
+- lib/mmi.rb
+- lib/mmi/assets_processor.rb
+- lib/mmi/interactive.rb
+- lib/mmi/interactive/updater.rb
+- lib/mmi/mod_file_processor.rb
+- lib/mmi/modloader/fabric.rb
+- lib/mmi/modloader/none.rb
+- lib/mmi/source/github.rb
+- lib/mmi/version.rb
+homepage: https://github.com/expeehaa/mmi
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Program to install minecraft modloaders, mods and other assets through a
+  single config file.
+test_files: []