Update getting started guide

docs/getting-started.md

@@ -21,7 +21,7 @@ Now that it's extracted, you can double click the "Wind Waker Randomizer" progra
 !!! note
     Don't try to run the randomizer while it's still inside of the .zip. You will get an error.
 
-## Using the Randomizer
+## Configuring
 
 Once you've launched the randomizer program, you will need to select your vanilla Wind Waker ISO mentioned at the start. Click "Browse" to the right of `Vanilla Wind Waker ISO` and select the correct file - it usually ends in the .iso extension.
 
@@ -31,8 +31,13 @@ The next step is to tell the randomizer where this new randomized ISO should be
 
 You might want to customize which settings are selected before randomizing, but you can also just leave the default settings on, as those tend to be good for first time players.
 
-Now you can randomize the game! To do this, click the "Randomize" button at the very bottom right of the program and wait a minute.
+## Randomizing
+
+Now you can randomize the game! To do this, click the "Randomize" button at the very bottom right of the program and wait a minute.  
 Once it's done, you can find the new randomized ISO in the `Randomized Output Folder` you picked earlier. You can play this ISO with Dolphin or Nintendont just like a regular GameCube ISO.
 
-That's it, have fun!  
-If you run into any issues, check out the [Frequently Asked Questions](faq.md) page.
+That's it, you can start playing now!  
+
+You may want to check out the [Useful Links](useful-links.md) page for a list of tools, guides, and mods that can optionally be used with the randomizer.  
+
+And if you run into any issues during your playthrough, head over to the [Frequently Asked Questions](faq.md) page.  

wwlib/stage_searcher.py

@@ -21,7 +21,7 @@ def try_int_convert(string):
 def split_string_for_natural_sort(string):
   return [try_int_convert(c) for c in re.split("([0-9]+)", string)]
 
-def each_stage_and_room(self, exclude_stages=False, exclude_rooms=False, stage_name_to_limit_to=None, exclude_unused=True):
+def each_stage_and_room(self, exclude_stages=False, exclude_rooms=False, stage_name_to_limit_to=None, exclude_unused=True) -> list[tuple[DZx, str]]:
   all_filenames = list(self.gcm.files_by_path.keys())
 
   # Sort the file names for determinism. And use natural sorting so the room numbers are in order.
@@ -67,10 +67,10 @@ def each_stage_and_room(self, exclude_stages=False, exclude_rooms=False, stage_n
       continue
     yield(dzr, room_arc_path)
 
-def each_stage(self, exclude_unused=True):
+def each_stage(self, exclude_unused=True) -> list[tuple[DZx, str]]:
   return each_stage_and_room(self, exclude_rooms=True, exclude_unused=exclude_unused)
 
-def each_room(self, exclude_unused=True):
+def each_room(self, exclude_unused=True) -> list[tuple[DZx, str]]:
   return each_stage_and_room(self, exclude_stages=True, exclude_unused=exclude_unused)
 
 def each_stage_with_rooms(self, exclude_unused=True) -> Iterable[tuple[DZx, str, list[tuple[DZx, str]]]]:
@@ -1104,3 +1104,10 @@ def print_all_stage_types(self):
       stage_names = stages_by_type[stage_type]
       for stage_name in stage_names:
         f.write(f"  {stage_name}\n")
+
+def print_all_filis(self):
+  for dzr, room_arc_path in each_room(self, exclude_unused=False):
+    fili = dzr.entries_by_type(FILI)[0]
+    if fili.params & 1 == 0:
+      continue
+    print(f"{fili.params:08X} {room_arc_path}")

wwrando.py

@@ -193,6 +193,7 @@ def run_no_ui(args):
     # stage_searcher.search_all_bmds(rando)
     # stage_searcher.print_all_actor_listids(rando)
     # stage_searcher.search_all_dzbs(rando)
+    # stage_searcher.print_all_filis(rando)
   else:
     rando = WWRandomizer(**rando_kwargs)
     try: