silkedit 0.1.10

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/silkedit

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+################
+### Silkedit ###
+################
+
+require 'rbcli'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'silkedit')
+Dir[File.join(File.dirname(__FILE__), '..', 'lib', 'config', '*.rb')].each { |file| require file }
+Dir[File.join(File.dirname(__FILE__), '..', 'lib', 'commands', '*.rb')].each { |file| require file }
+
+Rbcli.go!

data/lib/commands/backup_restore.rb

@@ -0,0 +1,25 @@
+Rbcli.command 'backup' do
+  description 'Backs up the savefile'
+  parameter :custom_name, 'Give the backup a custom name. Named backups can\'t be edited.', short: :n, type: :string
+  action do |opts, params, args, config, env|
+    s = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+    s.direct_backup(backup_name: params[:custom_name])
+  end
+end
+
+Rbcli.command 'restore' do
+  description 'Restore a backup to the savefile. Providing no parameters restores the latest backup.'
+  parameter :backup_seq, 'Backup number to restore (Can\'t use together with named backup)', short: :b, type: :integer
+  parameter :backup_name, 'Named backup to restore', short: :n, type: :string
+
+  action do |opts, params, args, config, env|
+    if !params[:backup_seq].nil? && !params[:backup_name].nil?
+      Rbcli.log.error 'Can\'t specify both a sequence and name at the same time.'
+    else
+      s = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+      unless s.direct_restore(seq_number: params[:backup_seq], backup_name: params[:backup_name])
+        Rbcli.log.error "Failed to restore backup"
+      end
+    end
+  end
+end

data/lib/commands/cheat.rb

@@ -0,0 +1,74 @@
+Rbcli.command 'cheat' do
+  description 'Applies one or more cheats to the selected savefile'
+  usage '<cheat1> <cheat2> <cheat3>...'
+  parameter :list, 'List all cheats', type: :bool, default: false
+  # parameter :force, "Force application of a cheat even when requirements aren't met. Additional changes may be made to your savegave.", type: :bool, default: false
+  action do |opts, params, args, config, env|
+    s = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+    s.load_from_dat
+    c = Silkedit::Cheat::Engine.new(s.data)
+
+    display_simple_list = lambda do |list, cols|
+      max_length = list.map(&:length).max
+      display_set = []
+      rows = (list.length / cols.to_f).ceil
+      row_idx = 0
+      max_rows = rows - 1
+      list.length.times do |i|
+        display_set[row_idx] ||= []
+        display_set[row_idx] << list[i]
+        row_idx += 1
+        row_idx = 0 if row_idx > max_rows
+      end
+      display_set.map { |row| row.map { |z| z.ljust(max_length) }.join('   ') }.join("\n")
+    end
+
+    if args.empty? || params[:list]
+      Rbcli.log.info 'Cheats:'
+      Rbcli.log.info display_simple_list.call(c.list_cheats, 5)
+      Rbcli.exit(0)
+    end
+
+    changes = args.map do |cht|
+      cht = cht.downcase
+      status = c.apply_cheat(cht)
+      case status
+      when :no_cheat
+        Rbcli.log.warn "Could not apply cheat #{cht}: Cheat does not exist"
+        Rbcli.log.info 'Did you mean one of these?'
+        possible_cheats = c.list_cheats.select { |cheat| cheat.include?(cht) }
+        Rbcli.log.info display_simple_list.call(possible_cheats, 5)
+        nil
+      when :failed_act_check
+        Rbcli.log.warn "Could not apply cheat #{cht.colorize(:red)}: The player is in the wrong act. Use --(f)orce to override."
+        nil
+      when :failed_soft_reqs
+        Rbcli.log.warn "Could not apply cheat #{cht.colorize(:red)}: Soft requirements not met. Use --(f)orce to apply the required changes."
+        nil
+      when :failed_hard_reqs
+        Rbcli.log.error "Could not apply cheat #{cht.colorize(:red)}: Hard requirements not met. Applying the cheat would cause in-game errors."
+        nil
+      when :success
+        Rbcli.log.info "    Success!".colorize(:green)
+        cht
+      else
+        raise "Unknown status: #{status}"
+      end
+    end
+
+    if changes.empty?
+      Rbcli.log.info ''
+      Rbcli.log.info 'No cheats applied'
+      Rbcli.exit(0)
+    end
+
+    if changes.include?(nil)
+      Rbcli.log.info ''
+      Rbcli.log.info 'Some cheats failed to apply. Discarding changes.'
+      Rbcli.exit(0)
+    end
+
+    s.direct_backup
+    s.save_to_dat
+  end
+end

