rsgt 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4cfc5355379a4cbe1f82dbc8e1804e17d39cd59c
+  data.tar.gz: b4d7dfd5381f73ab1afb6777db0915e3cb2ca474
+SHA512:
+  metadata.gz: 61f701a60a21e1cc8baf7c2fda41b0c7e86d100ea7c6f05072b4d25450afa067e294548e54ece30574d03cf861490247828e501cf75c9ac563fd0c9b85ca5d9f
+  data.tar.gz: 4c6bfe25aa2a2d62ca7e62de312fac64744e861db37ff697d6696ad6083fe6e17a3b83f8044b005303b6b0f5f0e58ec8e826be4092d998c34893b7fc810166da

data/.gitignore

@@ -0,0 +1,6 @@
+tmp/
+coverage/
+
+Gemfile.lock
+
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "pry-coolline"
+gem "coveralls"

data/README.markdown

@@ -0,0 +1,139 @@
+# Rocksmith Guitar Tech
+
+Ruby 💎 tool for working with rocksmith songs, DLC, and profile data.
+Almost certainly only useful for Mac.
+
+## Installation
+
+`gem install rsgt`
+
+### Dependencies
+
+This tool relies on various bits of software to do the various bits of things it does...
+
+- `pyrocksmith` (https://github.com/0x0L/rocksmith)
+  - Needed for anything involving unpacking/repacking
+  - Install by doing:
+    - `brew install pip`
+    - `pip3 install git+https://github.com/0x0L/rocksmith.git`
+- WWise (https://www.audiokinetic.com/download/#macosx)
+  - Needed if you're going to repack audio
+- [Rocksmith Custom Song Toolkit](https://www.rscustom.net/)
+  - Used for extracting audio out to ogg files
+  - Used for sng <-> xml conversion (like changing vocals)
+  - Installation:
+    - Move to `/Applications`
+    - `brew cask install mono-mdk`
+    - `brew install wine winetricks`
+- `ffmpeg`
+  - `brew install ffmpeg`
+
+## Usage: Uncensoring
+
+For example...
+
+```bash
+# Extracts ragebomb_vocals.xml:
+rsgt extract-vocals --psarc=ragekilling_m.psarc
+
+# Edit the vocals file, putting back in missing words:
+vim ragebomb_vocals.xml
+
+# Extract the audio track to use as a guide track
+# This creates output.ogg
+rsgt extract-audio --psarc=ragekilling_m.psarc
+
+# Using output.ogg as a guide track, take the real CD wav, line it up, save as fixed.wav
+<AUDIO EDITING>
+
+# Repack the fixed vocals and audio track back in:
+rsgt \
+  repack \
+  --psarc=ragekilling_m.psarc \
+  --xml=ragebomb_vocals.xml \
+  --audio=fixed.wav
+```
+
+#### Repacking Options
+
+You can also repack the preview if you want:
+
+```bash
+rsgt \
+  repack \
+  --psarc=ragekilling_m.psarc \
+  --xml=ragebomb_vocals.xml \
+  --audio=fixed.wav \
+  --preview \
+  --chorus=45
+```
+
+## Usage: Multipacker
+
+The Multipacker can pack a bunch of psarcs into a single multipack.
+
+For example, say you have this kind of folder structure:
+
+```
+~/rocksmith/songs
+  /uncensored
+    - Green Day - American Idiot_m.psarc
+    ... some other songs
+  /Official
+    - Green Day - American Idiot_m.psarc
+    ... hundreds of other songs
+  /CDLC
+    ... hundreds of custom songs
+```
+
+Then you'd create a config file such as:
+
+```yaml
+destination: ~/Library/Application\ Support/Steam/SteamApps/common/Rocksmith2014/dlc
+
+repacks:
+  - title:      Uncensored
+    directory:  ~/rocksmith/songs/Uncensored
+    unpack_dir: ~/rocksmith/unpacks/uncensored
+    repack_dir: ~/rocksmith/repacks/uncensored
+    options:
+      reset_unpack: false
+      reset_repack: false
+
+  - title:      Official
+    directory:  ~/rocksmith/songs/Official
+    unpack_dir: ~/rocksmith/unpacks/official
+    repack_dir: ~/rocksmith/repacks/official
+    options:
+      reset_unpack: false
+      reset_repack: false
+
+  - title:      Custom
+    directory:  ~/rocksmith/songs/CDLC
+    unpack_dir: ~/rocksmith/unpacks/cdlc
+    repack_dir: ~/rocksmith/repacks/cdlc
+    options:
+      reset_unpack: false
+      reset_repack: false
+```
+
+And running `rsgt multipack --config=thatfile.yml` would:
+- Repack all of your uncensored songs into a single "Uncensored - n songs _m.psarc" file, and move it to your DLC folder.
+- Repack all of your official songs into a single "Official - n songs _m.psarc" file, and move it to your DLC folder.
+  - Leaving out songs that it already got from uncensored
+- Repack all of your custom songs into a single "Custom - n songs _m.psarc" file, and move it to your DLC folder.
+
+##### Notes:
+- Make sure to check the RS DLC folder, and remove any duplicates - just leave the lastest of each multipack
+- You can keep your `unpack`/`repack` directories around as a cache
+- The "reset" options will nuke that folder:
+  - If you're just adding songs, keep it as false, and it'll be zippy
+  - If you're deleting/changing songs, change it to true, so stale copies don't get packed in
+
+## Usage: Saved Game exploration
+
+... this area is WIP, you probably don't want to mess with `RSGuitarTech::SavedGame` at all right now.
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require "rspec/core"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern    = "spec/**/*_spec.rb"
+  spec.rspec_opts = "--color"
+end
+
+task default: :spec

data/bin/rsgt

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "rsgt"
+
+RSGuitarTech::CLI.parse ARGV

data/lib/rsgt.rb

@@ -0,0 +1,42 @@
+require "tmpdir"
+require "fileutils"
+require "shellwords"
+require "bindata"
+require "zlib"
+require "json"
+require "openssl"
+require "active_support"
+require "active_support/core_ext"
+
+begin
+  require "pry"
+rescue LoadError
+end
+
+require "rsgt/version"
+require "rsgt/command_runner"
+require "rsgt/rs_custom_song_toolkit"
+require "rsgt/unpacked_psarc"
+require "rsgt/vocals_extractor"
+require "rsgt/audio_extractor"
+require "rsgt/wwise_converter"
+require "rsgt/repacker"
+require "rsgt/wav_shifter"
+require "rsgt/multipacker/config_processor"
+require "rsgt/steam"
+require "rsgt/encrypted_steam_file"
+require "rsgt/saved_game/song_collection"
+require "rsgt/saved_game/score_attack/song"
+require "rsgt/saved_game/statistics/song"
+require "rsgt/saved_game/learn_a_song/song"
+require "rsgt/saved_game/statistics"
+require "rsgt/saved_game"
+require "rsgt/multipacker"
+require "rsgt/cli"
+
+module RSGuitarTech
+  class << self
+    attr_accessor :verbose
+    @verbose = false
+  end
+end

data/lib/rsgt/audio_extractor.rb

@@ -0,0 +1,25 @@
+module RSGuitarTech
+  class AudioExtractor
+
+    attr_accessor :psarc, :opts, :unpacked
+
+    def initialize(opts)
+      @psarc = File.expand_path(opts.delete :psarc)
+      @opts  = opts
+    end
+
+    def extract!
+      UnpackedPSARC.from_psarc(psarc, opts) do |unpacked|
+
+        # Convert main track from wem to ogg:
+        CommandRunner.run! RSCustomSongToolkit.ww2ogg(unpacked.audio_track)
+        raise StandardError unless File.exist?(unpacked.ogg_track)
+
+        # Revorb it so it doesn't sound bad...
+        CommandRunner.run! RSCustomSongToolkit.revorb(unpacked.ogg_track)
+
+        FileUtils.cp unpacked.ogg_track, "output.ogg"
+      end
+    end
+  end
+end

data/lib/rsgt/cli.rb

@@ -0,0 +1,89 @@
+require "trollop"
+
+module RSGuitarTech
+  class CLI
+
+    SUB_COMMANDS = %w(extract-vocals extract-audio repack shift multipack)
+
+    TOP_BANNER = <<~STRING
+      Tool to work with RS DLC and saves
+      USAGE: rsgt [options] command [command_options]
+
+      Options for all commands:
+
+    STRING
+
+    USAGE = <<~STRING
+
+    Available command are:
+       extract-vocals: Extract a .xml of the vocals for editing
+       extract-audio:  Extract the audio track as an .ogg (ie, to use as guide track)
+       repack:         Repack altered lyrics/audio into a psarc
+       shift:          Shift a .wav by ms
+       multipack:      Repack multiple PSARCs into a single PSARC
+    STRING
+
+    def self.parse(args)
+      global_opts = Trollop::options do
+        banner TOP_BANNER
+        opt :verbose, "More output", short: "-v"
+        banner USAGE
+
+        stop_on SUB_COMMANDS
+      end
+
+      cmd = args.shift # get the subcommand
+      cmd_opts = case cmd
+      when "extract-vocals"
+        Trollop::options do
+          banner "Extracts and converts vocals into an XML"
+          opt :psarc,  "PSARC to extract",                type: :string, required: true
+          opt :output, "Optional path to output the XML", type: :string
+        end
+      when "extract-audio"
+        Trollop::options do
+          banner "Extracts and converts the audio track into an .ogg"
+          opt :psarc,  "PSARC to extract",                 type: :string, required: true
+          opt :output, "Optional path to output the .ogg", type: :string
+        end
+      when "repack"
+        Trollop::options do
+          banner "Repack a psarc with new vocals XML and/or audio tracks"
+          opt :psarc,      "PSARC to repack files into",                  type: :string,  required: true
+          opt :vocals_xml, "Vocals XML file to repack",                   type: :string
+          opt :audio,      "Audio file to repack",                        type: :string
+          opt :wwise_ver,  "WWise version to use",                        type: :string,  default: "2016.2.4.6098"
+          opt :quality,    "Quality of OGG encoding",                     type: :string,  default: "6"
+          opt :preview,    "Flag to regenerate the preview",              type: :boolean, default: false
+          opt :chorus,     "Seconds in to start the preview",             type: :string,  default: "30"
+          opt :output,     "Optional place to output the repacked psarc", type: :string
+        end
+      when "shift"
+        Trollop::options do
+          banner "Shift a .WAV file by given MS"
+          opt :wav,    "WAV file to shift",                        type: :string, required: true
+          opt :dir,    "Direction to shift (forward or backward)", type: :string, required: true
+          opt :amount, "Amount in MS",                             type: :string, required: true
+        end
+      when "multipack"
+        Trollop::options do
+          banner "Repack multiple PSARCs into a single PSARC"
+          opt :config, "Config File", type: :string, required: true
+        end
+      else
+        Trollop::educate
+      end
+
+      RSGuitarTech.verbose = true if global_opts[:verbose]
+      RSGuitarTech.verbose = true if cmd_opts[:verbose]
+
+      case cmd
+      when "extract-vocals" then VocalsExtractor.new(cmd_opts).extract!
+      when "extract-audio"  then AudioExtractor.new(cmd_opts).extract!
+      when "repack"         then Repacker.new(cmd_opts).repack!
+      when "shift"          then WavShifter.new(cmd_opts).shift!
+      when "multipack"      then Multipacker::ConfigProcessor.new(cmd_opts).process!
+      end
+    end
+  end
+end

data/lib/rsgt/command_runner.rb

@@ -0,0 +1,41 @@
+require "shellwords"
+require "open3"
+
+module RSGuitarTech
+  class CommandRunner
+
+    def self.run!(args, skip_escaping: false)
+      self.new(args, skip_escaping: skip_escaping).run!
+    end
+
+    attr_accessor :cmd
+
+    def initialize(args, skip_escaping: false)
+      if skip_escaping
+        @cmd = Array(args).join " "
+      else
+        @cmd = Shellwords.join Array(args)
+      end
+    end
+
+    def run!
+      if RSGuitarTech.verbose
+        puts "*" * 40
+        puts ""
+        puts cmd
+        puts ""
+      end
+
+      stdout, stderr, status = Open3.capture3(cmd)
+      if RSGuitarTech.verbose
+        stdout.split("\n").each do |line|
+          puts "--- #{line}"
+        end
+        stderr.split("\n").each do |line|
+          puts "!!! #{line}"
+        end
+      end
+      status
+    end
+  end
+end

data/lib/rsgt/encrypted_steam_file.rb

@@ -0,0 +1,44 @@
+module RSGuitarTech
+  class EncryptedSteamFile < BinData::Record
+    endian :little
+
+    string :evas,   read_length: 4 # Is always 'EVAS'
+    uint32 :version                # Is always 1
+    uint64 :profile                # Steam profile
+    uint32 :len
+    rest   :payload
+
+    KEY = [
+      0x72, 0x8B, 0x36, 0x9E, 0x24, 0xED, 0x01, 0x34,
+    	0x76, 0x85, 0x11, 0x02, 0x18, 0x12, 0xAF, 0xC0,
+    	0xA3, 0xC2, 0x5D, 0x02, 0x06, 0x5F, 0x16, 0x6B,
+    	0x4B, 0xCC, 0x58, 0xCD, 0x26, 0x44, 0xF2, 0x9E
+    ].pack('C*')
+
+    def decrypted
+      aes = OpenSSL::Cipher::Cipher.new 'AES-256-ECB'
+      aes.decrypt
+      aes.key     = KEY
+      aes.padding = 0
+
+      aes.update(payload) + aes.final
+    end
+
+    def encrypted
+      aes = OpenSSL::Cipher::Cipher.new 'AES-256-ECB'
+      aes.encrypt
+      aes.key     = KEY
+      aes.padding = 0
+
+      aes.update(payload) + aes.final
+    end
+
+    def uncompressed
+      Zlib::Inflate.inflate decrypted
+    end
+
+    def uncompressed_json
+      JSON.parse uncompressed.strip
+    end
+  end
+end

data/lib/rsgt/multipacker.rb

@@ -0,0 +1,114 @@
+module RSGuitarTech
+  class Multipacker
+
+    def self.process!(*args)
+      self.new(*args).process!
+    end
+
+    attr_accessor *%i{title directory unpack_dir repack_dir dest_dir filters options count}
+
+    def initialize(title:, directory:, unpack_dir:, repack_dir:, dest_dir:, filters: {}, options: {})
+      @title      = title
+      @directory  = directory
+      @unpack_dir = unpack_dir
+      @repack_dir = repack_dir
+      @dest_dir   = dest_dir
+      @filters    = filters
+      @options    = options
+      @count      = {psarcs: 0, skipped: 0, failed: 0, total: 0}
+    end
+
+    def process!
+      reset! unpack_dir if options[:reset_unpack]
+      reset! repack_dir if options[:reset_repack]
+      ensure_dir! unpack_dir
+      ensure_dir! repack_dir
+      unpack!
+      if count[:skipped] >= count[:total]
+        puts "All done! No new files found to repack"
+        return
+      end
+      repack!
+      move!
+    end
+
+    def reset!(dir)
+      shell_out "rm -rf #{dir}"
+    end
+
+    def ensure_dir!(dir)
+      shell_out "mkdir -p #{dir}/"
+    end
+
+    def unpack!
+      filtered_psarscs.each do |dlc|
+        if unpack dlc
+          count[:total] = count[:total] + 1
+        else
+          count[:failed] = count[:failed] + 1
+        end
+      end
+    end
+
+    def repack!
+      puts "Packing #{count[:total]} songs into #{repack_dir}.psarc"
+      shell_out %Q{pyrocksmith --no-crypto --pack "#{repack_dir}"}
+    end
+
+    def move!
+      packed_psarc = repack_dir.split("/").last + ".psarc"
+      puts "Moving packed psarc (#{packed_psarc}) to: #{title} - #{count[:total]} songs _m.psarc"
+      shell_out "mv #{packed_psarc} #{dest_dir}/#{title}\\ \\-\\ #{count[:total]}\\ songs\\ \\_m.psarc"
+    end
+
+  private
+
+    def unpack(dlc)
+      count[:psarcs] = count[:psarcs] + 1
+      base_name = File.basename dlc, '.*'
+
+      if Dir.exists? "#{unpack_dir}/#{base_name}"
+        puts "Skipping #{dlc} (#{base_name})"
+        count[:skipped] = count[:skipped] + 1
+        return true
+      end
+
+      puts "Unpacking #{dlc} (#{base_name})"
+
+      return false unless shell_out %Q{pyrocksmith --no-crypto --unpack "#{dlc}"}
+      return false unless shell_out %Q{mv "#{base_name}/" #{unpack_dir}/}
+      return false unless shell_out %Q{ditto "#{unpack_dir}/#{base_name}/" "#{repack_dir}"}
+
+      true
+    end
+
+    def filtered_psarscs
+      @filtered_psarscs ||= begin
+        reject_filters = Array(filters[:reject]).flatten
+        select_filters = Array(filters[:select]).flatten
+        limit          = options[:limit]
+
+        _fp = psarcs
+        _fp = _fp.take(limit) if limit
+        _fp = _fp.reject { |filename| reject_filters.include? simplfied(filename) } if reject_filters.any?
+        _fp = _fp.select { |filename| select_filters.include? simplfied(filename) } if select_filters.any?
+        _fp
+      end
+    end
+
+    def psarcs
+      @psarcs ||= Dir.glob("#{directory}/*.psarc")
+    end
+
+    def simplfied(filename)
+      filename.split("/").last.split(" _m").first
+    end
+
+    def shell_out(cmd)
+      puts cmd if options[:verbose]
+      return true if system(cmd)
+      puts "FAILED: #{cmd}"
+      false
+    end
+  end
+end