support bundling with pyinstaller

.gitignore

@@ -11,4 +11,9 @@ content/
 
 # environment
 .env/
-game.path
+game.path
+
+# pyinstaller
+dist/
+build/
+*.spec

README.md

@@ -15,6 +15,12 @@ Based on [EdibleBug/WoWS-GameParams](https://github.com/EdibleBug/WoWS-GameParam
 - Paste the game path into `game.path`
 - Run `python3 run.py` again to unpack
 
+## Distribution
+- Install `pyinstaller` following [this guide](https://pyinstaller.org/en/stable/index.html)
+- Run `pyinstaller  --onefile .\run.py -p .\unpack\ --hidden-import GameParams`
+- Copy `wowsunpack.exe` to `dist/`
+- Ready to go!
+
 ***
 
 # World of Warships GameParams to JSON

run.py

@@ -1,4 +1,5 @@
 import os
+import sys
 from unpack import WoWsUnpack
 
 if __name__ == "__main__":
@@ -14,16 +15,22 @@
         try:
             unpack.unpackGameParams()
             unpack.decodeGameParams()
+
             # optional actions
             # unpack.decodeLanguages()
             # unpack.unpackGameIcons()
             # unpack.unpackGameMaps()
         except FileNotFoundError:
-            print("Make sure the game path is valid")
+            print("Make sure the game path is valid. It should look like C:\Games\World_of_Warships")
             print("\nhttps://github.com/WoWs-Info/wows_gameparams")
+            sys.exit(-1)
     else:
         with open('game.path', 'w') as f:
             print("Created game.path")
             print(
                 "Please place your game path in it. It should look like C:\Games\World_of_Warships")
-        exit(-1)
+            print("\nhttps://github.com/WoWs-Info/wows_gameparams")
+            sys.exit(-1)
+
+    print("Done unpacking!")
+    input("Press Enter to exit...")

unpack/__init__.py

@@ -1,6 +1,6 @@
-from unpack.unpack import WoWsUnpack
-from unpack.WoWsGameParams import WoWsGameParams
 import sys
 import os
 # this is necessary for submodules to work correctly
 sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
+from unpack.unpack import WoWsUnpack
+from unpack.WoWsGameParams import WoWsGameParams

unpack/unpack.py

@@ -4,8 +4,7 @@
 import pathlib
 import os
 import sys
-from unpack.WoWsGameParams import WoWsGameParams
-
+from WoWsGameParams import WoWsGameParams
 
 class WoWsUnpack:
     def __init__(self, path):