data/lib/commands/edit_diff.rb

@@ -0,0 +1,47 @@
+Rbcli.command 'edit' do
+  description 'Edit the savefile directly'
+  action do |opts, params, args, config, env|
+    s = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+    s.load_from_dat
+    s.save_to_json
+    Process.wait(Process.spawn(config[:editor_command].sub('%FILE%', s.filenames[:json])))
+    if Silkedit::Sys.yes_no?('Apply changes?')
+      s.load_from_json
+      s.direct_backup
+      s.save_to_dat
+      Rbcli.log.info 'Updated savefile'
+    else
+      Rbcli.log.info 'Aborted'
+    end
+  end
+end
+
+Rbcli.command 'diff' do
+  description 'Diffs the current savegame against the latest backup, a specified backup, or a different save'
+  parameter :backup_seq, 'Backup number to diff against', short: :b, type: :integer
+  parameter :othersave, 'Other save number to diff against', short: :o, type: :integer
+  parameter :yaml_output, 'Output in YAML instead of a Ruby object', short: :y, type: :boolean
+
+
+  action do |opts, params, args, config, env|
+    new = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+    new.load_from_dat
+    if params[:othersave]
+      old = Silkedit::Savegame::SaveFile.new(:silksong, params[:othersave])
+      old.load_from_dat
+    else
+      old = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+      old.load_from_backup(seq_number: params[:backup_seq])
+    end
+
+    diff = Silkedit::Savegame::Diff.mkdiff(old.data, new.data)
+    Rbcli.log.info Silkedit::Savegame::Diff.parse_diff(diff, yaml_output: params[:yaml_output])
+
+    # s.save_as_json
+    # FileUtils.mv(s.json_filename, "#{s.json_filename}.old")
+    # s.load_from_dat
+    # s.save_as_json
+    # FileUtils.mv(s.json_filename, "#{s.json_filename}.new")
+    # Process.wait(Process.spawn(config[:diff_command].sub('%OLD%', "#{s.json_filename}.old").sub('%NEW%', "#{s.json_filename}.new")))
+  end
+end

data/lib/commands/examples/command.rb

