encrust 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3685e61c950b2154ef3c868f5a0073f8580e1c41b5dbdb43bcc91866b2c3ec43
+  data.tar.gz: 3d056f617c3f2673c4be37a9599a8a0ae7fb62c70d1ac080364b5f5a5a5d8acd
+SHA512:
+  metadata.gz: 1dfb83c30a5efa93e4558ab6d46079a0304c5aae3a6344fb1dc87009934b6780c601d121b1f6860d92f97f9450c86029783dd55608f96772eb4c011ed8d7f9c7
+  data.tar.gz: ef05089855eaa62b1ff12347c5f55621214e2bfbd9cf6cdaf19b7bf52fb848eac04c3f86dc02273de356f2a43f06bf01331f8165bd603df15144392cdc78b2c2

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mkg@fastmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/README.md

@@ -0,0 +1,49 @@
+# «encrust»
+
+encrust is a command line tool that converts iTerm2 color files (`*.itermcolors`) to color files usable by Dwarf Fortress.
+
+## Installation
+
+encrust requires Ruby. If you have a current version of Ruby installed, it's as simple as:
+
+    $ gem install encrust
+
+Otherwise, head on over to [Ruby's website](https://www.ruby-lang.org/en/downloads/) and find a version that works for your machine.
+
+## Usage
+
+### Security considerations
+
+encrust uses the [plist gem](https://github.com/patsplat/plist). Please only feed it files you trust, and check out [plist's security considerations section](https://github.com/patsplat/plist#security-considerations) for more information.
+
+### encrusting with gems
+
+Just point encrust at the files you'd like converted:
+
+    $ encrust gruvbox-dark-soft.itermcolors
+
+It handles multiple files just fine:
+
+    $ encrust elflord.itermcolors Earthsong.itermcolors
+
+Your Dwarf Fortress color files will be generated in the directory where you ran the command, and encrust will tell you where Dwarf Fortress expects its active color file to be.
+
+If you want to try out your new color schemes without having to wait for your fortresses to open and close, try uploading the generated files to the [Dwarf Fortress Color Generator](https://manmademagic.github.io/DFColorGen/). DFColorGen also works great for small adjustments to your color schemes.
+
+## Why iTerm?
+
+I chose `itermcolors` as my input format primarily because it supports 24-bit color and is easy to read.
+
+iTerm2 is also pretty popular, and dozens if not hundreds of color schemes for it can be easily found online.
+
+## Support Bay 12 Games!
+
+If you like Dwarf Fortress, consider supporting Bay 12 Games either through their [patreon](https://www.patreon.com/bay12games) or directly through their [website](http://bay12games.com/support.html).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/smoochbot/encrust. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Encrust project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/smoochbot/encrust/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/UNLICENSE

@@ -0,0 +1,25 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "encrust"
+
+# 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/encrust.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "encrust/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "encrust"
+  spec.version       = Encrust::VERSION
+  spec.authors       = ["Margaret K. Geiger"]
+  spec.email         = ["mkg@fastmail.com"]
+
+  spec.summary       = %q{Converts iTerm2 color schemes to Dwarf Fortress color files.}
+  spec.homepage      = "https://github.com/smoochbot/encrust"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_runtime_dependency "plist", "~> 3.5"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/exe/encrust

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'encrust/cli'
+Encrust::CLI.start
+

data/lib/encrust.rb

@@ -0,0 +1,4 @@
+require 'encrust/version'
+require 'encrust/converter'
+
+module Encrust; end

data/lib/encrust/cli.rb

@@ -0,0 +1,96 @@
+require 'encrust'
+
+module Encrust
+  class CLI
+    class << self
+      def start
+        paths = ARGV.map(&:freeze)
+        puts greeting(paths)
+        errors = convert(paths)
+        puts error_message(errors) if errors.any?
+        puts instructions if paths.size > errors.size
+        puts exit_message
+      end
+
+      private
+
+      def convert(files)
+        puts
+        errors = []
+        files.each do |path|
+          print "  ☼ #{File.basename(path)} -> "
+          begin
+            colors = Converter.iterm_to_df(path)
+          rescue ArgumentError => e
+            STDERR.puts "ERROR \e[31;1m✕\e[0m"
+            errors << path
+          else
+            file = "#{File.basename(path, ".*").tr(' ', '_')}.txt"
+            File.write(file, colors)
+            puts "«#{file}» \e[32;1m✓\e[0m"
+          end
+        end
+        errors
+      end
+
+      def greeting(paths)
+        if paths.count == 1
+          "Converting an iterm2 color scheme to a Dwarf Fortress color file."
+        else
+          "Converting #{paths.count} iTerm2 color schemes " \
+            "to Dwarf Fortress color files."
+        end
+      end
+
+      def instructions
+        <<~DWARF
+
+          To use your colors in Dwarf Fortress, move your chosen file to:
+
+            <your_dwarf_fortress_path>/data/init/colors.txt
+
+          Consider backing up the existing colors.txt file first.
+        DWARF
+      end
+
+      def error_message(paths_with_errors)
+        plural = paths_with_errors.size > 1 ? 's' : nil
+        <<~DWARF
+
+          Error#{plural} while parsing file#{plural} at path#{plural}:
+
+          #{paths_with_errors.map { |p| "  #{p}" }.join("\n")}
+
+          Please make sure to use valid, suitable iTerm2 color files:
+            ☼ They should be in PLIST (XML) format and contain <dict> tags.
+            ☼ They should specify RGB values for all ANSI colors from 0 to 15,
+              with each color's key formatted like e.g. `Ansi 0 Color` for 0.
+            ☼ Each RGB value should lie between 0 and 1, both inclusive.
+        DWARF
+      end
+
+      def exit_message
+        <<~DWARF
+
+          To support the development of Dwarf Fortress, go to:
+            ☼ Bay 12 Games's patreon: #{patreon}
+            ☼ Bay 12 Games's website: #{bay_12_site}
+
+          Thanks for using encrust, and remember: Losing is fun!
+        DWARF
+      end
+
+      def patreon
+        underline("https://www.patreon.com/bay12games")
+      end
+
+      def bay_12_site
+        underline("http://bay12games.com/support.html")
+      end
+
+      def underline(text)
+        "\e[4m#{text}\e[0m"
+      end
+    end
+  end
+end

data/lib/encrust/converter.rb

@@ -0,0 +1,78 @@
+require 'plist'
+
+module Encrust
+  class Converter
+    class << self
+      def iterm_to_df(path)
+        header << colors(path) << footer(path)
+      end
+
+      private
+
+      # ANSI Color 3 ("yellow") is called "BROWN" in Dwarf Fortress,
+      # while ANSI Color 11 ("bright yellow") is simply called "YELLOW".
+      # ANSI Color 7 ("white") is called "LGRAY" in Dwarf Fortress,
+      # ANSI Color 8 ("bright black") is called "DGRAY", and
+      # ANSI Color 15 ("bright white") is called "WHITE".
+      def df_color_names
+        %i[BLACK  RED  GREEN  BROWN  BLUE  MAGENTA  CYAN LGRAY
+           DGRAY LRED LGREEN YELLOW LBLUE LMAGENTA LCYAN WHITE]
+      end
+
+      def parse(path)
+        begin
+          Plist.parse_xml(path)
+        rescue RuntimeError => e
+          msg = "Failed to parse file at path: #{path}"
+          raise ArgumentError.new(msg)
+        end
+      end
+
+      def colors(path)
+        iterm_colors = parse(path)
+        df_color_names.each_with_index.reduce("") do |df_colors, (color, i)|
+          iterm_rgb = iterm_colors["Ansi #{i} Color"]
+          if iterm_rgb.nil?
+            msg = "Missing color definition for #{color} (DF) / #{i} (ANSI)"
+            raise ArgumentError.new(msg)
+          end
+          df_colors << generate_df_color(color, iterm_rgb)
+        end
+      end
+
+      def generate_df_color(color, iterm_rgb)
+        red   = (iterm_rgb['Red Component'] * 255).to_i
+        green = (iterm_rgb['Green Component'] * 255).to_i
+        blue  = (iterm_rgb['Blue Component'] * 255).to_i
+        
+        if [red, green, blue].any? { |x| x > 255 || 0 > x }
+          msg = "RGB value for #{color} (DF) out of valid range."
+          raise ArgumentError.new(msg)
+        end
+
+        <<~DWARF
+            [#{color}_R:#{red}]
+            [#{color}_G:#{green}]
+            [#{color}_B:#{blue}]
+        DWARF
+      end
+
+      def header
+        <<~DWARF
+          These are the display colors in RGB.  \
+          The game is actually displaying extended \
+          ASCII characters in OpenGL, so you can modify the colors.
+
+        DWARF
+      end
+
+      def footer(path)
+        <<~DWARF
+
+          Converted from `#{File.basename(path)}` using encrust:
+          https://github.com/smoochbot/encrust
+        DWARF
+      end
+    end
+  end
+end

data/lib/encrust/version.rb

@@ -0,0 +1,3 @@
+module Encrust
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: encrust
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Margaret K. Geiger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: 
+email:
+- mkg@fastmail.com
+executables:
+- encrust
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- UNLICENSE
+- bin/console
+- bin/setup
+- encrust.gemspec
+- exe/encrust
+- lib/encrust.rb
+- lib/encrust/cli.rb
+- lib/encrust/converter.rb
+- lib/encrust/version.rb
+homepage: https://github.com/smoochbot/encrust
+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.0.1
+signing_key: 
+specification_version: 4
+summary: Converts iTerm2 color schemes to Dwarf Fortress color files.
+test_files: []