noelle
/
metroidgen
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Browse Source

Clean up and add documentation

master
Noëlle Anthony 5 years ago
parent
dd4ab487bf
commit
2963b92cc4
1 changed files with 123 additions and 113 deletions
Split View Show Diff Stats
  1. 123
    113
      metroidgen.py

+ 123
- 113
metroidgen.py View File

@@ -1,10 +1,20 @@
# Metroid (NES) Random Password Generator
# Author: Noëlle Anthony
# License: MIT
# Date: October 2019
# This uses http://games.technoplaza.net/mpg/password.txt as a basis for its password algorithm

import random, sys

class MetroidState:
""" Stores the game state
"""
def __init__(self):
# Alphabet is 64 characters - 6 bits per character
self.alphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz?-"
# The password has different flags for "item available for pickup" and
# "Samus has the item". I'm keeping them separate, but when the generator
# selects an item as "picked up", that means Samus has it and it's not available.
self.itemsCollected = {
"Maru Mari": False,
"Bombs": False,
@@ -25,6 +35,8 @@ class MetroidState:
"Varia": False,
"Screw Attack": False
}
# Missile tanks are listed in the order in which they appear in the password,
# NOT in zone order or in any reasonable collection order.
self.missileTanks = {
1: False,
2: False,
@@ -48,6 +60,7 @@ class MetroidState:
20: False,
21: False
}
# Likewise energy tanks are listed in password order.
self.energyTanks = {
1: False,
2: False,
@@ -58,6 +71,7 @@ class MetroidState:
7: False,
8: False
}
# This may be left-to-right (Samus approaches from the right). I haven't checked.
self.zebetitesDestroyed = {
1: False,
2: False,
@@ -65,6 +79,8 @@ class MetroidState:
4: False,
5: False
}
# I'm not sure why I decided to segregate these by zone, except that that's how
# truepeacein.space does it.
self.doors = {
"Brinstar": {
1: False,
@@ -92,26 +108,43 @@ class MetroidState:
3: False
}
}
# The next three are self-explanatory.
self.kraidKilled = False
self.ridleyKilled = False
self.motherBrainKilled = False
# The Kraid and Ridley statues rise when Kraid and Ridley are killed, but
# their states are stored separately in the password. It's possible to
# raise them without killing the bosses, granting early access to Tourian.
self.kraidStatue = False
self.ridleyStatue = False
# Is Samus wearing her armor (False) or her swimsuit (True)?
self.swimsuit = False
# 0-255. You can have more missiles than 5*collected tanks (in fact, you
# can only collect 21 tanks - thus 105 missiles - but can have up to 255
# missiles in your inventory).
self.missileCount = 0
# How advanced is the game clock? After 3 hours you don't get the good ending.
self.gameAge = 0
# There are five possible start locations: Brinstar, where you start, and
# at the bottom of the elevator where you enter each subsequent zone.
self.locations = ["Brinstar", "Norfair", "Kraid's Lair", "Ridley's Lair", "Tourian"]
self.startLocation = 0
# Arrays to store the 144 bits that compose the password
self.bitfield = []
self.initializeBitfield()
self.fullbitfield = []

def initializeBitfield(self):
""" Set the first 128 bits of the bitfield to 0.
The remaining 16 bits will be set later.
"""
self.bitfield = []
for _ in range(128):
self.bitfield.append(0)

def toggleItem(self, itm):
""" Mark an item as collected or uncollected.
"""
if itm in self.itemsCollected.keys():
self.itemsCollected[itm] = not self.itemsCollected[itm]
self.samusHas[itm] = not self.samusHas[itm]
@@ -119,6 +152,8 @@ class MetroidState:
print("Couldn't find item: {}".format(str(itm)))
def toggleMissileTank(self, num):
""" Mark a missile tank as collected or uncollected.
"""
try:
num = int(num)
except:
@@ -130,6 +165,8 @@ class MetroidState:
print("Couldn't find missile tank: {}".format(num))
def toggleEnergyTank(self, num):
""" Mark an energy tank as collected or uncollected.
"""
try:
num = int(num)
except:
@@ -141,6 +178,8 @@ class MetroidState:
print("Couldn't find energy tank: {}".format(num))
def toggleZebetite(self, num):
""" Mark a Zebetite stem as destroyed or intact.
"""
try:
num = int(num)
except:
@@ -152,27 +191,43 @@ class MetroidState:
print("Couldn't find Zebetite: {}".format(num))