@@ -0,0 +1,51 @@
+Rbcli.command "example" do
+  ##### Command Declaration (At least one is required) #####
+  # default     (Optional) The default command is run when no other commands are called on the CLI
+  #               Note that parameters are not available for default commands, as all CLI options
+  #               are parsed against the global-level ones declared in the `Configurate.opts` block
+  # description (Optional) Short description that shows up in --help for the executable
+  # usage       (Optional) Usage text that shows up in --help or when CLI format is bad
+  # helptext    (Optional) Large help text that shows up in --help for the command
+  # default
+  description 'Example command'
+  usage "[--param|--otherparam] name"
+  helptext <<~EOF
+    Big block of helptext
+  EOF
+  # parameter (Optinoal) Parameters follow the same format as CLI Options, but are only available for this command
+  parameter :param, 'A Parameter', default: false
+  parameter :otherparam, 'Another Parameter', type: :string, default: "Default value"
+  # action    (Required, unless declaring a `script`) The action block is code that gets executed when the command is called
+  #             Sending all output through the logger is recommended. For it to be displayed
+  #             as regular text, set the logger to the :display format
+  action do |opts, params, args, config, env|
+    Rbcli.log.info "Welcome to your new application!"
+    Rbcli.log.info "We like to send all of our output through the logger for easy formatting and deployment..."
+    puts "...but you don't have to"
+    Rbcli.log.info "Here's a quick demo of how to use the framework:\n"
+
+    Rbcli.log.info "Top-level CLI Options: " + opts.to_s
+    Rbcli.log.info "Parameters:            " + params.to_s
+    Rbcli.log.info "Arguments on the CLI:  " + args.to_s
+    Rbcli.log.info "The config:            " + config.to_s
+    Rbcli.log.info "Environment variables: " + env.to_s
+    Rbcli.log.info ""
+
+    Rbcli.log.debug "Example Debug Message (change your log level to see this!)", "MYAPP"
+    Rbcli.log.info "Example Info Message", "MYAPP"
+    Rbcli.log.warn "Example Warning Message", "MYAPP"
+    Rbcli.log.error "Example Error Message", "MYAPP"
+    Rbcli.log.fatal "Example Fatal Message", "MYAPP"
+    Rbcli.log.unknown "Example Unknown Message", "MYAPP"
+    Rbcli.log.info ""
+
+    config.add_default :foo, 'bar'
+    config.create!
+    config.load!
+    config[:davey] = 'Davey Jones'.compress
+    Rbcli.log.info "Compressed String: " + config[:davey]
+    Rbcli.log.info "Decompressed String: " + config[:davey].decompress
+    config.save!
+    Rbcli.log.info config
+  end
+end

data/lib/commands/examples/script.rb

@@ -0,0 +1,36 @@
+# Script Command
+# Supports all of the same features as a regular command, but passes everything to a bash script
+# The script can be defined inline, or a path to an external script can be provided
+#
+# Code is injected into the script to integrate with Rbcli.
+#   The `log` commands are integrated with the ruby logger
+#   The `rbcli` command provides a wrapper around jq that can retrieve
+#     the values of opts/params/args/config/env
+#   For more information on JQ syntax, see: https://jqlang.github.io/jq/
+Rbcli.command "script" do
+  description "example script command"
+  # external_script vars: {}, path: "./test.sh"
+  inline_script vars: { foo: 'bar!!!' }, inline: <<~INLINE
+    #!/usr/bin/env bash
+    log "Rbcli shell integration demo!"
+    log "A custom JQ wrapper is used to parse config passed through from Rbcli"
+    log "For more information on how to use it, see: https://jqlang.github.io/jq/"
+    log ""
+
+    log "Top-level CLI Options: $(rbcli opts .)"
+    log "Parameters: $(rbcli params .)"
+    log "Arguments on the CLI: $(rbcli args .)"
+    log "Config: $(rbcli config .)"
+    log "Environment Variables: $(rbcli env .)"
+    log "Custom Var from command: $(rbcli vars .foo)"
+    log "Same variable, in environment: ${FOO}"
+
+    log "Logs are integrated too"
+    log "Example Debug (you need to change your log level to see this)" "debug"
+    log "Example Info" "info"
+    log "Example Warning" "warn"
+    log "Example Error" "error"
+    log "Example Fatal" "fatal"
+    log "Example Unknown" "unknown"
+  INLINE
+end

data/lib/commands/journal.rb

@@ -0,0 +1,34 @@
+Rbcli.command 'journal' do
+  description 'Manages the journal of enemy kills'
+  usage '[listall|listmissing|complete|killsonly]'
+  parameter :showimages, 'Show images of the enemies', short: 'i', type: :bool, default: false
+  action do |opts, params, args, config, env|
+    command = args.first
+    if command.nil? || command.empty? || !%w[listall listmissing complete killsonly].include?(command)
+      Rbcli.log.error "Must specify an action as one of: listall, listmissing, complete, killsonly"
+      next
+    end
+
+    s = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+    s.load_from_dat
+    c = Silkedit::Cheat::Engine.new(s.data)
+
+    case command
+    when 'listall'
+      c.enemy_list(only_missing: false, show_images: params[:showimages])
+    when 'listmissing'
+      c.enemy_list(only_missing: true, show_images: params[:showimages])
+    when 'complete'
+      c.update_journal(should_update_kills_only: false)
+      s.direct_backup
+      s.save_to_dat
+    when 'killsonly'
+      c.update_journal(should_update_kills_only: true)
+      s.direct_backup
+      s.save_to_dat
+    else
+      Rbcli.fatal "Unknown command: #{command}", exit_status: 1
+    end
+
+  end
+end

