Module: Factorix

Extended by:: Dry::Configurable

Defined in:: lib/factorix.rb,
lib/factorix/api.rb,
lib/factorix/cli.rb,
lib/factorix/mod.rb,
lib/factorix/errors.rb,
lib/factorix/portal.rb,
lib/factorix/api/tag.rb,
lib/factorix/runtime.rb,
lib/factorix/version.rb,
lib/factorix/cache/s3.rb,
lib/factorix/mod_list.rb,
lib/factorix/api/image.rb,
lib/factorix/blueprint.rb,
lib/factorix/changelog.rb,
lib/factorix/container.rb,
lib/factorix/info_json.rb,
lib/factorix/mod_state.rb,
lib/factorix/save_file.rb,
lib/factorix/cache/base.rb,
lib/factorix/formatting.rb,
lib/factorix/api/license.rb,
lib/factorix/api/release.rb,
lib/factorix/cache/entry.rb,
lib/factorix/cache/redis.rb,
lib/factorix/http/client.rb,
lib/factorix/mod_version.rb,
lib/factorix/runtime/wsl.rb,
lib/factorix/api/category.rb,
lib/factorix/api/mod_info.rb,
lib/factorix/game_version.rb,
lib/factorix/mod_settings.rb,
lib/factorix/runtime/base.rb,
lib/factorix/http/response.rb,
lib/factorix/installed_mod.rb,
lib/factorix/runtime/linux.rb,
lib/factorix/api_credential.rb,
lib/factorix/runtime/mac_os.rb,
lib/factorix/dependency/edge.rb,
lib/factorix/dependency/list.rb,
lib/factorix/dependency/node.rb,
lib/factorix/runtime/windows.rb,
lib/factorix/cli/commands/man.rb,
lib/factorix/dependency/entry.rb,
lib/factorix/dependency/graph.rb,
lib/factorix/cache/file_system.rb,
lib/factorix/cli/commands/base.rb,
lib/factorix/cli/commands/path.rb,
lib/factorix/dependency/parser.rb,
lib/factorix/transfer/uploader.rb,
lib/factorix/api/mod_portal_api.rb,
lib/factorix/progress/presenter.rb,
lib/factorix/ser_des/serializer.rb,
lib/factorix/service_credential.rb,
lib/factorix/cli/commands/launch.rb,
lib/factorix/http/retry_strategy.rb,
lib/factorix/transfer/downloader.rb,
lib/factorix/api/mod_download_api.rb,
lib/factorix/cli/commands/version.rb,
lib/factorix/dependency/validator.rb,
lib/factorix/http/cache_decorator.rb,
lib/factorix/http/cached_response.rb,
lib/factorix/http/retry_decorator.rb,
lib/factorix/ser_des/deserializer.rb,
lib/factorix/api/game_download_api.rb,
lib/factorix/cli/commands/download.rb,
lib/factorix/cli/commands/mod/edit.rb,
lib/factorix/cli/commands/mod/list.rb,
lib/factorix/cli/commands/mod/show.rb,
lib/factorix/cli/commands/mod/sync.rb,
lib/factorix/progress/scan_handler.rb,
lib/factorix/api/mod_management_api.rb,
lib/factorix/cli/commands/mod/check.rb,
lib/factorix/ser_des/signed_integer.rb,
lib/factorix/cli/commands/cache/stat.rb,
lib/factorix/cli/commands/completion.rb,
lib/factorix/cli/commands/mod/enable.rb,
lib/factorix/cli/commands/mod/search.rb,
lib/factorix/cli/commands/mod/update.rb,
lib/factorix/cli/commands/mod/upload.rb,
lib/factorix/progress/upload_handler.rb,
lib/factorix/cli/commands/cache/evict.rb,
lib/factorix/cli/commands/confirmable.rb,
lib/factorix/cli/commands/mod/disable.rb,
lib/factorix/cli/commands/mod/install.rb,
lib/factorix/dependency/graph/builder.rb,
lib/factorix/progress/multi_presenter.rb,
lib/factorix/ser_des/unsigned_integer.rb,
lib/factorix/cli/commands/mod/download.rb,
lib/factorix/progress/download_handler.rb,
lib/factorix/runtime/user_configurable.rb,
lib/factorix/cli/commands/mod/image/add.rb,
lib/factorix/cli/commands/mod/uninstall.rb,
lib/factorix/progress/presenter_adapter.rb,
lib/factorix/cli/commands/backup_support.rb,
lib/factorix/cli/commands/mod/image/edit.rb,
lib/factorix/cli/commands/mod/image/list.rb,
lib/factorix/cli/commands/portal_support.rb,
lib/factorix/cli/commands/command_wrapper.rb,
lib/factorix/dependency/validation_result.rb,
lib/factorix/cli/commands/blueprint/decode.rb,
lib/factorix/cli/commands/blueprint/encode.rb,
lib/factorix/cli/commands/download_support.rb,
lib/factorix/cli/commands/mod/changelog/add.rb,
lib/factorix/cli/commands/mod/settings/dump.rb,
lib/factorix/cli/commands/mod/changelog/check.rb,
lib/factorix/cli/commands/mod/settings/restore.rb,
lib/factorix/cli/commands/mod/changelog/extract.rb,
lib/factorix/cli/commands/mod/changelog/release.rb,
lib/factorix/cli/commands/requires_game_stopped.rb,
lib/factorix/dependency/mod_version_requirement.rb

