ruby_gs 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0da9e8c8ef97844c3eaecfca69c85fe1e0d953fc
-  data.tar.gz: 81989859170a74f0c87f5c2fa869b888504a425f
+  metadata.gz: 86a1e014deb81957ade947e6c0e4e92fbb61ece9
+  data.tar.gz: 034dc05e5066e440ea4c40b2536807a3d915f8d5
 SHA512:
-  metadata.gz: 42f4bb0288199f232d25a50d5a78818321cc3689ba33f301de98c2f064db30befbc99b9876ec64437b69aaf2e6fa74a159913329ba9296e476bac6242a032ae1
-  data.tar.gz: 5f818eab58cec5f4926262015351143a1a3f9c96446540d0b527025a3bb18b3d4425a62ef2e5a132f1d150a8583da70cbe4413c072525df8779b2929dcf1febe
+  metadata.gz: 0c1e4c3ad975fdd15928f17f1d9330fde3d626e53ab8e11b91b6b5d3273151ce9a36301ddb7da8268dd0a961578031fec2399c2eeb656a493f3cd48df2253b6f
+  data.tar.gz: 560afb309a8d9f174a043eb78448ea3416821c22cc9a594968a08540e12154ed4598152c5107d14cfe42a4342777eb461339d5774bbec03b2f376dcab3f2146b

data/README.md

@@ -35,6 +35,7 @@ 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.
@@ -49,7 +50,7 @@ saved_game.write "path/to/other/save/file.sav" # This will write your changes to
 
 ##TODO:
 + Support for Crystal.
-+ Major refactoring.
++ ~~Major refactoring.~~
 + Player Location editing.
 + Event Flag editing (and possibly documenting the purpose of each flag).
 

data/lib/ruby_gs.rb

@@ -1,2 +1,8 @@
 require "ruby_gs/version"
 require "ruby_gs/save_file_reader"
+
+##
+# Contains all of the structures and classes necessary for viewing and editing Pokemon Gold/Silver/Crystal save files.
+module RubyGS
+
+end

data/lib/ruby_gs/save_file_reader.rb

@@ -5,12 +5,18 @@ module RubyGS
 
   class SaveFileReader
 
+
+    ##
+    # Reads a .sav file and builds a SaveFile object from its data.
     def self.read(file)
       raise "filename cannot be nil" if not file
       SaveFile.new SaveFileGS.read(File.open(file,"r")), file, true # TODO: Detect whether save belongs to Gold/Silver or Crystal
     end
 
+    ##
+	# DEPRECATED: Calculates the checksum values for both regions within a save file.
     def self.calc_checksums(file)
+      warn "[DEPRECATION] SaveFileReader::calc_checksums is deprecated. Please use SaveFileReader::correct_checksums! instead."
       file.pos = 0
       content = file.read.split("").map(&:ord)
       c1 = content[0x2009..0x2D68].reduce(&:+)
@@ -19,6 +25,8 @@ module RubyGS
       [c1.to_s(16),c2.to_s(16)]
     end
 
+	##
+	# Calculates the checksum values within a save file and writes them to the save file.
     def self.correct_checksums!(file)
       file.pos = 0
       content = file.read.split("").map(&:ord)
@@ -36,9 +44,18 @@ module RubyGS
 
   end
 
+  ##
+  # Represents a Gold/Silver/Crystal save file.
+  #
+  # @gs is set to true if the save file is from Gold/Silver and false otherwise.
+  #
+  # @filename is a string of the filename that the save file was originally read from.
+  #
+  # @save is the structure containing the save file's data and is delegated to SaveFile.
   class SaveFile
 
-    attr_accessor :save, :gs, :filename
+	attr_accessor :save
+    attr_reader  :gs, :filename
     
     def initialize save, filename, gs
       @save, @gs, @filename = save, gs, filename
@@ -53,27 +70,37 @@ module RubyGS
       end 
     end
 
+	##
+	# Writes the save structure to file.
+	#
+	# If loc is not provided, it will write directly to the original file.
     def write(loc = @filename)
       @save.write(File.open(loc, "wb"))
       verify_checksums
     end
 
+	##
+	# A convenience method for setting the species of a PartyPokemon in its structure and in the Team species_list.
     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
 
+    ##
+	# A convenience method for turning a PartyPokemon into an Egg and setting the steps required to hatch it.
     def set_team_egg slot, egg_cycles
       raise "slot index must be between 0 and 5, inclusive" if !(0..5).include? slot
       @save.team.species_list[slot] = 0xFD
-	  @save.team.pokemon[slot].happiness = egg_cycles
+      @save.team.pokemon[slot].happiness = egg_cycles
     end
 
+	##
+	# A convenience method for turning an Egg into a Pokemon.
     def hatch_team_egg slot
       raise "slot index must be between 0 and 5, inclusive" if !(0..5).include? slot
       @save.team.species_list[slot].assign  @save.team.pokemon[slot].species
-	  @save.team.pokemon[slot].happiness = 20
+      @save.team.pokemon[slot].happiness = 20
     end
 
     def method_missing(sym, *args, &block)

data/lib/ruby_gs/structs/box_name.rb

@@ -0,0 +1,23 @@
+require_relative "../text_gs"
+
+module RubyGS
+
+  ##
+  # A String representing the name of a PC Box.
+  #
+  # It can only contain 8 visible characters, the 9th being a terminator.
+  # 
+  class BoxName < BinData::Primitive
+    string :val, :length => 9, :pad_byte => 'P'
+
+    def get
+      TextGS.decode self.val[0..7]
+    end
+
+    def set value
+      self.val = TextGS.encode value
+    end
+
+  end
+
+end