def toggleKraid(self):
""" Mark Kraid as killed or alive.
"""
self.kraidKilled = not self.kraidKilled
self.kraidStatue = self.kraidKilled

def toggleKraidStatue(self):
""" Mark Kraid's statue as raised or lowered.
If Kraid is killed but his statue isn't raised, you can't complete the game.
"""
self.kraidStatue = not self.kraidStatue
if self.kraidKilled and not self.kraidStatue:
print("WARNING: Kraid has been killed but his statue has not been raised.")

def toggleRidley(self):
""" Mark Ridley as killed or alive.
"""
self.ridleyKilled = not self.ridleyKilled
self.ridleyStatue = self.ridleyKilled

def toggleRidleyStatue(self):
""" Mark Ridley's statue as raised or lowered.
If Ridley is killed but his statue isn't raised, you can't complete the game.
"""
self.ridleyStatue = not self.ridleyStatue
if self.ridleyKilled and not self.ridleyStatue:
print("WARNING: Ridley has been killed but his statue has not been raised.")
def toggleMotherBrain(self):
""" Mark Mother Brain as killed or alive.
If Mother Brain is marked as killed, the self-destruct timer won't go off
when you reach her room.
"""
self.motherBrainKilled = not self.motherBrainKilled

def toggleDoor(self, area, door):
""" Mark a given red/yellow door as opened or locked.
"""
try:
area = str(area)
door = int(door)
@@ -185,9 +240,13 @@ class MetroidState:
print("Couldn't find door {} in area {}".format(door, area))

def toggleSwimsuit(self):
""" Determine whether or not Samus is wearing her armor.
"""
self.swimsuit = not self.swimsuit

def newLocation(self, loc):
""" Set a new starting location (0-4).
"""
try:
loc = str(loc)
except:
@@ -199,6 +258,10 @@ class MetroidState:
print("Couldn't find location: {}".format(loc))

def collectedItems(self):
""" List which items have been collected.
Under this generator's rules, if Samus doesn't have an item,
it's available to be picked up.
"""
o = []
for k,v in self.itemsCollected.items():
if v == True:
@@ -209,6 +272,8 @@ class MetroidState:
return ", ".join(o)

def collectedMissiles(self):
""" List which missile tanks have been collected.
"""
o = []
for k, v in self.missileTanks.items():
if v == True:
@@ -219,6 +284,8 @@ class MetroidState:
return ", ".join([str(b) for b in o])
def collectedEtanks(self):
""" List which energy tanks have been collected.
"""
o = []
for k, v in self.energyTanks.items():
if v == True:
@@ -229,6 +296,8 @@ class MetroidState:
return ", ".join([str(b) for b in o])
def killedZebetites(self):
""" List which Zebetite stems have been destroyed.
"""
o = []
for k, v in self.zebetitesDestroyed.items():
if v == True:
@@ -239,6 +308,8 @@ class MetroidState:
return ", ".join([str(b) for b in o])

def killedBosses(self):
""" List which bosses have been killed.
"""
o = []
if self.kraidKilled:
o.append("Kraid")
@@ -252,6 +323,8 @@ class MetroidState:
return ", ".join(o)
def raisedStatues(self):
""" List which statues have been raised.
"""
o = []
if self.kraidStatue:
o.append("Kraid")
@@ -263,12 +336,19 @@ class MetroidState:
return ", ".join(o)

def inBailey(self):
""" Show whether Samus is in her swimsuit or not.
'inBailey' refers to an old (false) explanation of the JUSTIN BAILEY
password, in which a 'bailey' was English slang for a bathing suit,
so with that password, Samus was "Just In Bailey" - i.e. in her swimsuit.
"""
if self.swimsuit:
return "Yes"
else:
return "No"

def openedDoors(self):
""" List which red/yellow doors have been unlocked.
"""
d = {"Brinstar": 0, "Norfair": 0, "Kraid": 0, "Ridley": 0, "Tourian": 0}
o = []
for k,v in self.doors["Brinstar"].items():
@@ -291,6 +371,8 @@ class MetroidState:
return ", ".join(o)