data/lib/commands/permasave_permaload.rb

@@ -0,0 +1,62 @@
+Rbcli.command 'permasave' do
+  description 'Saves a local copy of a game into the config to restore later.'
+  parameter :name, 'Name to give the savegame', short: :n, type: :string, required: true
+  action do |opts, params, args, config, env|
+    permasave_file = config[:permasave_file_location][Silkedit::Sys.os]
+    permasave_file = permasave_file.gsub('%APPDATA%', ENV['APPDATA'] || ENV['LOCALAPPDATA']) if Silkedit::Sys.os == :windows
+    permasave_file = File.expand_path(permasave_file)
+    unless File.exist?(permasave_file)
+      FileUtils.cp(File.join(Silkedit::LIBDIR, 'config', 'silksong', 'permasaves.yaml'), permasave_file)
+    end
+    permasaves = YAML.safe_load_file(permasave_file)
+    Rbcli.log.fatal('Permasaves file is corrupt. Please delete or fix it and try again.', exit_status: 1) unless permasaves.is_a?(Hash)
+
+    params[:name] = params[:name].downcase
+    if permasaves.key?(params[:name])
+      Rbcli.log.warn "Found existing permasave: #{params[:name]}"
+      next unless Silkedit::Sys.yes_no?('Overwrite?')
+    end
+
+    s = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+    s.load_from_dat
+    permasaves[params[:name]] = YAML.safe_dump(s.data).compress
+    File.write(permasave_file, YAML.safe_dump(permasaves))
+
+    Rbcli.log.info "Permasave #{params[:name]} saved from slot #{opts[:savenum]}"
+  end
+end
+
+Rbcli.command 'permaload' do
+  description 'Restores a permasave into the slot'
+  parameter :name, 'Name of the permasave to load', short: :n, type: :string, required: false
+  parameter :list, 'List all permasaves', short: :l, type: :bool, default: false
+  action do |opts, params, args, config, env|
+    permasave_file = config[:permasave_file_location][Silkedit::Sys.os]
+    permasave_file = permasave_file.gsub('%APPDATA%', ENV['APPDATA'] || ENV['LOCALAPPDATA']) if Silkedit::Sys.os == :windows
+    permasave_file = File.expand_path(permasave_file)
+    unless File.exist?(permasave_file)
+      FileUtils.cp(File.join(Silkedit::LIBDIR, 'config', 'silksong', 'permasaves.yaml'), permasave_file)
+    end
+    permasaves = YAML.safe_load_file(permasave_file)
+    Rbcli.log.fatal('Permasaves file is corrupt. Please delete or fix it and try again.', exit_status: 1) unless permasaves.is_a?(Hash)
+
+    if !params[:name] && !params[:list]
+      Rbcli.log.warn 'Must provide a permasave name to load, or use --(l)ist to list all permasaves.'
+      next
+    elsif params[:list]
+      Rbcli.log.info permasaves.keys.join("\n")
+      next
+    end
+    params[:name] = params[:name].downcase
+
+    s = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+    if permasaves.is_a?(Hash) && permasaves.key?(params[:name])
+      s.data = YAML.safe_load(permasaves[params[:name]].decompress)
+      s.data['profileID'] = opts[:savenum].to_i
+      s.save_to_dat
+      Rbcli.log.info "Permasave #{params[:name]} loaded to slot #{opts[:savenum]}."
+    else
+      Rbcli.log.warn "Permasave #{params[:name]} does not exist. Exiting."
+    end
+  end
+end

