ArkTools 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5104482923e8cc53344ec4ab6d3a1e4854eca59f
+  data.tar.gz: c6ed8adc36d34d37db0fb92e29186cf800bb83b8
+SHA512:
+  metadata.gz: 385246b0b4e36043c66c37c05226cfd9fb2ff0b5df56516d5824779704dc67b85a79575efa9d437aa68064bd622dd52a734c7f7ae0b8806c93bd18975fd89e24
+  data.tar.gz: 7ddaab8f2309b168579992c778b4e1680f3d26bedef4c4a6654ee621e3618651763bc7caabfbfdd27c488df774d65f2f899b91a711893004a3aa4e8e98052f02

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ark_config.gemspec
+gemspec

data/README.md

@@ -0,0 +1,54 @@
+# ArkTools
+
+Welcome to ArkTools!
+
+Currently this provides a command line tool named `arktool` which will create customized Game.ini and GameUserSettings.ini lines for you.
+
+## Installation
+
+Install the gem from rubygems as you normally would. Once installed, you'll have access to the command line tool named `arktool`.
+
+    $ gem install ArkConfig
+
+## Usage
+
+`arktool help` should get you started. Subcommands also have their own help, so `arktool mods help` will give you information about the `mods` subcommand.
+
+## Commands
+
+### Mods
+
+These commands take an input file (via --file) in the following format:
+
+    MODID Description
+
+Each mod should be separated on it's own line and the order of the lines determine the load order (top to bottom)
+
+e.g.  
+
+    776464863 Ragnarok
+    813220452 Ragnarok Lore
+
+### Levels
+
+These commands will create customized level lists for your Game.ini. Please see `arktools levels help` for additional information.
+
+    --level  : the Maximum level for your server (required)
+    --exp    : The total experience to obtain max level (optional)
+    --growth : a customized logarithmic "growth rate" (very optional -- if you don't know what this means, you probably don't need it)
+
+## Future Plans
+
+- Web based interface (for the non-ruby world)
+- Other configuration options / commands as requested by the community
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/dyoung522/arktools).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/ark_tools.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ark_tool/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ArkTools"
+  spec.version       = ArkTools::VERSION
+  spec.authors       = ["Donovan Young"]
+  spec.email         = ["dyoung522@gmail.com"]
+
+  spec.summary       = %q{Creates ARK configuration files}
+  spec.description   = %Q{Uses various template files to create ARK configuration files\n} +
+                       %Q{ - Game.ini\n} +
+                       %Q{ - GameUserSettings.ini\n}
+  spec.homepage      = "https://github.com/dyoung522/arkconfig"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "config", "~> 1.3"
+  spec.add_dependency "thor"
+  spec.add_dependency "io-console"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ark_tool"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/arktool

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "ark_tool"
+
+ArkTools::Commands.start(ARGV)

data/lib/ark_tool.rb

@@ -0,0 +1,3 @@
+require "ark_tool/version"
+require "ark_tool/commands"
+

data/lib/ark_tool/commands.rb

@@ -0,0 +1,100 @@
+require "mods/ark_mod_list"
+require "generators/player_level"
+require "thor"
+
+module ArkTools
+  class Levels < Thor
+    desc "player", "Generates custom player levels Game.ini line"
+    long_desc <<-LONGDESC
+Generates "OverrideMaxExperiencePointsPlayer=" and "LevelExperienceRampOverrides=" lines 
+suitable to copy/paste into Game.ini
+
+--level     ; Maximum level you wish to obtain (required)
+\x5--exp    ; Maximum experience points to award per player (optional)
+\x5--growth ; Provide a custom growth_rate for level progression (optional)
+
+    LONGDESC
+
+    option :level, required: true, :type => :numeric, :banner => "MAX_LEVEL"
+    option :exp, :type => :numeric, :banner => "MAX_EXPERIENCE"
+    option :growth, :type => :numeric, :banner => "GROWTH_RATE"
+
+    def player
+      puts Generate::ArkGameLevels.new(options[:level].to_i,
+                                       {
+                                         max_exp:     options[:exp].to_i,
+                                         growth_rate: options[:growth].to_f
+                                       }).player_levels
+    end
+
+    desc "dino", "Generates custom dino levels Game.ini line"
+    long_desc <<-LONGDESC
+Generates "OverrideMaxExperiencePointsDino=" and "LevelExperienceRampOverrides=" lines 
+suitable to copy/paste into Game.ini
+
+--level     ; Maximum level you wish to obtain (required)
+\x5--exp    ; Maximum experience points to award per player (optional)
+\x5--growth ; Provide a custom growth_rate for level progression (optional)
+
+*NOTE* In order to include custom Dino levels, you *MUST* also include custom player levels first
+    LONGDESC
+
+    option :level, required: true, :type => :numeric, :banner => "MAX_LEVEL"
+    option :exp, :type => :numeric, :banner => "MAX_EXPERIENCE"
+    option :growth, :type => :numeric, :banner => "GROWTH_RATE"
+
+    def dino
+      puts Generate::ArkGameLevels.new(options[:level].to_i,
+                                       {
+                                         max_exp:     options[:exp].to_i,
+                                         growth_rate: options[:growth].to_f
+                                       }).dino_levels
+    end
+  end # class Generate
+
+  class Mods < Thor
+    desc "Active", "Creates an ActiveMods= line suitable for GameUserSettings.ini"
+
+    option :file, required: true
+
+    def activemods(file = options[:file])
+      puts "ActiveMods=#{ArkModList.new(file).csv}"
+    end
+
+    desc "Configs", "Generates both ActiveMods and ModInstaller"
+
+    option :file, required: true
+
+    def configs
+      invoke :activemods
+      puts
+      invoke :modinstaller
+    end
+
+    desc "List", "Displays a list of active mods from the provided input file"
+
+    option :file, required: true
+
+    def list
+      ArkModList.new(options[:file]).each { |mod| printf "%-25s %s\n", mod.description, mod.id }
+    end
+
+    desc "ModInstaller", "Creates a [ModInstaller] block suitable for Game.ini"
+
+    option :file, required: true
+
+    def modinstaller(file = options[:file])
+      puts "[ModInstaller]"
+      ArkModList.new(file).each { |mod| printf "ModIds=%s ; %s\n", mod.id, mod.description }
+    end
+  end # class Mods
+
+  class Commands < Thor
+    desc "mods", "Commands related to Mod Settings"
+    subcommand "mods", Mods
+
+    desc "levels", "Commands related to custom player/dino levels for Game.ini"
+    subcommand "levels", Levels
+  end # class Commands
+end # module ArkTools
+