def getBits(self):
""" Return the bitfield in an easily-readable format.
"""
o = []
word = []
for i in range(128):
@@ -303,6 +385,8 @@ class MetroidState:
return o1 + "\n" + o2

def toString(self):
""" Output the game state as a newline-delimited string.
"""
ic = "Items Collected: {}".format(self.collectedItems())
mt = "Missile Tanks Collected: {}".format(self.collectedMissiles())
et = "Energy Tanks Collected: {}".format(self.collectedEtanks())
@@ -314,10 +398,11 @@ class MetroidState:
dr = "Unlocked Doors: {}".format(self.openedDoors())
ms = "Missiles: {}".format(self.missileCount)
pw = "Password: {}".format(self.password)
# bf = "Bitfield:\n{}".format(self.getBits())
return "\n".join([ic, mt, et, zb, kb, rs, sw, sl, dr, ms, pw])

def randomize(self):
""" The randomizer!
"""
# Items
if random.randint(0,1) == 1:
self.toggleItem("Maru Mari")
@@ -378,6 +463,8 @@ class MetroidState:
if random.randint(0,1) == 1:
self.doors["Tourian"][i+1] = True
# Swimsuit
# Samus has a 1/3 chance of spawning in her swimsuit.
# There's no technical reason for this, just a personal choice.
if random.randint(0,2) == 2:
self.toggleSwimsuit()
# Start Location
@@ -385,6 +472,9 @@ class MetroidState:
self.missileCount = random.randint(0,255)

def createBitfield(self):
""" Create the 144-bit field from the game state
that will generate the password.
"""
self.initializeBitfield()
# Doing this in order, which is dumb and tedious but accurate.
if self.itemsCollected["Maru Mari"]:
@@ -505,17 +595,9 @@ class MetroidState:
self.bitfield[57] = 1
if self.motherBrainKilled:
self.bitfield[58] = 1

# 59-63 unknown
# if self.:
# self.bitfield[59] = 1
# if self.:
# self.bitfield[60] = 1
# if self.:
# self.bitfield[61] = 1
# if self.:
# self.bitfield[62] = 1
# if self.:
# self.bitfield[63] = 1

# not 64, 65, or 66 = Brinstar
# 64 = Norfair
# 65 and not 66 = Kraid's Lair
@@ -527,16 +609,13 @@ class MetroidState:
self.bitfield[65] = 1
if self.startLocation == 3 or self.startLocation == 4:
self.bitfield[66] = 1

# 67 is the reset bit, I want all passwords to be valid
# if self.:
# self.bitfield[67] = 1

# 68-70 are unknown
# if self.:
# self.bitfield[68] = 1
# if self.:
# self.bitfield[69] = 1
# if self.:
# self.bitfield[70] = 1

if self.swimsuit:
self.bitfield[71] = 1
if self.samusHas["Bombs"]:
@@ -555,6 +634,7 @@ class MetroidState:
self.bitfield[78] = 1
if self.samusHas["Ice Beam"]:
self.bitfield[79] = 1

# Missile count
# +2^n from 0 to 7
binMissiles = bin(self.missileCount).replace('0b','')[::-1]
@@ -577,79 +657,12 @@ class MetroidState:
if int(binMissiles[7]) == 1:
self.bitfield[87] = 1
# 88-119 are game age, leaving at 0
# if self.:
# self.bitfield[88] = 1
# if self.:
# self.bitfield[89] = 1
# if self.:
# self.bitfield[90] = 1
# if self.:
# self.bitfield[91] = 1
# if self.:
# self.bitfield[92] = 1
# if self.:
# self.bitfield[93] = 1
# if self.:
# self.bitfield[94] = 1
# if self.:
# self.bitfield[95] = 1
# if self.:
# self.bitfield[96] = 1
# if self.:
# self.bitfield[97] = 1
# if self.:
# self.bitfield[98] = 1
# if self.:
# self.bitfield[99] = 1
# if self.:
# self.bitfield[100] = 1
# if self.:
# self.bitfield[101] = 1
# if self.:
# self.bitfield[102] = 1
# if self.:
# self.bitfield[103] = 1
# if self.:
# self.bitfield[104] = 1
# if self.:
# self.bitfield[105] = 1
# if self.:
# self.bitfield[106] = 1
# if self.:
# self.bitfield[107] = 1
# if self.:
# self.bitfield[108] = 1
# if self.:
# self.bitfield[109] = 1
# if self.:
# self.bitfield[110] = 1
# if self.:
# self.bitfield[111] = 1
# if self.:
# self.bitfield[112] = 1
# if self.:
# self.bitfield[113] = 1
# if self.:
# self.bitfield[114] = 1
# if self.:
# self.bitfield[115] = 1
# if self.:
# self.bitfield[116] = 1
# if self.:
# self.bitfield[117] = 1
# if self.:
# self.bitfield[118] = 1
# if self.:
# self.bitfield[119] = 1