data/lib/ruby_gs/structs/party_pokemon.rb

@@ -4,6 +4,12 @@ require_relative "caught_data"
 
 module RubyGS
 
+  ##
+  # Represents a Pokemon within your current party.
+  #
+  # Contains 16 more bytes of data pertaining to combat stats than a PC Pokemon structure.
+  # These are recalculated upon withdrawal from the PC.
+  #
   class PartyPokemon < BinData::Record
     endian :big
     uint8 :species

data/lib/ruby_gs/structs/pc_box.rb

@@ -0,0 +1,22 @@
+require_relative "name_text"
+require_relative "pc_pokemon"
+
+module RubyGS
+
+  ##
+  # Represents a Pokemon Box inside of the PC.
+  #
+  # It has an identical structure to the Team structure, but is much longer in length. 
+  # 
+  class PCBox < BinData::Record
+    endian :big
+	uint8 :unused
+    uint8 :amount
+    array :species_list, :type => :uint8, :initial_length => 21
+    array :pokemon, :type => :pc_pokemon, :initial_length => 20
+    array :ot_name, :type => :name_text, :initial_length => 20
+    array :name, :type => :name_text, :initial_length => 20
+	uint8 :unused2
+  end
+
+end

data/lib/ruby_gs/structs/pc_pokemon.rb

@@ -0,0 +1,38 @@
+require_relative "iv_data"
+require_relative "pp_data"
+require_relative "caught_data"
+
+module RubyGS
+
+  ##
+  # Represents the data describing a Pokemon stored within a PC Box.
+  # 
+  # This is a stripped down version of the PartyPokemon structure as it lacks data on current combat stats.
+  # 
+  class PCPokemon < 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 0s otherwise.
+	uint8 :level
+  end
+
+end

data/lib/ruby_gs/structs/pokedex_data.rb

@@ -0,0 +1,37 @@
+
+
+module RubyGS
+
+  ##
+  # Represents a Pokemon who has been seen or caught.
+  FOUND = 1
+  ##
+  # Represents a Pokemon who has not yet been seen or caught.
+  NOT_FOUND = 0
+
+  class PokedexArray < BinData::Array
+    
+	def [] i
+	  return @element_list[real_index(i)].snapshot 
+	end
+
+	def []= i, v
+      @element_list[real_index(i)].assign v
+	end 
+
+    private
+
+		def real_index n
+		  return n if n % 8 == 0
+		  ((n / 8).floor+2)*8 - (n % 8)
+		end
+
+  end
+
+  class PokedexData < BinData::Record
+    endian :big
+    pokedex_array :species, :type => :bit1, :initial_length => 251 
+    array :unknown, :type => :bit1, :initial_length => 5
+  end
+
+end

data/lib/ruby_gs/structs/save_file.rb

@@ -1,9 +1,15 @@
 require_relative "team"
+require_relative "pc_box"
 require_relative "name_text"
+require_relative "box_name"
 require_relative "item_entry"
+require_relative "pokedex_data"
 
 module RubyGS
 
+  ##
+  # Represents the structure and data of a Gold/Silver Pokemon cartridge SRAM 
+  # 
   class SaveFileGS < BinData::Record
     endian :big
     array :unused, :type => :uint8, :initial_length => 0x2000
@@ -31,15 +37,19 @@ module RubyGS
     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
+    uint8 :current_box_index
+    array :unused8, :type => :uint8, :initial_length => 0x3
+    array :box_names, :type => :box_name, :initial_length => 14
+    array :unused9, :type => :uint8, :initial_length => 0xE4
     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
+    array :unused10, :type => :uint8, :initial_length => 0x15
+    pokedex_data :dex_owned
+    pokedex_data :dex_seen
+	array :unused11, :type => :uint8, :initial_length => 0x2E0
+	pc_box :current_box
+	array :unused12, :type => :uint8, :initial_length => 0xE44
+	array :pc_box, :type => :pc_box, :initial_length => 14
+	rest :rest
   end
 
 end

data/lib/ruby_gs/structs/team.rb

@@ -3,6 +3,12 @@ require_relative "party_pokemon"
 
 module RubyGS
 
+  ##
+  # Represents your party of Pokemon.
+  #
+  # Note that the species, nickname, and original trainer name of each Pokemon is stored separately
+  # from their respective structures, instead being stored directly within the Team structure.
+  #
   class Team < BinData::Record
     endian :big
     uint8 :unused

data/lib/ruby_gs/version.rb

@@ -1,3 +1,3 @@
 module RubyGS
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_gs
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Conrad King
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-06 00:00:00.000000000 Z
+date: 2015-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -73,11 +73,15 @@ files:
 - lib/ruby_gs.rb
 - lib/ruby_gs/save_file_reader.rb
 - lib/ruby_gs/structs.rb
+- lib/ruby_gs/structs/box_name.rb
 - 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/pc_box.rb
+- lib/ruby_gs/structs/pc_pokemon.rb
+- lib/ruby_gs/structs/pokedex_data.rb
 - lib/ruby_gs/structs/pp_data.rb
 - lib/ruby_gs/structs/save_file.rb
 - lib/ruby_gs/structs/team.rb