data/lib/commands/unpack_repack.rb

@@ -0,0 +1,27 @@
+Rbcli.command 'unpack' do
+  description 'Unpacks a save file or backup to JSON/YAML for manual editing'
+  parameter :backup_seq, 'Sequence number for the backup to unpack', short: :b, type: :integer
+  action do |opts, params, args, config, env|
+    s = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+    if params[:backup_seq].nil?
+      s.load_from_dat
+      s.save_to_json
+      Rbcli.log.info 'Unpacked savefile to json/yaml'
+    else
+      s.load_from_backup(seq_number: params[:backup_seq])
+      s.save_to_json
+      Rbcli.log.info "Unpacked backup ##{params[:backup_seq]}"
+    end
+  end
+end
+
+Rbcli.command 'repack' do
+  description 'Packs the JSON/YAML to the savefile'
+  action do |opts, params, args, config, env|
+    s = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+    s.load_from_json
+    s.direct_backup
+    s.save_to_dat
+    Rbcli.log.info 'Repacked savefile from json/yaml'
+  end
+end

data/lib/commands/zone_mkzone.rb

@@ -0,0 +1,103 @@
+Rbcli.command 'zone' do
+  description 'Zones the character to a different respawn point'
+  usage '<zone> (--(f)orce)'
+  parameter :list, 'Display the full list of zones to select from', type: :bool, default: false
+  parameter :force, 'Force select a spawn point even when requirements are not met. Changes may be made to your savegave.', type: :bool, default: false
+  action do |opts, params, args, config, env|
+    s = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+    s.load_from_dat
+    c = Silkedit::Cheat::Engine.new(s.data)
+
+    display_simple_list = lambda do |list, cols|
+      max_length = list.map(&:length).max
+      display_set = []
+      rows = (list.length / cols.to_f).ceil
+      row_idx = 0
+      max_rows = rows - 1
+      list.length.times do |i|
+        display_set[row_idx] ||= []
+        display_set[row_idx] << list[i]
+        row_idx += 1
+        row_idx = 0 if row_idx > max_rows
+      end
+      display_set.map { |row| row.map { |z| z.ljust(max_length) }.join('   ') }.join("\n")
+    end
+
+    display_detailed_zone_list = lambda do |list|
+      max_shortcut_length = list.map { |zone| (zone[:shortcut] || '').length }.max
+      formatter = "%-#{max_shortcut_length}s %3s %s"
+      final_string = ''
+      final_string << format(formatter, 'Shortcut', 'Act', 'Zone') + "\n"
+      final_string << list.map { |zone| format(formatter, zone[:shortcut], zone[:min_act], zone[:slug]) }.join("\n")
+      final_string
+    end
+
+    if args.empty? || params[:list]
+      Rbcli.log.info 'Shortcuts:'
+      Rbcli.log.info display_simple_list.call(c.list_shortcuts.keys, 5)
+    end
+
+    if params[:list]
+      Rbcli.log.info ''
+      Rbcli.log.info 'Zones:'
+      Rbcli.log.info display_detailed_zone_list.call(c.list_zones)
+    end
+
+    Rbcli.exit(0) if args.empty? || params[:list]
+
+    status = c.zone_to(args.first, force_soft_reqs: params[:force], enforce_min_act: !params[:force])
+    case status
+    when :no_zone
+      Rbcli.log.warn "Could not zone to #{args.first}: Specified spawn point does not exist"
+      Rbcli.log.info 'Did you mean one of these?'
+      possible_zones = c.list_zones.select { |zone| zone[:slug].include?(args.first) || !zone[:shortcut].nil? && zone[:shortcut].include?(args.first) }
+      Rbcli.log.info display_detailed_zone_list.call(possible_zones, 5)
+    when :failed_act_check
+      Rbcli.log.warn "Could not zone to #{args.first.colorize(:red)}: The player is in the wrong act. Use --(f)orce to override."
+    when :failed_soft_reqs
+      Rbcli.log.warn "Could not zone to #{args.first.colorize(:red)}: Soft requirements not met. Use --(f)orce to apply the required changes."
+    when :failed_hard_reqs
+      Rbcli.log.error "Could not zone to #{args.first.colorize(:red)}: Hard requirements not met. Zoning here would cause in-game errors."
+    when :success
+      s.direct_backup
+      s.save_to_dat
+      Rbcli.log.info "Zoned to #{args.first.colorize(:green)}"
+    else
+      raise "Unknown status: #{status}"
+    end
+  end
+end
+
+Rbcli.command 'mkzone' do
+  description 'Adds a new spawn point to the library'
+  usage '<slug>'
+  parameter :slug, 'The slug of the zone to add', type: :string
+  parameter :act, 'Override default act detection', type: :integer
+  parameter :shortcut, 'Provide a shorter slug as a shortcut for the zone', short: 'o', type: :string
+  parameter :force, 'Force overwrite of existing zone', type: :bool, default: false
+  action do |opts, params, args, config, env|
+    if params[:slug].nil?
+      Rbcli.log.error 'Must provide a zone slug'
+      next
+    end
+
+    s = Silkedit::Savegame::SaveFile.new(:silksong, opts[:savenum])
+    s.load_from_dat
+    c = Silkedit::Cheat::Engine.new(s.data)
+
+    status = c.save_current_zone(params[:slug], params[:shortcut], params[:act], overwrite: params[:force])
+
+    case status
+    when :badname
+      Rbcli.log.error 'Invalid zone name. Zones must be formatted as: region.target'
+    when :badact
+      Rbcli.log.error 'Invalid act number. Act must be between 1 and 3, or leave blank for autodetection.'
+    when :badshortcut
+      Rbcli.log.error 'Invalid shortcut. Shortcuts must not have a period (.) in them.'
+    when :success
+      Rbcli.log.info "Added #{params[:slug]} to zonelist."
+    else
+      Rbcli.log.error "Duplicate zone found: #{status}. Use --(f)orce to overwrite."
+    end
+  end
+end