# 120-123 are unknown
# if self.:
# self.bitfield[120] = 1
# if self.:
# self.bitfield[121] = 1
# if self.:
# self.bitfield[122] = 1
# if self.:
# self.bitfield[123] = 1

# I have no idea why these are at the end. I wonder if Kraid and
# Ridley were relatively late additions to the game? (Or maybe
# they were just implemented late in the game's development.)
if self.ridleyKilled:
self.bitfield[124] = 1
if self.ridleyStatue:
@@ -660,21 +673,25 @@ class MetroidState:
self.bitfield[127] = 1

def generatePassword(self):
""" Generate the password from the bitfield.
This is a five-step process.
1) Reverse the order of each 8-bit byte to make it little-endian.
2) Cycle the entire bitfield 0-7 bits to the right.
Append the number of shifts in binary to the end - again, little-endian.
3) Create the checksum by turning each byte into a decimal number,
summing them, converting the sum *back* to binary, and taking the lowest
8 bits of that binary sum and adding it - BIG-ENDIAN - to the end.
4) Separate the bitstream into ***6-bit*** chunks and create a decimal
number from each chunk (0-63).
5) Associate each decimal number with a letter from the Metroid Alphabet
(listed at the top of __init__()).
I'm not doing step 2 yet, which is equivalent to shifting 0 places
and making the shift byte 00000000.
"""
# not gonna do the bit-shifting yet
# shiftbit = random.randint(0,7)
bitfield = self.bitfield
# for _ in range(shiftbit):
# [bitfield[127]] + bitfield[:127]
# binShift = bin(shiftbit).replace('0b','')
# while len(binShift) < 8:
# binShift = "0" + binShift
# for bit in binShift:
# bitfield.append(int(bit))
bitfield = bitfield + [0,0,0,0,0,0,0,0]
# checking = []
# for i in range(16):
# checking.append(int("".join([str(x) for x in bitfield[i:i+8]]), 2))
# print("Full Bitfield: {}".format("".join([str(x) for x in bitfield])))
bitfield = bitfield + [0,0,0,0,0,0,0,0] # add the zero shift byte
self.fullbitfield = "".join([str(x) for x in bitfield])
newBitfield = []
for i in range(17):
@@ -688,10 +705,8 @@ class MetroidState:
checksum = binChecksum[-8:]
while len(checksum) < 8:
checksum = "0" + checksum
# print(checksum)
for bit in checksum:
bitfield += bit
# print("Real Bitfield: {}".format(bitfield))

letters = []
letter = []
@@ -712,6 +727,9 @@ class MetroidState:
return self.password

def decodePassword(self, pwd):
""" Sanity checking! This function decodes an input password back into a bitfield,
so that you can check that it was properly encoded.
"""
densePwd = pwd.replace(" ","")
numPwd = []
for chr in densePwd:
@@ -723,15 +741,9 @@ class MetroidState:
while len(longword) < 6:
longword = "0" + longword
longBitPwd.append(longword)
# print(self.fullbitfield)
newBitfield = "".join(longBitPwd)
# print(newBitfield)
# print(newBitfield == self.fullbitfield)
# print(len(newBitfield[:136]))
# print(newBitfield[:136])
csm = sum([int(x) for x in newBitfield[:136]])
print(csm)
# print(bin(csm).replace("0b",""))
for i in range(len(newBitfield)):
print(newBitfield[i], end="")
if i%8 == 7:
@@ -743,10 +755,8 @@ def main():
gs = MetroidState()
gs.randomize()
gs.createBitfield()
pwd = gs.generatePassword()
gs.generatePassword()
print(gs.toString())
# print(pwd)
# gs.decodePassword(pwd)

if __name__ == "__main__":
if len(sys.argv) == 2:

Write Preview
Loading…
Cancel
Save