Overview

Factorix provides a CLI for Factorio MOD management, settings synchronization, and MOD Portal integration.

Examples:

Configure Factorix

Factorix.configure do |config|
  config.log_level = :debug
  config.http.connect_timeout = 10
end

Defined Under Namespace

Modules: API, Cache, Dependency, Formatting, HTTP, Progress, SerDes, Transfer Classes: APICredential, BinaryFormatError, Blueprint, BlueprintFormatError, BundledMODError, CLI, Changelog, ChangelogParseError, CircularDependencyError, CommandNotFoundError, ConfigurationError, Container, CredentialError, DependencyError, DependencyGraphError, DependencyMissingError, DependencyParseError, DependencyVersionError, DependencyViolationError, DigestMismatchError, DirectoryNotFoundError, DomainError, Error, ExtraDataError, FileFormatError, GameRunningError, GameVersion, HTTPClientError, HTTPError, HTTPNotFoundError, HTTPServerError, InfoJSON, InfrastructureError, InstalledMOD, InvalidArgumentError, InvalidLengthError, InvalidOperationError, LockTimeoutError, MOD, MODConflictError, MODList, MODNotFoundError, MODNotOnPortalError, MODSectionNotFoundError, MODSettings, MODSettingsError, MODState, MODVersion, PlatformError, Portal, Runtime, SaveFile, ServiceCredential, ShellError, URLError, UnknownPropertyType, UnsupportedBlueprintVersionError, UnsupportedPlatformError, ValidationError, VersionParseError

Constant Summary collapse

Import =

Dry::AutoInject(Container)

VERSION =

"0.12.0"

Class Method Summary collapse

.load_config(path = nil) ⇒ void

Load configuration from file.

Class Method Details

.load_config(path = nil) ⇒ `void`

This method returns an undefined value.

Load configuration from file

Parameters:

path (Pathname, nil) (defaults to: nil) —

configuration file path

Raises:

(ConfigurationError) —

if explicitly specified path does not exist

# File 'lib/factorix.rb', line 105

def self.load_config(path=nil)
  if path
    # Explicitly specified path must exist
    raise ConfigurationError, "Configuration file not found: #{path}" unless path.exist?

    config_path = path
  else
    # Default path is optional
    config_path = Container.resolve(:runtime).factorix_config_path
    return unless config_path.exist?
  end

  instance_eval(config_path.read, config_path.to_s)
end