data/lib/ark_tool/version.rb

@@ -0,0 +1,4 @@
+module ArkTools
+  PROGRAM = File.basename($0, ".rb")
+  VERSION = "0.1.0"
+end

data/lib/generators/player_level.rb

@@ -0,0 +1,43 @@
+module ArkTools
+  module Generate
+    class ArkGameLevels
+      def initialize(max_level, options = {})
+        @max_level   = max_level
+        @max_exp     = options[:max_exp] == 0 ? max_level * 10000 : options[:max_exp]
+        @growth_rate = options[:growth_rate] == 0 ? Math.log(@max_exp, @max_level) : options[:growth_rate]
+      end
+
+      def _calc_exp(level)
+        (level ** @growth_rate).round
+      end
+
+      def _make_level_overrides
+        exp_config = []
+
+        (0..@max_level).each { |lvl|
+          exp_config << "ExperiencePointsForLevel[#{lvl}]=#{_calc_exp lvl}"
+        }
+
+        "LevelExperienceRampOverrides=(#{exp_config.join(",")})"
+      end
+
+      def _make_levels(type)
+        type           = type.to_s.capitalize
+        max_experience = _calc_exp@max_level
+
+        raise RuntimeError, "type must be either 'Player' or 'Dino'" unless ["Player", "Dino"].include?(type)
+
+        "OverrideMaxExperiencePoints#{type}=#{max_experience}\n" +
+          _make_level_overrides
+      end
+
+      def player_levels
+        _make_levels"Player"
+      end
+
+      def dino_levels
+        _make_levels"Dino"
+      end
+    end
+  end
+end

data/lib/mods/ark_mod.rb

@@ -0,0 +1,14 @@
+module ArkTools
+  class ArkMod
+    attr_reader :id, :description
+
+    def initialize(mod)
+      @id          = mod[0]
+      @description = mod[1]
+    end
+
+    def to_s
+      "#{id}:#{description}"
+    end
+  end
+end

data/lib/mods/ark_mod_list.rb

@@ -0,0 +1,28 @@
+require "mods/ark_mod"
+
+module ArkTools
+  class ArkModList
+    attr_reader :mods
+    
+    def initialize(file)
+      @mods = []
+
+      File.open(file, "r") do |f|
+        f.each_line do |line|
+          next if line =~ /^\s*[^\d]+/
+          if match = line.match(/(\d+)[\s\/#;]+(.*)$/)
+            @mods.push ArkMod.new(match.captures)
+          end
+        end
+      end
+    end
+
+    def each
+      @mods.each { |mod| yield mod }
+    end
+
+    def csv
+      @mods.map(&:id).join(",")
+    end
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: ArkTools
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Donovan Young
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: io-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |
+  Uses various template files to create ARK configuration files
+   - Game.ini
+   - GameUserSettings.ini
+email:
+- dyoung522@gmail.com
+executables:
+- arktool
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- ark_tools.gemspec
+- bin/console
+- bin/setup
+- exe/arktool
+- lib/ark_tool.rb
+- lib/ark_tool/commands.rb
+- lib/ark_tool/version.rb
+- lib/generators/player_level.rb
+- lib/mods/ark_mod.rb
+- lib/mods/ark_mod_list.rb
+homepage: https://github.com/dyoung522/arkconfig
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Creates ARK configuration files
+test_files: []