Every fork in one clean pull request

.gitignore

@@ -0,0 +1,9 @@
+*.pyc
+*.swp
+build/
+dist/*
+.vscode/
+dev_tools/
+__pycache__
+.idea
+random-seed-*

README.md

@@ -1,6 +1,6 @@
 # Dark Souls Item Randomizer
 
-Instructions:
+**Instructions:**
 
 * (PTDE Only) Unpack your Dark Souls archive files using UnpackDarkSoulsForModding, which can be found [here](https://github.com/HotPocketRemix/UnpackDarkSoulsForModding).
 * Download `DarkSoulsItemRandomizer.exe`, and place it in your Dark Souls directory, where DARKSOULS.exe (PTDE) or DarkSoulsRemastered.exe (DS1R) are.
@@ -9,8 +9,15 @@ configuration to `GameParam.parambnd` or `GameParam.parambnd.dcx`, depending on
 A directory with the current date/time stamp will be created containing information about the item distribution, including a cheatsheet.
 * If you want to inspect a certain item distribution, but not modify the actual game files, you can instead input a seed and click the "Write Seed Info" button
 to generate the same type of folder as above, without modifying the current item distribution. Note that you *must* input a seed for this to work.
+* Having 'Save Settings To Default' will write settings to INI file when Export button is pressed.
+* To share settings and seeds with others, right click and choose 'Copy settings to Sync'.  A seed/settings string will be generated and placed in your clipboard, use paste (CTRL-V) to paste that string in chat, Discord, e-mails, etc.
+* To load settings shared with others, copy to the clipboard (CTRL+C) the seed/settings strings shared with you and then right click in the and coose 'Paste settings sync'.
 
-To restore the default item distribution:
+*To restore the default item distribution automatically:*
+
+* Press the 'Revert to vanilla' button
+
+*To restore the default item distribution manually:*
 
 * Check that `GameParam.parambnd[.dcx].bak` exists in `\param\GameParam`.
 * Delete `GameParam.parambnd[.dcx]` from `\param\GameParam`.
@@ -56,10 +63,17 @@ Fashion Souls: If active, the many armor sets in game are split up, and each pie
 Laundromat Mixup: If active, most human NPCs will wear random armor instead of their usual sets. If Fashion Souls is not active, NPCs will wear randomly chosen full sets of armor. 
 If Fashion Souls is active, NPCs will wear independently chosen random pieces of armor.
 
-Senile Gwynevere: If active, the Lordvessel will be shuffled like other key items, and Gwynevere will give the player a different item in place of the Lordvessel. Not compatible with not shuffling keys.
+Lordvessel Randomized: If active, the Lordvessel will be shuffled like other key items, and Gwynevere will give the player a different item in place of the Lordvessel. Not compatible with not shuffling keys.
+
+Lordvessel @ Firelink: If active, the Lordvessel will always be in Firelink Shrine.  This can drastically cut down game time length.  Not compatible with not shuffling keys.
 
 Senile Primordial Serpents: If active, the four Lord Souls will be shuffled like other key items. Not compatible with not shuffling keys.
 
+Eager Smiths: If active, weapons capable of upgrading along the various ember paths (Chaos, Magic, Divine, etc.) have a 25% chance of dropping as a +0 version of one of these paths. A bit of an easier setting, but will allow for more diversity of viable weapons across playthroughs.
+
+No DLC: If active, key items will NOT be in Painted World or Artorias of the Abyss DLC locations.  Also keys needed for those areas will not be placed outside of these areas, to prevent you from getting keys in sections that aren't needed.
+
+Seek Guidance Help: If active, useful hints replace the dev messages that appear when using the Seek Guidance miracle.  Petrus at the Firelink Shrine has the Seek Guidance miracle and a talisman for sale. 
 
 **Race Mode Possible Key Locations**:
 
@@ -264,6 +278,8 @@ Senile Primordial Serpents: If active, the four Lord Souls will be shuffled like
       1700050: The Duke's Archives Chest #2
               (In the room with broken machinery; a fog gate nearby leads to the 
                outside grounds and Crystal Cave. Normally holds Prism Stone x20.)
+      1700200: The Duke's Archives - Big Hat Logan's cell
+              (Requires Archive Tower Giant Cell Key to open.)
       1700210: The Duke's Archives - Archive Prison Extra Key Original Location
               (In a side cell in the Prison. The cell's door can be opened using the
                Archive Tower Cell Key, which is always dropped by the sleeping Serpent
@@ -349,3 +365,56 @@ Senile Primordial Serpents: If active, the four Lord Souls will be shuffled like
     - Force Quit Wrong Warp is *not* generally required, but may be
        useful to escape from certain softlocks and avoid the need for
        some keys.
+
+**Seek Guidance help:**
+
+Don't forget that Petrus at the Firelink Shrine has the Seek Guidance miracle and a talisman for sale. 
+
+*The hint rules are as follows:*
+
+take 2 of the big key hints and put them in twice (4 slots)  
+take 6 of the key hints, and put them in twice (12 slots, 16 total)  
+take 4 of the useful items, put them in (4 slots, 20 total)  
+take 6 of the useful locations, put them in (6 slots, 26 total)  
+take 3 trash hints, shuffle them in twice (6 slots, 32 total)  
+
+*Hint Locations:*
+
+Area|Original Text|Location|
+---|---|---|
+Undead Asylum|"Exchange"|Near Snuggly, in the large bird nest to the right as you exit the Asylum.|
+Firelink Shrine|"Path ahead"|Drop off point from the elevator, before the path to the egg-nest above the old shrine.|
+Firelink Shrine|"Here!"|At the base of the flying buttress, reached by jumping/rolling, on the path to the egg-nest.|
+Undead Burg|"Imminent Merchant"|Under the aqueduct, in front of Domhall of Zena once he relocates there from the Depths.|
+Undead Burg|"Imminent drake..."|At the start of the Hellkite bridge, beside basement door.|
+Undead Burg|"Jumping off ahead"|Before barrels where two Hollows hanging from railing climb up to ambush.|
+Undead Burg|"Prisoner ahead"|In front of the house where Griggs of Vinheim is trapped in Lower Undead Burg.|
+Undead Parish|"Prisoner ahead"|Inside Undead Church, in the upper doorway towards Lautrec's cell.|
+Undead Parish|"Blacksmith ahead"|On the start of the bridge towards the old church, where Andre of Astora is located.|
+Darkroot Garden|"Follow the shining flowers"|Right outside the exit from the old church, before entering the garden.|
+Darkroot Garden|"Are the trees moving?"|Past the first living/killable tree on the right side of the Moonlight Butterfly area.|
+Depths|"I can't take this"|Inside the bonfire chamber.|
+Depths|"Try sliding down"|In Giant Rat chamber, on far left side next to top of waterfall.|
+Depths|"Imminent shortcut"|Before the shortcut.|
+Depths|"Weakness: Head"|In Gaping Dragon boss area, near pillars on left side.|
+Blighttown|"Path Ahead"|Near first bonfire, on approach to nearby fire hounds.|
+Quelaag's Domain|"Illusory Wall"|Just before illusory wall leading to Chaos Servant covenant, below Second Bell of Awakening.|
+The Catacombs|"Try divine"|Right below the first ladder in the Catacombs.|
+The Catacombs|"Treasure"|Near weak looking and breakable brick wall.|
+The Catacombs|"Blacksmith ahead"|In the wheel skeleton pit, right outside the entrance to Vamos.|
+The Catacombs|"Liar"|Near Patches at his bridge turning switch location.|
+The Catacombs|"Up"|At the base of the ladder, along the path from the tomb where the Darkmoon Seance Ring is found.|
+The Catacombs|"Shortcut ahead"|Right after Pinwheel, on the route to the drop leading back to the Catacombs|
+New Londo Ruins|"Need Curses"|Right before the rickety bridge that leads to the old city.|
+New Londo Ruins|"Imminent jumping off ..."|At bottom of broken stairs, outside building holding Sealer.|
+New Londo Ruins|"Need Covenant"|Outcrop at bottom of staircase leading to Abyss/Four Kings.|
+Sen's Fortress|"Prisoner ahead"|In front of breakable wall where Big Hat Logan is kept.|
+Anor Londo|"Path ahead"|At the base of the flying buttress leading to the upper floor of the church with the painting.|
+Anor Londo|"Try Projectile"|Right inside the door in the Chamber of the Princess.|
+Valley of Drakes|"Ring Ahead"|Before the bridge with the wyverns, approaching from the Darkroot elevator.|
+Demon Ruins|"Safe Zone Ahead"|In Centipede Demon room, to the right on approach to patch of ground out of the lava.|
+Crystal Cave|"Path Ahead"|On the first invisible bridge.|
+
+**For Developers:**
+
+Generating executable: `pyinstaller randomizer_gui.py --onefile -i favicon.ico --add-data "favicon.gif;." --noconsole --name "DarkSoulsItemRandomizer"`

chr_init_param.py

@@ -1,6 +1,9 @@
 import struct
 import sys
 
+import chr_setup as chr_s
+import item_lot_formatter as item_lf
+
 def extract_shift_jisz(content, offset):
     extracted = b''
     while content[offset:offset+1] != b'\x00':
@@ -212,6 +215,25 @@ def find_chr_by_id(self, chr_id):
             if chr_init.chr_init_id == chr_id:
                 return chr_init
         return None
+
+    def return_cheatsheet(self):
+        ret = ""
+        attrs_to_print = ['spell_1', 'spell_2', 'spell_3', 'spell_4', 'spell_5', 'spell_6', 'spell_7', 
+                          'arrow_1', 'arrow_2', 'bolt_1', 'bolt_2',
+                          'item_1', 'item_2', 'item_3', 'item_4', 'item_5', 'item_6', 'item_7', 'item_8', 'item_9', 'item_10',
+                          'ring_1', 'ring_2', 'ring_3', 'ring_4', 'ring_5']
+        for class_name in chr_s.CLASS_TO_CHR_INIT:
+            (_, start_class_init_id) = chr_s.CLASS_TO_CHR_INIT[class_name]
+            ret += class_name.title() + " starting items:\n\t"
+            chr = self.find_chr_by_id(start_class_init_id)
+            for attr_to_print in attrs_to_print:
+                attr_id = getattr(chr, attr_to_print)
+                attr_value = "None"
+                if attr_id > 0:
+                    attr_value = item_lf.ITEMS[attr_id]
+                ret += attr_to_print + ":'" + attr_value +"' "
+            ret += "\n"
+        return ret
 
     def export_as_binary(self):
         num_of_records = len(self.chr_inits)