data/lib/config/config.rb

@@ -0,0 +1,28 @@
+Rbcli::Configurate.config do
+  ##### Config (Optional) #####
+  # The built-in config will automatically pull in a config file to a hash and vice versa
+  # It can either be used immutably (as user-defined configuration) and/or to store application state
+  #
+  #   file:                 <string> or <array>            (Required) Provide either a specific config file location or a hierarchy to search. If creating a :null type of config this can be omitted.
+  #   type:                 (:yaml|:json|:ini|:toml|:null) (Optional) Select which backend/file format to use. If the file has an associated extension (i.e. '.yaml') then this can be omitted.
+  #   schema_file:          <string>                       (Optional) The file location of a JSON Schema (https://json-schema.org). If provided, the config will automatically be validated. (default: nil)
+  #   schema_hash:          <string>                       (Optional) If you'd like to provide a JSON schema hash directly instead, do it here. May not use `schema_hash` and `schema_file` together. (default: nil)
+  #   save_on_exit:         (true|false)                   (Optional) Save changes to the config file on exit (default: false)
+  #   create_if_not_exists: (true|false)                   (Optional) Create the file using default values if it is not found on the system (default: false)
+  #   suppress_errors:      (true|false)                   (Optional) If set to false, the application will halt on any errors in loading the config. If set to true, defaults will be provided (default: true)
+  #   banner:               <string>                       (Optional) Define a banner to be placed at the top of the config file on disk. Note that it will only be written to backends that support comments
+  #   defaults:             <hash>                         (Optional) Defaults set here will be provided to your application if any values are missing in the config.
+  #                                                                     They will also be used to create new config files when the flag `create_if_not_exists` is set to true.
+  #   skeleton:             <string>                       (Optional) If a skeleton is provided, it will be used as the config source when creating new config files on disk instead of the defaults. (default: nil)`
+  #                                                                     Please provide the text exactly as you want the user to see it in the config file (plus the banner if provided).
+  file [File.join(Silkedit::LIBDIR, 'config', 'silkedit.yaml')]
+  type :yaml
+  # schema_file nil
+  # schema_hash nil
+  save_on_exit false
+  create_if_not_exists false
+  suppress_errors true
+  # banner nil
+  # defaults({ editor_command: "vi '%FILE%'", permasaves: {} })
+  # skeleton "eJzT1dXlSsvPt1JISiziAhFWSYlVAD1hBjs=".decompress
+end

