feh-hsdarcwriter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc8fea65e2141fa49e6fb251787bdce08cb795d6bcb13bf93323bf568e67fc69
+  data.tar.gz: 0c9c2a9746096edab92918dabbcec0f716426718d4a9eca3291670e01beb5871
+SHA512:
+  metadata.gz: d1f2cbf197939691480a4172a1220431b39151d437d89dd9fd4884cd3016baa51aea056dc79770bf994e506e1801f2c63fb2835585c2b7754bb8e11130046eb6
+  data.tar.gz: b8b7dc36a11fd1863b084ed83708dc809f9051103d6e5aa228d81714c22720439afec3713f603d31fbbbec5b66a00589fd91bd6c7cf4dced6b75715fa7f7f80d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in feh-hsdarcwriter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Quinton Miller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.md

@@ -0,0 +1,67 @@
+# feh-hsdarcwriter
+
+`Feh::HSDArcWriter` is an interface for generating files in the HSDArc file
+format used by Fire Emblem Heroes.
+
+## Installation
+
+```ruby
+$ gem install feh-hsdarcwriter
+```
+
+## Example
+
+The following script generates an HSDArc file _equivalent_ to
+`assets/Common/SRPG/Move.bin` as of FEH version 2.9.1:
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'feh/hsdarc_writer'
+
+MVMTS = [
+  {id_tag: 'MVID_歩行', range: 2, costs: [
+     1,  1,  1,  2, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,  1,
+     1,  2,  1, -1, -1, -1,  1,  1,  1,  1, -1,  1,  1,  1,  1,  1,
+     1, -1, -1]},
+  {id_tag: 'MVID_重装', range: 1, costs: [
+     1,  1,  1,  1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,  1,
+     1,  1,  1, -1, -1, -1,  1,  1,  1,  1, -1,  1,  1,  1,  1,  1,
+     1, -1, -1]},
+  {id_tag: 'MVID_騎馬', range: 3, costs: [
+     1,  1,  1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,  1,
+     1, -1,  1, -1, -1, -1,  3,  3,  3,  3, -1,  1,  1,  1,  1,  1,
+     1, -1, -1]},
+  {id_tag: 'MVID_飛行', range: 2, costs: [
+     1,  1,  1,  1,  1,  1,  1,  1, -1, -1, -1, -1, -1, -1, -1,  1,
+     1,  1,  1, -1, -1, -1,  1,  1,  1,  1,  1,  1,  1,  1,  1,  1,
+     1, -1, -1]},
+]
+
+writer = Feh::HSDArcWriter.new
+writer.ptr do |blk|
+  MVMTS.each_with_index do |mvmt, index|
+    blk.string(mvmt[:id_tag], Feh::HSDArcWriter::XORKeys::ID_XORKEY)
+    blk.ptr {|costs| costs.i8(mvmt[:costs], 0xB8)}
+    blk.i32(index, 0xD5025852)
+    blk.i8(mvmt[:range], 0x80)
+  end
+end
+writer.i64(MVMTS.size, 0x20A10C408924170E)
+
+IO.binwrite('Move.bin', writer.hsdarc.pack('c*'))
+
+# if Feh::Bin is available:
+# require 'feh/bin'
+# IO.binwrite('Move.bin.lz', Feh::Bin.compress(writer.hsdarc).pack('c*'))
+```
+
+## Changelog
+
+### V0.1.0
+
+- Initial release
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.description = 'Run unit tests'
+  t.libs << 'lib'
+  t.test_files = FileList['spec/**/*_spec.rb']
+end

data/bin/console

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

@@ -0,0 +1,25 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "feh/hsdarc_writer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "feh-hsdarcwriter"
+  spec.version       = Feh::HSDArcWriter::VERSION
+  spec.authors       = ["Quinton Miller"]
+  spec.email         = ["nicetas.c@gmail.com"]
+
+  spec.summary       = "HSDArc file builder for Fire Emblem Heroes"
+  spec.description   = "Builder interface for the HSDArc file format used in Fire Emblem Heroes."
+  spec.homepage      = "https://github.com/HertzDevil/feh-hsdarcwriter"
+  spec.license       = "MIT"
+
+  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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/feh/hsdarc_writer.rb

@@ -0,0 +1,167 @@
+#!/usr/bin/env ruby
+
+require 'feh/hsdarc_writer/version'
+require 'feh/hsdarc_writer/xor_keys'
+
+module Feh
+  # A class that builds well-formed HSDArc files used in Fire Emblem Heroes.
+  #
+  # Duplicate strings are currently stored like any other sub-block and not
+  # optimized; the compiled HSDArc data might not be byte-for-byte identical to
+  # the original asset files.
+  class HSDArcWriter
+    def initialize
+      @buf = []
+      @subblocks = []
+    end
+
+    # @return [Array<Integer>] the relocatable pointer list
+    def reloc_ptrs
+      @subblocks.map(&:first)
+    end
+
+    # Writes 8-bit integers.
+    # @param x [Integer, Array<Integer>] the integer value(s)
+    # @param xor [Integer] XOR value
+    # @return [HSDArcWriter] self
+    def i8(x, xor = 0)
+      int(x, 1, xor)
+    end
+
+    # Writes 16-bit integers.
+    # @param x [Integer, Array<Integer>] the integer value(s)
+    # @param xor [Integer] XOR value
+    # @return [HSDArcWriter] self
+    def i16(x, xor = 0)
+      int(x, 2, xor)
+    end
+
+    # Writes 32-bit integers.
+    # @param x [Integer, Array<Integer>] the integer value(s)
+    # @param xor [Integer] XOR value
+    # @return [HSDArcWriter] self
+    def i32(x, xor = 0)
+      int(x, 4, xor)
+    end
+
+    # Writes 64-bit integers.
+    # @param x [Integer, Array<Integer>] the integer value(s)
+    # @param xor [Integer] XOR value
+    # @return [HSDArcWriter] self
+    def i64(x, xor = 0)
+      int(x, 8, xor)
+    end
+
+    # Writes boolean values.
+    # @param b [Object, Array<Object>] the boolean value(s), only truthiness is
+    #   considered
+    # @param xor [Integer] XOR value
+    # @return [HSDArcWriter] self
+    def bool(b, xor = 0)
+      i8(b ? 1 : 0, xor)
+    end
+
+    # Writes an XOR-encrypted string. The resulting string is always zero-padded
+    # to align on 64-bit boundaries.
+    # @param str [String] UTF-8 string
+    # @param xor [Array<Integer>] optional XOR cipher to use, writes unencrypted
+    #   strings by default
+    # @return [HSDArcWriter] self
+    def xor_str(str, xor = [0])
+      align(8)
+      bytes = str.bytes.zip(xor.cycle).map {|x, y| x != y ? x ^ y : x}
+      bytes += [0] * (8 - bytes.size % 8)
+      @buf += bytes
+      self
+    end
+
+    # Creates a pointer to an XOR-encrypted string.
+    # @param str [String] UTF-8 string
+    # @param xor [Array<Integer>] optional XOR cipher to use, writes unencrypted
+    #   strings by default
+    # @return [HSDArcWriter] self
+    def string(str, xor = [0])
+      ptr {|blk| blk.xor_str(str, xor)}
+    end
+
+    # Writes a null pointer.
+    # @return [HSDArcWriter] self
+    def nullptr
+      i64(0)
+    end
+
+    # Writes a pointer that points to a new block.
+    # @yieldparam blk [HSDArcWriter] the sub-block object
+    # @return [HSDArcWriter] self
+    def ptr(&block)
+      blk = self.class.new
+      block.(blk)
+      align(8)
+      @subblocks << [@buf.size, blk]
+      nullptr
+    end
+
+    # Compiles the data section of the HSDArc file.
+    # @return [Array<Integer>] Content of the data section
+    def compile
+      hsdarc_impl.first
+    end
+
+    # Compiles the whole HSDArc file.
+    # @return [Array<Integer>] Content of the HSDArc file
+    def hsdarc
+      bin, reloc = hsdarc_impl
+      total_size = 0x20 + bin.size + reloc.size * 8
+      header = [total_size, reloc.empty? ? 0 : bin.size, reloc.size, 0, 0, 1, 0, 0]
+        .pack('i*').bytes
+      header + bin + reloc.pack('j*').bytes
+    end
+
+    # Aligns the data pointer.
+    # @param x [Integer] alignment byte count
+    # @return [HSDArcWriter] self
+    def align(x)
+      @buf += [0] * ((-@buf.size) % x)
+      self
+    end
+
+  private
+    def int(x, len, xor = 0)
+      align(len)
+      if x.is_a?(Array)
+        x.map! {|y| y ^ xor}
+        x.each {|y| @buf += Array.new(len) {|i| (y >> (i * 8)) & 0xFF}}
+      else
+        x ^= xor
+        @buf += Array.new(len) {|i| (x >> (i * 8)) & 0xFF}
+      end
+      self
+    end
+
+    def self.replace_ptr(arr, pos, x)
+      x += arr[pos, 8].pack('c*').unpack('j').first
+      arr[pos, 8] = Array.new(8) {|i| (x >> (i * 8)) & 0xFF}
+      nil
+    end
+
+    def hsdarc_impl
+      bin = @buf.dup
+      bin += [0] * ((-bin.size) % 8)
+      reloc = reloc_ptrs
+
+      @subblocks.each do |pos, blk|
+        s = bin.size
+        bin2 = blk.compile
+        reloc2 = blk.reloc_ptrs
+        reloc2.map! {|x| x + s}
+        bin += bin2
+        reloc2.each {|x| self.class.replace_ptr(bin, x, s)}
+        reloc += reloc2
+        self.class.replace_ptr(bin, pos, s)
+      end
+
+      bin += [0] * ((-bin.size) % 8)
+      [bin, reloc]
+    end
+  end
+end

data/lib/feh/hsdarc_writer/version.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+module Feh
+  class HSDArcWriter
+    # Version number.
+    VERSION = "0.1.0"
+  end
+end

data/lib/feh/hsdarc_writer/xor_keys.rb

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+
+module Feh
+  class HSDArcWriter
+    module XORKeys
+      # Produces a XOR cipher from an internal key.
+      # @param key [Array<Integer>] byte values of the internal key
+      # @return [Array<Integer>] content of the XOR cipher
+      def self.make_cipher(key)
+        k = (key[0] + key[1]) & 0xFF
+        cipher = []
+        key.each do |x|
+          k ^= x
+          cipher << k
+        end
+        key.each do |x|
+          k ^= x
+          cipher << k
+        end
+        cipher
+      end
+
+      # XOR cipher used for almost all asset files.
+      ID_XORKEY = make_cipher([
+        0x40, 0x81, 0x80, 0x24, 0xFE, 0x4C, 0x79, 0x17, 0x2F,
+        0xD6, 0xAC, 0xDA, 0x0B, 0x9A, 0x69, 0x28, 0x52,
+      ]).freeze
+
+      # XOR cipher used for message files.
+      MSG_XORKEY = make_cipher([
+        0x58, 0xDF, 0x3F, 0x59, 0x39, 0x85, 0x30, 0xB1, 0x2D,
+        0xB0, 0x80, 0x13, 0xB3, 0xCB, 0x25, 0xB0, 0xE8, 0x5D,
+        0x2E, 0x29, 0xBF, 0xC9, 0xEA, 0x70, 0x33, 0x7B, 0xE6,
+        0xD3, 0xD2,
+      ]).freeze
+
+      # XOR cipher used for files under `assets/Common/Tutorial/`.
+      TUT_XORKEY = make_cipher([
+        0x0B, 0x76, 0x02, 0xC7, 0x63, 0x1F, 0xDD, 0x15, 0xE3,
+        0x90, 0x7E, 0x4E, 0xC6, 0x7C, 0x60, 0x81, 0x7A, 0x94,
+      ]).freeze
+
+      # XOR cipher used for files under `assets/Common/SRPG/StageBgm/`.
+      BGM_XORKEY = make_cipher([
+        0xE0, 0xAF, 0xF7, 0x8B, 0x7B, 0xA8, 0x6B, 0x3F, 0x55,
+        0x15, 0x0D, 0xCE, 0x7F, 0xE9, 0x20, 0x0F, 0xE7, 0x82,
+      ]).freeze
+
+      # XOR cipher used for files under `assets/Common/Occupation/World/`.
+      GC_XORKEY = make_cipher([
+        0x56, 0xEB, 0x35, 0x23, 0x93, 0x10, 0x4D, 0x99, 0x19,
+        0xF0, 0x5A, 0x56, 0xE5, 0x36, 0xBD, 0xFB, 0x62, 0x1B,
+      ]).freeze
+
+      # XOR cipher used for files under `assets/Common/Tournament/`.
+      VG_XORKEY = make_cipher([
+        0xD7, 0x76, 0x02, 0xC7, 0xA8, 0x1F, 0x5C, 0x80, 0xE3,
+        0x2C, 0x7E, 0x4E, 0xC6, 0x0C, 0x94, 0x15, 0x7A, 0x60,
+      ]).freeze
+
+      # XOR cipher used for files under `assets/Common/Portrait/`.
+      FB_XORKEY = make_cipher([
+        0x04, 0x27, 0x6E, 0x8B, 0x91, 0xE4, 0xAC, 0x1E, 0xCE,
+        0x48, 0xED, 0x90, 0x34, 0xFA, 0xCD, 0x8C, 0x76, 0x1A,
+        0x44, 0xA8, 0x59, 0x8D, 0xAD, 0x5E, 0xBD, 0x6C, 0x0E,
+        0xE1, 0xE2,
+      ]).freeze
+
+      # XOR cipher used for files under `assets/Common/LoginBonus/`.
+      LOGIN_XORKEY = make_cipher([
+        0xA9, 0xBB, 0xE3, 0xE8, 0x07, 0x8F, 0x46, 0xB8, 0xED,
+        0x2F, 0xF0, 0x4B, 0x8E, 0x62, 0x7C, 0x91, 0x4E, 0x0C,
+      ]).freeze
+
+      # XOR cipher used for files under `assets/Common/Summon/`.
+      SUMMON_XORKEY = make_cipher([
+        0x87, 0x1C, 0xC0, 0xF8, 0x4C, 0xAC, 0xCE, 0x0D, 0x50,
+        0xF0, 0x6C, 0x2B, 0x40, 0x0B, 0x7B, 0x1D, 0x3B, 0x77,
+      ]).freeze
+
+      # XOR cipher used for files under `assets/Common/Home/`.
+      HOME_XORKEY = make_cipher([
+        0xE3, 0x17, 0xC8, 0xEF, 0x87, 0x81, 0x71, 0x52, 0xBC,
+        0x66, 0x38, 0xBD, 0xFB, 0x5B, 0x79, 0xF1, 0xE3, 0xE1,
+      ]).freeze
+
+      # XOR cipher used for `assets/Common/Loading/Data.bin`.
+      LOADING_XORKEY = make_cipher([
+        0x73, 0x76, 0xEF, 0xC7, 0xC5, 0x1F, 0x5C, 0x80, 0xE3,
+        0x70, 0x7E, 0x53, 0xC6, 0xD7, 0x94, 0x15, 0x7A, 0x60,
+      ]).freeze
+
+      # XOR cipher used for files under `assets/Common/Battle/Asset/`.
+      BATTLE_XORKEY = make_cipher([
+        0x01, 0x6F, 0x1A, 0xF1, 0xB2, 0x3D, 0x66, 0xBE, 0x9C,
+        0x76, 0x73, 0xE3, 0x4D, 0x1C, 0xA1, 0x7A, 0x1D, 0x41,
+        0x19, 0x20, 0x33, 0xC6, 0x85, 0xA6,
+      ]).freeze
+
+      # XOR cipher used for files under `assets/Common/Effect/arc/`.
+      EFFECT_ARC_XORKEY = make_cipher([
+        0x0B, 0x44, 0x35, 0xF4, 0x3E, 0xEB, 0xDC, 0x59, 0x62,
+        0xED, 0x01, 0x74, 0xA7, 0xA8, 0x3D, 0x81, 0x64, 0x7C,
+      ]).freeze
+
+      # XOR cipher used for files under `assets/Common/Sound/arc/`.
+      SOUND_ARC_XORKEY = make_cipher([
+        0x30, 0x3A, 0x10, 0xF0, 0x21, 0x33, 0x9E, 0xF9, 0xD2,
+        0xA5, 0x10, 0xCA, 0x42, 0x90, 0xDC, 0x2C, 0x3C, 0x81,
+      ]).freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: feh-hsdarcwriter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Quinton Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Builder interface for the HSDArc file format used in Fire Emblem Heroes.
+email:
+- nicetas.c@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- feh-hsdarcwriter.gemspec
+- lib/feh/hsdarc_writer.rb
+- lib/feh/hsdarc_writer/version.rb
+- lib/feh/hsdarc_writer/xor_keys.rb
+homepage: https://github.com/HertzDevil/feh-hsdarcwriter
+licenses:
+- MIT
+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.7.6
+signing_key: 
+specification_version: 4
+summary: HSDArc file builder for Fire Emblem Heroes
+test_files: []