Fix Python 3 conversion issues

Author: MaxDesiatov

README.md

@@ -52,18 +52,17 @@ To use this, you'll need a few things:
 
 - A copy of Fallout 2 (already installed)
 
-- Python 2.7
+- Python 3.9, earlier minor versions of Python 3 may work, but are not tested. Python 2 is not supported.
 
 - [Pillow](https://pillow.readthedocs.io/en/4.0.x) (just `pip install pillow`)
 
 - [NumPy](http://www.numpy.org/) (Windows binaries available [here](http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy).)
 
-- The TypeScript compiler, installed via `npm install -g typescript` (you'll need [node.js](https://nodejs.org/en/)).
+- The TypeScript compiler, installed via `npm install` (you'll need [node.js](https://nodejs.org/en/)).
 
 You'll need an HTTP server to run (despite being all static content) due to the way browsers sandbox requests.
 If you're comfortable with setting up nginx, lighttpd, or Apache, go for that. If not, a simple way is to use Python:
 
-- Python 2: `python -m SimpleHTTPServer` (Python 2 is already required anyway)
 - Python 3: `python -m http.server`
 
 Alternatively, Firefox can load directly from `file://`.
@@ -78,7 +77,7 @@ This will take a few minutes, it's unpacking the game archives and converting re
 
 NOTE: You may need to use `python2` instead, as some Linux distributions package `python` as Python 3. Run `python --version` to check!
 
-Then run `tsc` to compile the source code.
+Then run `npx tsc` after you've run `npm install` to compile the source code.
 
 Browse to `http://localhost/play.html?artemple` (or whatever port you're using). If all went well, it should begin the game. If not, check the JavaScript console for errors.
 
@@ -89,32 +88,32 @@ OPTIONAL: If you want sound, run `python convertAudio.py`. You'll need the `acm2
 ## FAQ
 
 - **Q:** Why TypeScript? Why a browser?
-  
+
   A: Everyone has a browser: it's a portable platform for running code with more features than people expect.
-     There are other projects that use native code already... and are already seeing segfaults. :)
+  There are other projects that use native code already... and are already seeing segfaults. :)
 
-     The project started out in JavaScript and was ported to TypeScript as it was continuing to grow. TypeScript strikes
-     an excellent balance between useful and safe.
+  The project started out in JavaScript and was ported to TypeScript as it was continuing to grow. TypeScript strikes
+  an excellent balance between useful and safe.
 
 - **Q:** But why Python?
-  
+
   A: Python is actually quite fast when written well, despite many peoples' expectations. It is very elegant and allows me to write
-     backend code like file parsers and exporters with tiny code, very few troubles, and that I know is portable and safe.
+  backend code like file parsers and exporters with tiny code, very few troubles, and that I know is portable and safe.
 
 - **Q:** Why do I need `acm2wav` for sound?
-  
+
   A: Because it hasn't been ported to Python yet. If you're willing to contribute, give it a shot: the original Pascal source code is available online.
 
   Additionally, FFmpeg might be able to transcode ACM audio, so give that a shot. (See #30.)
-   
+
 - **Q:** Why convert all assets up front, why not load them directly?
-  
+
   A: Because it would require more processing time to load them each time they're needed rather than having them already in a sane, modern format.
-  
+
   By converting, for example, FRMs (a proprietary Interplay format) to PNGs (a ubiquitous, open modern format) we allow normal browsers or image viewers to open them, as well as edit them -- a huge win for modders. Other games or tools could take advantage of the new formats as well.
 
 - **Q:** Why do this at all?
-  
+
   A: Why not? It's a fun project, and I love Fallout. Fallout 1 and 2 do not run particularly well on modern machines, even with engine hacks. They're also hard to mod -- I'd like to change that.
 
 ## License
@@ -129,7 +128,6 @@ Testing is more than welcome: if you have issues running DarkFO, or if you find
 
 To contribute code, simply submit a pull request with your changes. Take care to write sensible commit messages, and if you want to change major parts of the code, please discuss it with other developers first (see the Contact section below).
 I apologize in advance for any injury sustained while reading the code. :)
- 
 
 Thanks!
 

dat2.py

@@ -99,12 +99,12 @@ def mkdirs(path):
 		if not os.path.exists(dir):
 			os.mkdir(dir)
 
-def dumpFiles(f, outDir, verbose=True):
+def dumpFiles(f, outDir, verbose=False):
 	dirTree = readDAT(f, posixPaths=True)
 	numFiles = len(dirTree)
 	i = 1
 
-	for filename, fileEntry in dirTree.iteritems():
+	for filename, fileEntry in dirTree.items():
 		outPath = os.path.join(outDir, filename)
 		mkdirs(outDir + "/" + os.path.dirname(filename))
 

exportImages.py

@@ -68,7 +68,7 @@ def main():
 				i += 1
 				continue
 
-			print "[%d/%d/%d] %s..." % (i, len(FRMs), totalNum, name)
+			print("[%d/%d/%d] %s..." % (i, len(FRMs), totalNum, name))
 			imageInfo['art/'+name] = frmpixels.exportFRM(FRM, outpath, palette, exportImage)
 
 			i += 1
@@ -79,13 +79,13 @@ def main():
 			imageMap.update(imageInfo)
 			imageInfo = imageMap
 
-		print "writing image map..."
+		print("writing image map...")
 
 		# write new imageMap
 		json.dump(imageInfo, open('%s/imageMap.json' % OUT_DIR, "w"))
 
 
 if __name__ == '__main__':
-	start_time = time.clock()
+	start_time = time.perf_counter()
 	main()
-	print("--- %s seconds ---" % (time.clock() - start_time))
+	print("--- %s seconds ---" % (time.perf_counter() - start_time))

exportImagesPar.py

@@ -74,7 +74,7 @@ def readPAL(path):
 def convertAll(palette, dataDir, outDir, mode='both', imageMapMode='yes', nProcs=N_PROCS, verbose=False):
 	# Convert FRMs and FR[0-9]s, and output an image map
 
-	start_time = time.clock()
+	start_time = time.perf_counter()
 
 	if not os.path.exists(outDir):
 		os.mkdir(outDir)
@@ -122,7 +122,7 @@ def convertAll(palette, dataDir, outDir, mode='both', imageMapMode='yes', nProcs
 		# write new imageMap
 		json.dump(imageInfo, open(outDir + "/imageMap.json", "w"))
 
-	return time.clock() - start_time
+	return time.perf_counter() - start_time
 
 def main():
 	if len(sys.argv) < 5:

exportPRO.py

@@ -54,7 +54,7 @@ def extractPROs(dataProtoPath, outDir, onError=onError, verbose=False):
 
     with open(os.path.join(outDir, "pro.json"), "w") as fp:
         print("Writing master JSON map...")
-        json.dump(root_map, fp)
+        json.dump(root_map, fp, indent=2)
 
 def main():
     extractPROs(os.path.join("data", "proto"), "proto", verbose=True)

fomap.py

@@ -17,24 +17,26 @@
 # Parser/converter for Fallout 1 (partially) and 2 .MAP files to a JSON format
 
 from __future__ import print_function
+from io import BufferedReader
 import sys, os, struct, json
+from typing import Any, Dict
 
 FO1_MODE = None # global
 DATA_DIR = None # global
 SCRIPT_TYPES = ["s_system", "s_spatial", "s_time", "s_item", "s_critter"]
 
-mapScriptPIDs = [{} for _ in range(5)]
+mapScriptPIDs: list[Dict[int, Any]] = [{} for _ in range(5)]
 
-def read16(f):
+def read16(f) -> int:
     return struct.unpack("!h", f.read(2))[0]
 
-def readU16(f):
+def readU16(f) -> int:
     return struct.unpack("!H", f.read(2))[0]
 
-def read32(f):
+def read32(f) -> int:
     return struct.unpack("!l", f.read(4))[0]
 
-def readU32(f):
+def readU32(f) -> int:
     return struct.unpack("!L", f.read(4))[0]
 
 def stripExt(path):
@@ -78,7 +80,7 @@ def parseTiles(f, numLevels):
 
     return floorTiles, roofTiles
 
-def parseMapScripts(f, scriptLst):
+def parseMapScripts(f, scriptLst: list[bytes]):
     totalScriptCount = 0
     spatials = []
 
@@ -133,7 +135,7 @@ def parseMapScripts(f, scriptLst):
                             print("script:", script)
                         else:
                             #print "script id:", script.spatialScriptID, "or", (script.spatialScriptID & 0xffff)
-                            scriptName = stripExt(scriptLst[scriptID].split()[0])
+                            scriptName = stripExt(scriptLst[scriptID].decode('ascii').split()[0])
                             spatials.append({"tileNum": tileNum & 0xffff,
                                              "elevation": ((tileNum >> 28) & 0xf) >> 1,
                                              "range": spatialRange,
@@ -155,7 +157,7 @@ def parseMapScripts(f, scriptLst):
     return {"count": totalScriptCount, "spatials": spatials, "mapScriptPIDs": mapScriptPIDs}
 
 # TODO: rewrite this
-def getCritterArtPath(frmPID, critterLst):
+def getCritterArtPath(frmPID, critterLst: list[bytes]):
     idx =  frmPID & 0x00000fff
     id1 = (frmPID & 0x0000f000) >> 12
     id2 = (frmPID & 0x00ff0000) >> 16
@@ -167,7 +169,7 @@ def getCritterArtPath(frmPID, critterLst):
             id2 == 0x21 or id2 == 0x40):
         raise Exception("reindex")
 
-    path = "art/critters/" + critterLst[idx].split(",")[0].upper()
+    path = "art/critters/" + critterLst[idx].decode('ascii').split(",")[0].upper()
 
     if (id1 >= 0x0b):
         raise Exception("?")
@@ -209,9 +211,9 @@ def getCritterArtPath(frmPID, critterLst):
 
 def parseItemObj(f, frmPID, protoPID, itemsLst, itemsProtoLst):
     item = {"type": "item",
-            "artPath": "art/items/" + stripExt(itemsLst[frmPID & 0xffff])
+            "artPath": "art/items/" + (stripExt(itemsLst[frmPID & 0xffff]).decode('ascii'))
            }
-    subtype = getProSubType("proto/items/" + itemsProtoLst[(protoPID & 0xffff) - 1])
+    subtype = getProSubType("proto/items/" + itemsProtoLst[(protoPID & 0xffff) - 1].decode('ascii'))
 
     if subtype == 4: # ammo
         item["subtype"] = "ammo"
@@ -234,7 +236,7 @@ def parseItemObj(f, frmPID, protoPID, itemsLst, itemsProtoLst):
 
     return item
 
-def parseObject(f, lstFiles):
+def parseObject(f, lstFiles: dict[str, list[bytes]]):
     f.read(4) # unknown (separator)
     position = read32(f)
     f.read(4*4) # unknown
@@ -275,7 +277,7 @@ def parseObject(f, lstFiles):
 
     elif objType == 3: # wall
         namedType = "wall"
-        art = "art/walls/" + stripExt(lstFiles["walls"][frmPID & 0xffff])
+        art = "art/walls/" + stripExt(lstFiles["walls"][frmPID & 0xffff].decode('ascii'))
 
     elif objType == 1: # critter
         namedType = "critter"
@@ -290,8 +292,9 @@ def parseObject(f, lstFiles):
 
     elif objType == 2: # scenery
         namedType = "scenery"
-        art = "art/scenery/" + stripExt(lstFiles["scenery"][frmPID & 0xffff])
-        subtype = getProSubType("proto/scenery/" + lstFiles["proto_scenery"][(protoPID & 0xffff) - 1])
+        art = "art/scenery/" + stripExt(lstFiles["scenery"][frmPID & 0xffff].decode('ascii'))
+        proto_scenery = lstFiles["proto_scenery"]
+        subtype = getProSubType("proto/scenery/" + (proto_scenery[(protoPID & 0xffff) - 1]).decode('ascii'))
 
         """
         # TODO: why have this? this just goes into the real "extra" field anyway
@@ -322,7 +325,7 @@ def parseObject(f, lstFiles):
 
     elif objType == 5: # misc
         namedType = "misc"
-        art = "art/misc/" + stripExt(lstFiles["misc"][frmPID & 0xffff])
+        art = "art/misc/" + stripExt(lstFiles["misc"][frmPID & 0xffff].decode('ascii'))
 
         # exit grids
         if (protoPID & 0xffff) != 1 and (protoPID & 0xffff) != 12:
@@ -366,28 +369,28 @@ def parseObject(f, lstFiles):
     #    obj["art"] = extra["artPath"].lower()
 
     if scriptID != -1:
-        scriptName = stripExt(lstFiles["scripts"][scriptID].split()[0])
+        scriptName = stripExt(lstFiles["scripts"][scriptID].decode('ascii').split()[0])
         obj["script"] = scriptName
     elif scriptID == -1 and mapPID != 0xFFFFFFFF:
         # try to use the script IDs mapped in parseMapScripts
         scriptType = (mapPID >> 24) & 0xff
         scriptPID = mapPID & 0xffff
         print("using map script for %s (script PID %d)" % (art, scriptPID))
-        scriptName = mapScriptPIDs[scriptType][scriptPID]
+        scriptName = mapScriptPIDs[scriptType][scriptPID].decode('ascii')
         print("(map script %d type %d = %s)" %  (scriptPID, scriptType, scriptName))
         obj["script"] = scriptName
 
     return obj
 
-def parseLevelObjects(f, lstFiles):
+def parseLevelObjects(f, lstFiles: dict[str, list[bytes]]):
     numObjects = readU32(f)
     return [parseObject(f, lstFiles) for _ in range(numObjects)]
 
-def parseMapObjects(f, numLevels, lstFiles):
+def parseMapObjects(f, numLevels, lstFiles: dict[str, list[bytes]]):
     numObjects = readU32(f)
     return [parseLevelObjects(f, lstFiles) for _ in range(numLevels)]
 
-def parseMap(f, lstFiles):
+def parseMap(f: BufferedReader, lstFiles: dict[str, list[bytes]]):
     global FO1_MODE
 
     version = readU32(f)
@@ -430,7 +433,7 @@ def parseMap(f, lstFiles):
     levels = []
 
     def transformTile(idx):
-        return stripExt(lstFiles["tiles"][idx].rstrip()).lower()
+        return stripExt(lstFiles["tiles"][idx].decode('ascii').rstrip()).lower()
 
     def transformTileMap(tileMap):
         return [[transformTile(idx) for idx in row] for row in tileMap]
@@ -470,7 +473,7 @@ def getImageList(map):
 
     return list(images)
 
-def exportMap(dataDir, mapFile, outFile, verbose=False):
+def exportMap(dataDir: str, mapFile: str, outFile: str, verbose=False):
     global DATA_DIR
 
     DATA_DIR = dataDir # TODO: make this not global
@@ -487,14 +490,14 @@ def exportMap(dataDir, mapFile, outFile, verbose=False):
                }
 
     with open(mapFile, "rb") as fin:
-        with open(outFile, "wb") as fout:
+        with open(outFile, "w") as fout:
             if verbose: print("writing %s..." % outFile)
             map = parseMap(fin, lstFiles)
             json.dump(map, fout)
 
             # write image list
             if verbose: print("writing image list...")
-            with open(stripExt(outFile) + ".images.json", "wb") as fimg:
+            with open(stripExt(outFile) + ".images.json", "w") as fimg:
                 json.dump(getImageList(map), fimg)
 
             if verbose: print("done")

frmpixels.py

@@ -16,6 +16,7 @@
 
 # FRM parsing/conversion library
 
+from io import BufferedReader
 import sys, os, struct, json
 import pal
 from PIL import Image
@@ -33,7 +34,7 @@ def read16At(buf, idx):
 def read32At(buf, idx):
 	return struct.unpack('!l', buf[idx:idx + 4])[0]
 
-def readFRMInfo(f, exportImage=True):
+def readFRMInfo(f: BufferedReader, exportImage=True):
 	_version = read32(f)
 	fps = read16(f)
 	_actionFrame = read16(f)
@@ -67,7 +68,7 @@ def readFRMInfo(f, exportImage=True):
 
 			frameSize = read32At(framesData, ptr + 4) # w*h
 			if exportImage:
-				framePixels[nDir].append(np.array([ord(byte) for byte in framesData[ptr + 12 : ptr + 12 + frameSize]], np.uint8))
+				framePixels[nDir].append(np.array([byte for byte in framesData[ptr + 12 : ptr + 12 + frameSize]], np.uint8))
 
 			ptr += 12 + pixelDataSize