data/lib/config/envvars.rb

@@ -0,0 +1,23 @@
+Rbcli::Configurate.envvars do
+  ##### Environment Variable Parsing (Optional) #####
+  # The envvars module can pull in all environment variables with a given
+  # prefix and organize them into a hash structure based on name.
+  # It will also parse the string values and convert them to the proper type (Integer, Boolean, etc)
+  # Any values set here will be treated as defaults and made available when a variable is missing
+  #
+  # For example, these two environment variables:
+  #   SILKEDIT_TERM_HEIGHT=40
+  #   SILKEDIT_TERM_WIDTH=120
+  # Would be declared here as:
+  #   prefix 'SILKEDIT'
+  #   envvar 'TERM_HEIGHT', 40
+  #   envvar 'TERM_WIDTH', 120
+  # And get loaded into the env hash as:
+  #   { term: { height: 40, width: 120 } }
+  #
+  # If the prefix is unset or equal to nil, the environment variables specified here will
+  # be loaded without one.
+  prefix 'SILKEDIT'
+  envvar 'SAVENUM', nil
+  envvar 'DEVELOPMENT', false
+end

data/lib/config/hooks.rb

@@ -0,0 +1,22 @@
+Rbcli::Configurate.hooks do
+  ##### Hooks (Optional) #####
+  # These hooks are scheduled on the Rbcli execution engine to run
+  # Pre- and Post- the command specified. They are executed after
+  # everything else has been initialized, so the runtime configuration
+  # values are all made available, as they will appear to the command.
+  #
+  # These are good for parsing and/or doing transformations on the provided
+  # configuration before passing them to the command, and for cleaning
+  # up your environment afterwards.
+  pre_execute do |opts, params, args, config, env|
+    opts[:savenum] = env[:savenum] if opts[:savenum].nil? && !env[:savenum].nil?
+
+    if !opts[:savenum].is_a?(Integer) || opts[:savenum] < 1 || opts[:savenum] > 4
+      Rbcli.log.fatal 'A savegame index between 1-4 must be specified either via the command line (-s #) or environment variable (SILKEDIT_SAVENUM=#). See help (-h) for details.', exit_status: 24
+    end
+  end
+
+  # post_execute do |opts, params, args, config, env|
+  #   Rbcli.log.info "I'm done running the command!"
+  # end
+end

data/lib/config/logger.rb

@@ -0,0 +1,36 @@
+Rbcli::Configurate.logger do
+  ##### Logger (Optional) #####
+  # The Rbcli logger is a wrapper around the standard Ruby `Logger` library
+  # It is recommended that - unless you want to use specialized output libraries (such as ncurses) - that all
+  #    of your application output is directed through the logger. This will allow for easy formatting and redirection
+  #    no matter how your application is run.
+  #
+  # Valid targets are: :stdout, :stderr, "/path/to/a/file", or an IO or StringIO object   (Default: :stdout)
+  # Valid levels are: :debug, :info, :warn, :error, :fatal, :unknown, :any                (Default: :info)
+  # Valid formats are: :display, :simple, :full, :ruby, :json, :apache, :lolcat           (Default: :display)
+  #
+  # The first three formats are designed to cover most use cases:
+  #   display:   For display on a terminal, with user interaction
+  #   simple:    For display on a terminal, for a developer
+  #   full:      For logging to a file, or using log collection software
+  # The next three are for specialized integrations in case you already have log collection configured:
+  #   ruby:      Default ruby logger format
+  #   json:      Each line is a JSON object
+  #   apache:    Follows the standard Apache log format
+  # As for :lolcat... if you can't guess what it does then give it a shot
+  logger target: :stdout, level: :info, format: :display
+  # Custom formats can also be defined here.
+  # Declaring a format here will not switch to it. However, if
+  # the `format` keyword is used without providing a Proc, it will switch
+  # to that format.
+  #
+  #   Format switch:      format :json
+  #   Format definition:  format :foo, Proc.new { |severity, datetime, progname, msg| "Foo! " + msg }
+  #
+  # You can also switch formats mid-execution by calling this method on
+  # the logger object itself.
+  #
+  #   Rbcli.log.format :json
+  #
+  # format :foo, Proc.new { |severity, datetime, progname, msg| "Foo! " + msg }
+end

