Create docs for super mario galaxy

.gitignore

@@ -7,6 +7,7 @@
 *.apm3
 *.apmc
 *.apz5
+*.apg
 *.pyc
 *.pyd
 *.sfc
@@ -17,6 +18,7 @@
 *.gb
 *.gbc
 *.gba
+*.iso
 *.wixobj
 *.lck
 *.db3

Patch.py

@@ -1,3 +1,5 @@
+
+
 from __future__ import annotations
 
 import os

README.md

@@ -33,6 +33,8 @@ Currently, the following games are supported:
 * Hylics 2
 * Overcooked! 2
 * Zillion
+* Super Mario Galaxy
+
 
 For setup and instructions check out our [tutorials page](https://archipelago.gg/tutorial/).
 Downloads can be found at [Releases](https://github.com/ArchipelagoMW/Archipelago/releases), including compiled

worlds/smgalaxy/Options.py

@@ -0,0 +1,26 @@
+from typing import TypedDict
+from Options import Choice, Range
+
+# this defines the enable_purple_coin_stars setting 
+class EnablePurpleCoinStars(Choice):
+    """tuning this off we allow purple coin stars to count as checks do note all purple coin stars are postgame only but one."""
+    display_name = "Enable Purple Coin Stars"
+    option_main_game_only = 0
+    option_all = 1
+    option_none = 2
+
+# this allows players to pick their own star count to finish the game. 
+class StarstoFinish(Range):
+    "This will set the number of stars required to reach the center of the universe."
+    display_name = "Stars_to_finish"
+    range_start = 25
+    range_end = 99
+    default = 60
+
+# this defines all the options.
+galaxy_options = {
+    "enable_purple_coin_stars": EnablePurpleCoinStars,
+    "Stars_to_finish": StarstoFinish,
+}
+
+

worlds/smgalaxy/Regions.py

@@ -0,0 +1,152 @@
+import imp
+import typing
+from .Options import smg_options, EnablePurpleCoinStars
+from BaseClasses import Region, Location, RegionType, Entrance, MultiWorld  
+from .locations import SMGLocation, location_table,locHH_table,locGE_table, \
+                                                   locSJ_table,locBR_table,locBB_table, \
+                                                   locGG_table,locFF_table,locDD_table,locDDune_table, \
+                                                   locGL_table,locSS_table,locTT_table, \
+                                                   locDN_table,locMM_table, \
+                                                   locHL_table,locbosses_table,locspecialstages_table
+
+
+def create_regions(player: int, world: MultiWorld, regions: dict):
+    #defines the commet obserbatory
+    regspecialstages = Region("Menu", RegionType.Generic, "Ship", player, world)
+    locspecialstages_names = [name for name, id in locspecialstages_table.items()]
+    locspecialstages_names = [name for name, id in locHL_table.items()]
+    locspecialstages_names = [name for name, id in locbosses_table.items()]
+    regspecialstages.locations += [SMGLocation(player, loc_name, location_table[loc_name], regspecialstages) for loc_name in locspecialstages_names]
+    #if world.enable_purple_coin_stars[player] == EnablePurpleCoinStars.option_main_game_only:
+ #       regspecialstages.locations.append(SMGLocation)(player, "GG: Gateway's Purple coins", location_table["GG: Gateway's Purple coins"], regspecialstages)
+    world.regions.append(regspecialstages)
+    # defines the good egg galaxy region
+    regGE = Region("Good Egg", player, world)
+    locGE_names = [name for name, id in locGE_table.items()]
+    regGE.locations += [SMGLocation(player, loc_name, location_table[loc_name], regGE) for loc_name in locGE_names]
+    if world.enable_purple_coin_stars[player].value == 1:
+        regGE.locations.append(SMGLocation)(player, "GE: Purple Coin Omelet", location_table["GE: Purple Coin Omelet"], regGE)
+    world.regions.append(regGE)    
+    # defines the honeyhive galaxey region
+    regHH = Region("Honeyhive", player, world)
+    locHH_names = [name for name, id in locHH_table.items()]
+    regHH.locations += [SMGLocation(player, loc_name, location_table[loc_name], regHH) for loc_name in locHH_names]
+    if world.enable_purple_coin_stars[self.player].value == 1:
+        regHH.locations.append(SMGLocation)(player, "GE: The Honeyhive's Purple Coins", location_table["HH: The Honeyhive's Purple Coins"], regHH)
+    world.regions.append(regHH)    
+    # defines the Space Junk galaxy region
+    regSJ = Region("Space Junk", player, world)
+    locSJ_names = [name for name, id in locSJ_table.items()]
+    regSJ.locations += [SMGLocation(player, loc_name, location_table[loc_name], regSJ) for loc_name in locSJ_names]
+    if world.enable_purple_coin_stars[self.player].value == 1:
+        regHH.locations.append(SMGLocation)(player, "SJ: Purple Coin Spacewalk", location_table["SJ: Purple Coin Spacewalk"], regSJ)
+    world.regions.append(regSJ)  
+    # defines the Battlerock galaxy
+    regBR = Region("Battlerock", player, world)
+    locBR_names = [name for name, id in locBR_table.items()]
+    regBR.locations += [SMGLocation(player, loc_name, location_table[loc_name], regBR) for loc_name in locBR_names]
+    if world.enable_purple_coin_stars[self.player].value == 1:
+        regBR.locations.append(SMGLocation)(player, "BR: Purple Coins on the Battlerock", location_table["BR: Purple Coins on the Battlerock"], regBR) 
+    world.regions.append(regBR)     
+    # defines the Beach Bowl galaxy
+    regBB = Region("Beach Bowl", player, world)
+    locBB_names = [name for name, id in locBB_table.items()]
+    regBB.locations += [SMGLocation(player, loc_name, location_table[loc_name], regBB) for loc_name in locBB_names]
+    if world.enable_purple_coin_stars[self.player].value == 1:
+        regBB.locations.append(SMGLocation)(player, "BB: Beachcombing for Purple Coins", location_table["BB: Beachcombing for Purple Coins"], regBB)    
+    world.regions.append(regBB)  
+    # define Ghostly galaxy
+    regG = Region("Ghostly", player, world)
+    locG_names = [name for name, id in locGG_table.items()]
+    regG.locations += [SMGLocation(player, loc_name, location_table[loc_name], regG) for loc_name in locG_names]
+    if world.enable_purple_coin_stars[self.player].value == 1:
+        regG.locations.append(SMGLocation)(player, "G: Purple Coins in the Bone Pen", location_table["G: Purple Coins in the Bone Pen"], regG)    
+    world.regions.append(regG)  
+    # defines the Gusty Gardens galaxy 
+    regGG = Region("Gusty Gardens", player, world)
+    locGG_names = [name for name, id in locGG_table.items()]
+    regGG.locations += [SMGLocation(player, loc_name, location_table[loc_name], regGG) for loc_name in locGG_names]
+    if world.enable_purple_coin_stars[self.player].value == 1:
+        regGG.locations.append(SMGLocation)(player, "GG: Purple Coins on the Puzzle Cube", location_table["GG: Purple Coins on the Puzzle Cube"], regGG)    
+    world.regions.append(regGG)  
+    # defines Freezeflame galaxy
+    regFF = Region("Freezeflame", player, world)
+    locFF_names = [name for name, id in locFF_table.items()]
+    regFF.locations += [SMGLocation(player, loc_name, location_table[loc_name], regFF) for loc_name in locFF_names]
+    if world.enable_purple_coin_stars[self.player].value == 1:
+        regGG.locations.append(SMGLocation)(player, "FF: Purple Coins on the Summit", location_table["FF: Purple Coins on the Summit"], regGG)  
+    world.regions.append(regFF)  
+    # defines DustyDune Galaxy
+    regDDune = Region("Dusty Dune", player, world)
+    locDDune_names = [name for name, id in locDDune_table.items()]
+    regDDune.locations += [SMGLocation(player, loc_name, location_table[loc_name], regDDune) for loc_name in locDDune_names]
+    if world.enable_purple_coin_stars[self.player].value == 1:
+        regDDune.locations.append(SMGLocation)(player, "DDune: Purple Coins in the Desert", location_table["DDune: Purple Coin in the Desert"], regDDune)  
+    world.regions.append(regDDune)  
+    # defines golden leaf galaxy
+    regGL = Region("Gold Leaf", player, world)
+    locGL_names = [name for name, id in locGL_table.items()]
+    regGL.locations += [SMGLocation(player, loc_name, location_table[loc_name], regGL) for loc_name in locGL_names]
+    if world.enable_purple_coin_stars[self.player].value == 1:
+        regGL.locations.append(SMGLocation)(player, "GL: Purple Coins in the Woods", location_table["GL: Purple Coins in the Woods"], regGL) 
+    world.regions.append(regGL)  
+    # defines the Sea slide galaxy
+    regSS = Region("Sea Slide", player, world)
+    locSS_names = [name for name, id in locSS_table.items()]
+    regSS.locations += [SMGLocation(player, loc_name, location_table[loc_name], regSS) for loc_name in locSS_names]    
+    if world.enable_purple_coin_stars[self.player].value == 1:
+        regSS.locations.append(SMGLocation)(player, "SS: Purple Coins by the Seaside", location_table["SS: Purple Coins by the Seaside"], regSS) 
+    world.regions.append(regSS)
+    # defines toy time galaxy 
+    regTT = Region ("Toy Time", player, world)
+    locTT_names = [name for name, id in locTT_table.items()]
+    regTT.locations += [SMGLocation(player, loc_name, location_table[loc_name], regTT) for loc_name in locTT_names]
+    if world.enable_purple_coin_stars[self.player].value == 1:
+        regSS.locations.append(SMGLocation)(player, "TT: Luigi's Purple Coins", location_table["TT: Luigi's Purple Coins"], regSS) 
+    world.regions.append(regTT)  
+    # defines deep dark galaxy
+    regDD = Region("Deep Dark", player, world)
+    locDD_names = [name for name, id in locDD_table.items()]
+    regDD.locations += [SMGLocation(player, loc_name, location_table[loc_name], regDD) for loc_name in locDD_names]
+    if world.enable_purple_coin_stars[self.player].value == 1:
+        regDD.locations.append(SMGLocation)(player, "DD: Plunder the Purple Coins", location_table["DD: Plunder the Purple Coins"], regDD) 
+    world.regions.append(regDD)  
+    # defines Dreadnaught galaxy
+    regDN = Region("Dreadnaught", player, world)
+    locDN_names = [name for name, id in locDN_table.items()]
+    regDN.locations += [SMGLocation (player, loc_name, location_table[loc_name], regDN) for loc_name in locDN_names]
+    if world.enable_purple_coin_stars[self.player].value == 1:
+        regDN.locations.append(SMGLocation)(player, "DN: Battlestation's Purple Coins", location_table["DN: Battlestation's Purple Coins"], regDN) 
+    world.regions.append(regDN)  
+    # defines Melty Molten galaxy
+    regMM = Region("Melty Molten", player, world)
+    locMM_names = [name for name, id in locMM_table.items()]
+    regMM.locations += [SMGLocation (player, loc_name, location_table[loc_name], regMM) for loc_name in locMM_names]
+    if world.enable_purple_coin_stars[self.player].value == 1:
+        regMM.locations.append(SMGLocation)(player, "MM: Red-Hot Purple Coins", location_table["MM: Red-Hot Purple Coins"], regMM) 
+    world.regions.append(regMM)  
+    #defines the fountain
+    regFountain = Region("Fountain", player, world)
+    world.regions.append(regFountain)
+    #defines the kitchen
+    regKitchen = Region("Kitchen", player, world)
+    world.regions.append(regKitchen)
+    #defines the bedroom
+    regBedroom = Region("Bedroom", player, world)
+    world.regions.append(regBedroom)
+    #defines the Engine Room
+    regEngineRoom = Region("Engine Room", player, world)
+    world.regions.append(regEngineRoom)
+    #defines the garden
+    regGarden = Region("Garden", player, world)
+    world.regions.append(regGarden)      
+
+def connect_regions(multiworld: MultiWorld, player: int, source: str, target: str, rule):
+    sourceRegion = multiworld.get_region(source, player)
+    targetRegion = multiworld.get_region(target, player)
+
+    connection = Entrance(player,'', sourceRegion)
+    connection.access_rule = rule
+
+    sourceRegion.exits.append(connection)
+    connection.connect(targetRegion)