ruby_gs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 779a648e0548a042c7e9f2136d64e6fc939bf555
+  data.tar.gz: 2ed5de25d9bf99b33185bf3c86774b9cd2175577
+SHA512:
+  metadata.gz: 8b917c990ffcab122a382fee81640eefdb3291505ae4bb27ad8365699fae27ec8dcbeafdf64bc61ad3318fa986260ed7e47dfa220ace12c8fb67ce4a648dd566
+  data.tar.gz: fa2fd827df04bbfd115d45e42072d131afeb7cee5a12a696094143ce8f2ac6f29a939cbe62886e32b77068a71721e5f00c918dee124d9eecc05da812ddffcdce

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Conrad King
+
+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,57 @@
+# RubyGS
+
+RubyGS is a Ruby Gem that allows Rubyists to view and edit .sav files for the Gold, Silver, and Crystal versions of Pokemon on the Gameboy Color.
+
+These are typically files generated by a Gameboy/Gameboy Color emulator (or a physical backup device, for those of you who are more inclined) that contains the raw data acting as the SRAM on a game cartridge.
+
+##Installation
+```
+$ gem install ruby_gs
+```
+
+##Usage
+``` ruby
+require 'ruby_gs'
+
+saved_game = SaveFileReader.read "/path/to/save/file.sav" # => SaveFile containing data representing the raw SRAM of your cartridge
+
+saved_game.trainer_name = "Reich" # Note: Most fields that accept a string are limited to 10-character strings or less
+
+saved_game.rival_name = "Bugs"
+
+saved_game.team.pokemon[0].species = 25 # Change our first team pokemon's species to someone very familiar
+
+saved_game.set_team_species 0, 25 # This is an alternative to the previous line except it also updates the team menu species
+
+saved_game.team.pokemon[5].happiness = 255 # That's one happy Pokemon!
+
+saved_game.team.amount = 5 # Annnnnnd now it's gone (Not really, it's just hidden from view)
+
+hours = 78
+minutes = 33
+seconds = 12
+frames = 20
+
+saved_game.time_played = [hours, minutes, seconds, frames] # The amount of frames is not visible to the player and is rather inconsequential in general.
+
+saved_game.item_pocket[3].kind = 1 # Change the 3rd item in our Item Pocket to a Master Ball. 
+saved_game.item_pocket[3].amount = 255 # Gotta make sure we have enough for our journey.
+
+saved_game.write # This will write your changes directly to the same save file you opened initially.
+
+saved_game.write "path/to/other/save/file.sav" # This will write your changes to a different location.
+
+```
+
+##Useful Links
++ [List of item indices](http://bulbapedia.bulbagarden.net/wiki/List_of_items_by_index_number_%28Generation_II%29)
++ [List of Pokemon species indices](http://bulbapedia.bulbagarden.net/wiki/List_of_Pok%C3%A9mon_by_index_number_%28Generation_II%29)
+
+##TODO:
++ Support for Crystal.
++ Major refactoring.
++ Player Location editing.
++ Event Flag editing (and possibly documenting the purpose of each flag).
+
+
+_Special thanks to Bulbapedia for hosting the project to document G/S/C's SRAM innards._

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

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

data/bin/setup

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

data/lib/ruby_gs/save_file_reader.rb

@@ -0,0 +1,93 @@
+require "bindata" 
+require_relative "structs"
+
+module RubyGS
+
+  class SaveFileReader
+
+    def self.read(file)
+      raise "filename cannot be nil" if not file
+      SaveFile.new SaveFileGS.read(File.open(file,"r")), file, true
+    end
+
+    def self.calc_checksums(file)
+      file.pos = 0
+      content = file.read.split("").map(&:ord)
+      c1 = content[0x2009..0x2D68].reduce(&:+)
+      c2 = content[0x0C6B..0x17EC].reduce(&:+) + content[0x3D96..0x3F3F].reduce(&:+) + content[0x7E39..0x7E6C].reduce(&:+)
+      file.close
+      [c1.to_s(16),c2.to_s(16)]
+    end
+
+    def self.correct_checksums!(file)
+      file.pos = 0
+      content = file.read.split("").map(&:ord)
+      c1 = content[0x2009..0x2D68].inject(&:+)
+      c2 = content[0x0C6B..0x17EC].inject(&:+) + content[0x3D96..0x3F3F].inject(&:+) + content[0x7E39..0x7E6C].inject(&:+)
+      content[0x2D6A] = (c1 & 0xFF00) >> 8
+      content[0x2D69] = c1 & 0xFF
+      content[0x7E6E] = (c2 & 0xFF00) >> 8
+      content[0x7E6D] = c2 & 0xFF
+      file.pos = 0
+      file.write content.map(&:chr).join("")
+      file.flush
+      file
+    end
+
+  end
+
+  class SaveFile
+
+    attr_accessor :save, :gs, :filename
+    
+    def initialize save, filename, gs
+      @save, @gs, @filename = save, gs, filename
+    end
+
+    def verify_checksums
+      case gs
+      when true
+        return verify_gs_checksums
+      when false
+        return verify_c_checksums
+      end 
+    end
+
+    def write(loc = @filename)
+      @save.write(File.open(loc, "wb"))
+      verify_checksums
+    end
+
+    def set_team_species slot, species
+      return if !(0..5).include? slot
+      @save.team.pokemon[slot].species.assign species
+      @save.team.species_list[slot].assign species
+    end
+
+    def set_team_egg slot
+      return if !(0..5).include? slot
+      @save.team.species_list[slot].assign 0xFD
+    end
+
+    def hatch_team_egg slot
+      return if !(0..5).include? slot
+      @save.team.species_list[slot].assign @save.team.pokemon[slot].species
+    end
+
+    def method_missing(sym, *args, &block)
+      @save.send(sym, *args, &block)
+    end
+    
+    private
+      
+      def verify_gs_checksums
+        SaveFileReader.correct_checksums! File.open(@filename, "rb+")
+      end
+
+      def verify_c_checksums
+
+      end
+
+  end
+
+end

data/lib/ruby_gs/structs/caught_data.rb

@@ -0,0 +1,11 @@
+module RubyGS
+
+  class CaughtData < BinData::Record
+    endian :big
+    bit :time, :nbits => 2
+    bit :level, :nbits => 6
+    bit :ot_gender, :nbits => 1
+    bit :location, :nbits => 7
+  end
+
+end

data/lib/ruby_gs/structs/item_entry.rb

@@ -0,0 +1,9 @@
+module RubyGS
+
+  class ItemEntry < BinData::Record
+    endian :big
+    uint8 :kind
+    uint8 :amount
+  end
+
+end

data/lib/ruby_gs/structs/iv_data.rb

@@ -0,0 +1,11 @@
+module RubyGS
+
+  class IVData < BinData::Record
+    endian :big
+    bit4 :attack
+    bit4 :defense
+    bit4 :speed
+    bit4 :special
+  end
+  
+end

data/lib/ruby_gs/structs/name_text.rb

@@ -0,0 +1,18 @@
+require_relative "../text_gs"
+
+module RubyGS
+
+  class NameText < BinData::Primitive
+    string :val, :length => 11, :pad_byte => 'P'
+
+    def get
+      TextGS.decode self.val
+    end
+
+    def set v
+      self.val = TextGS.encode v
+    end
+
+  end
+
+end

data/lib/ruby_gs/structs/party_pokemon.rb

@@ -0,0 +1,42 @@
+require_relative "iv_data"
+require_relative "pp_data"
+require_relative "caught_data"
+
+module RubyGS
+
+  class PartyPokemon < BinData::Record
+    endian :big
+    uint8 :species
+    uint8 :held_item
+    uint8 :move_1
+    uint8 :move_2
+    uint8 :move_3
+    uint8 :move_4
+    uint16 :ot_id
+    bit :exp, :nbits => 24
+    uint16 :hp_ev
+    uint16 :attack_ev
+    uint16 :defense_ev
+    uint16 :speed_ev
+    uint16 :special_ev
+    iv_data :iv
+    pp_data :pp_1
+    pp_data :pp_2
+    pp_data :pp_3
+    pp_data :pp_4
+    uint8 :happiness
+    uint8 :pokerus
+    caught_data :caught # Crystal only; Filled with 0x0s otherwise.
+    uint8 :level
+    uint8 :status
+    uint8 :unused
+    uint16 :current_hp
+    uint16 :max_hp
+    uint16 :attack
+    uint16 :defense
+    uint16 :speed
+    uint16 :special_attack
+    uint16 :special_defense
+  end
+
+end

data/lib/ruby_gs/structs/pp_data.rb

@@ -0,0 +1,9 @@
+module RubyGS
+
+  class PPData < BinData::Record
+    endian :big
+    bit :pp_ups, :nbits => 2
+    bit :current, :nbits => 6
+  end
+
+end

data/lib/ruby_gs/structs/save_file.rb

@@ -0,0 +1,45 @@
+require_relative "team"
+require_relative "name_text"
+require_relative "item_entry"
+
+module RubyGS
+
+  class SaveFileGS < BinData::Record
+    endian :big
+    array :unused, :type => :uint8, :initial_length => 0x2000
+    array :options, :type => :uint8, :initial_length => 8
+    array :unused2, :type => :uint8, :initial_length => 1
+    uint16 :trainer_id
+    name_text :trainer_name
+    name_text :mom_name
+    name_text :rival_name
+    name_text :red_name
+    name_text :blue_name
+    #uint8 :daylight_savings
+    array :unused3, :type => :uint8, :initial_length => 0x35 - 0x24
+    array :time_played, :type => :uint8, :initial_length => 4
+    array :unused4, :type => :uint8, :initial_length => 0x14
+    uint8 :trainer_palette
+    array :unused5, :type => :uint8, :initial_length => 0x36F
+    bit :money, :nbits => 24
+    array :unused6, :type => :uint8, :initial_length => 0x8
+    array :tm_pocket, :type => :uint8, :initial_length => 57
+    uint8 :item_count
+    array :item_pocket, :type => :item_entry, :initial_length => 20
+    uint8 :key_count
+    array :key_pocket, :type => :uint8, :initial_length => 26
+    array :ball_pocket, :type => :uint8, :initial_length => 26
+    array :pc_items, :type => :uint8, :initial_length => 102
+    array :unused7, :type => :uint8, :initial_length => 0x240
+    uint8 :current_box
+    array :unused8, :type => :uint8, :initial_length => 0x2
+    array :box_names, :type => :uint8, :initial_length => 126
+    array :unused9, :type => :uint8, :initial_length => 0xE5
+    team :team
+    array :unused10, :type => :uint8, :initial_length => 0x16
+    array :dex_owned, :type => :uint8, :initial_length => 32
+    array :dex_seen, :type => :uint8, :initial_length => 32
+    array :footer, :type => :uint8, :initial_length =>  0x559F
+  end
+
+end

data/lib/ruby_gs/structs/team.rb

@@ -0,0 +1,16 @@
+require_relative "name_text"
+require_relative "party_pokemon"
+
+module RubyGS
+
+  class Team < BinData::Record
+    endian :big
+    uint8 :unused
+    uint8 :amount
+    array :species_list, :type => :uint8, :initial_length => 7
+    array :pokemon, :type => :party_pokemon, :initial_length => 6
+    array :ot_name, :type => :name_text, :initial_length => 6
+    array :name, :type => :name_text, :initial_length => 6
+  end
+
+end

data/lib/ruby_gs/structs.rb

@@ -0,0 +1,10 @@
+require_relative "./structs/save_file"
+require_relative "./structs/team"
+require_relative "./structs/party_pokemon"
+require_relative "./structs/item_entry"
+require_relative "./structs/name_text"
+require_relative "./structs/pp_data"
+require_relative "./structs/iv_data"
+require_relative "./structs/caught_data"
+
+

data/lib/ruby_gs/text_gs.rb

@@ -0,0 +1,48 @@
+module RubyGS
+
+  class TextGS
+
+    def self.encode text
+      text.chars.map { |c| text_table[c] ? text_table[c].chr : c }.join
+    end
+
+    def self.decode text
+      text.chars.map { |c| text_table.key(c.ord) ? text_table.key(c.ord) : "" }.join
+    end
+
+    private
+    
+      def self.text_table
+        {
+         "A" => 0x80, "B" => 0x81, "C" => 0x82,
+         "D" => 0x83, "E" => 0x84, "F" => 0x85,
+         "G" => 0x86, "H" => 0x87, "I" => 0x88, 
+         "J" => 0x89, "K" => 0x8A, "L" => 0x8B,
+         "M" => 0x8C, "N" => 0x8D, "O" => 0x8E,
+         "P" => 0x8F, "Q" => 0x90, "R" => 0x91, 
+         "S" => 0x92, "T" => 0x93, "U" => 0x94,  
+         "V" => 0x95, "W" => 0x96, "X" => 0x97,
+         "Y" => 0x98, "Z" => 0x99,  
+
+         "a" => 0xA0, "b" => 0xA1, "c" => 0xA2,
+         "d" => 0xA3, "e" => 0xA4, "f" => 0xA5,
+         "g" => 0xA6, "h" => 0xA7, "i" => 0xA8, 
+         "j" => 0xA9, "k" => 0xAA, "l" => 0xAB,
+         "m" => 0xAC, "n" => 0xAD, "o" => 0xAE,
+         "p" => 0xAF, "q" => 0xB0, "r" => 0xB1, 
+         "s" => 0xB2, "t" => 0xB3, "u" => 0xB4,  
+         "v" => 0xB5, "w" => 0xB6, "x" => 0xB7,
+         "y" => 0xB8, "z" => 0xB9, 
+         
+         " " => 0xBA, "." => 0xE8,
+
+         "0" => 0xF6,"1" => 0xF7,"2" => 0xF8,
+         "3" => 0xF9,"4" => 0xFA,"5" => 0xFB,
+         "6" => 0xFC,"7" => 0xFD,"8" => 0xFE,
+         "9" => 0xFF
+        }
+      end
+
+  end
+
+end

data/lib/ruby_gs/version.rb

@@ -0,0 +1,3 @@
+module RubyGS
+  VERSION = "0.1.0"
+end

data/lib/ruby_gs.rb

@@ -0,0 +1,2 @@
+require "ruby_gs/version"
+require "ruby_gs/save_file_reader"

data/ruby_gs.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_gs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_gs"
+  spec.version       = RubyGS::VERSION
+  spec.authors       = ["Conrad King"]
+  spec.email         = ["rainbowryke@gmail.com"]
+
+  spec.summary       = %q{Allows viewing and editing of Pokemon G/S/C save files.}
+  spec.description   = %q{RubyGS is a Ruby Gem that provides a simple interface to view and edit the data inside of a save file for the Gameboy Color games Pokemon Gold, Silver, and Crystal versions.}
+  spec.homepage      = "https://github.com/RainbowReich/ruby_gs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bindata", "~> 2.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: ruby_gs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Conrad King
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+description: RubyGS is a Ruby Gem that provides a simple interface to view and edit
+  the data inside of a save file for the Gameboy Color games Pokemon Gold, Silver,
+  and Crystal versions.
+email:
+- rainbowryke@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby_gs.rb
+- lib/ruby_gs/save_file_reader.rb
+- lib/ruby_gs/structs.rb
+- lib/ruby_gs/structs/.caught_data.rb.swp
+- lib/ruby_gs/structs/.item_entry.rb.swp
+- lib/ruby_gs/structs/.iv_data.rb.swp
+- lib/ruby_gs/structs/.name_text.rb.swp
+- lib/ruby_gs/structs/.party_pokemon.rb.swp
+- lib/ruby_gs/structs/.pp_data.rb.swp
+- lib/ruby_gs/structs/.save_file.rb.swp
+- lib/ruby_gs/structs/.team.rb.swp
+- lib/ruby_gs/structs/caught_data.rb
+- lib/ruby_gs/structs/item_entry.rb
+- lib/ruby_gs/structs/iv_data.rb
+- lib/ruby_gs/structs/name_text.rb
+- lib/ruby_gs/structs/party_pokemon.rb
+- lib/ruby_gs/structs/pp_data.rb
+- lib/ruby_gs/structs/save_file.rb
+- lib/ruby_gs/structs/team.rb
+- lib/ruby_gs/text_gs.rb
+- lib/ruby_gs/version.rb
+- ruby_gs.gemspec
+homepage: https://github.com/RainbowReich/ruby_gs
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Allows viewing and editing of Pokemon G/S/C save files.
+test_files: []