data/lib/config/parser.rb

@@ -0,0 +1,34 @@
+Rbcli::Configurate.cli do
+  ##### Core Configuration (Required) #####
+  # appname          (Optional) - Defaults to the name of the executable
+  # author           (Optional) - A name or array of names
+  # email            (Optional) - An email for users to contact
+  # version          (Optional) - major.minor.patch notation, required if using update checks
+  # copyright_year   (Optional) - Self explanatory
+  # compatibility    (Optional) - Array of Operating Systems, devices, or other targets (For example: %w[MacOS Linux Ubuntu Windows Raspberry\ Pi]
+  # license          (Optional) - Convention is to use an identifier from here: https://spdx.org/licenses/
+  # helptext         (Optional) - Text that gets shown with --help or -h
+  appname nil
+  author ['Andrew Khoury']
+  email nil
+  version Silkedit::VERSION
+  copyright_year 2025
+  compatibility %w[MacOS Linux]
+  license 'GPL-3.0'
+  helptext 'This is a tool to quickly and easily edit savefiles for SilkSong.'
+  ##### CLI Options (Optional) #####
+  # These appear to commands as `opts`.
+  # Format:
+  #   opt :name, "Description"[, optional arguments ]
+  # Optional Arguments:
+  #   long: Specify the long form (--long) version of an argument. (Default: same as the name)
+  #   short: Specify the short form (-s) version of an argument. (Default: first letter of the name)
+  #   type: Specify the type. Valid options are :boolean, :float, :integer, :string, :io, :date. (Default: :boolean)
+  #     If the plural form of any of the above are used (i.e. ':strings') then the user can provide a comma-delimited list on the command line (--param=foo,bar)
+  #   required: If set to true, requires that this option is provided by the user. (Default: false)
+  #   multi: If set to true, allows the option to be provided multiple times (--param --param, or in short form, -pp). (Default: false)
+  #     When using this with a :boolean type, rather than returning `true` or `false`, it will return a count of the number of times the parameter was passed.
+  #   permitted: If set to an array, restricts input to the values within that array. (Default: nil (no restrictions))
+  # opt :verbose, "Twice or more enables very-verbose output", multi: true
+  opt :savenum, "A number from 1-4, indicating which game save you'd like to address", short: 's', type: :integer
+end

data/lib/config/updatechecker.rb

@@ -0,0 +1,12 @@
+Rbcli::Configurate.updatechecker do
+  ##### Update Check (Optional) #####
+  # The application can warn users when a new version is released
+  # Checks can be done either by rubygems or by a Github repo
+  # Private servers for Github (enterprise) are supported
+  #
+  # Setting force_update to true will halt execution until it is updated
+  #
+  # For Github, an access_token is required for private repos. See: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens
+  # gem 'silkedit', force_update: false, message: 'Please run `gem update silkedit` to upgrade to the latest version.'
+  # github 'repo/name', access_token: nil, enterprise_hostname: nil, force_update: false, message: 'Please download the latest version from Github'
+end