-
Notifications
You must be signed in to change notification settings - Fork 3
/
build_puzzle.py
370 lines (286 loc) · 12.5 KB
/
build_puzzle.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
#!/usr/bin/python
# -*- coding: latin-1 -*-
# Reggie! - New Super Mario Bros. Wii Level Editor
# Copyright (C) 2009-2010 Treeki, Tempus
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
import json
import os, os.path
import shutil
import sys
import PyInstaller.__main__
########################################################################
############################### Constants ##############################
########################################################################
# Everything highly specific to Reggie is in this section, to make it
# simpler to copypaste this script across all of the NSMBW-related
# projects that use the same technologies (Reggie, Puzzle, BRFNTify,
# etc)
PROJECT_NAME = 'Puzzle Next'
FULL_PROJECT_NAME = 'Puzzle Next Tileset Editor'
PROJECT_VERSION = '1.0.0'
WIN_ICON = os.path.join('Icons', 'icon.ico')
MAC_ICON = os.path.join('Icons', 'icon.icns')
MAC_BUNDLE_IDENTIFIER = 'me.nin0.puzzle'
SCRIPT_FILE = 'puzzle.py'
DATA_FOLDERS = ['Icons', 'MenuIcons', 'Other', 'QCodeEditor']
DATA_FILES = ['readme.md', 'LICENSE', 'LICENSE-dark.qss', 'LICENSE-QCodeEditor', 'dark.qss', 'light.qss']
# macOS only
AUTO_APP_BUNDLE_NAME = SCRIPT_FILE.split('.')[0] + '.app'
FINAL_APP_BUNDLE_NAME = FULL_PROJECT_NAME + '.app'
########################################################################
################################# Intro ################################
########################################################################
DIR = os.path.join('build', 'puzzle_next_v%s_win32' % PROJECT_VERSION)
WORKPATH = 'build_temp'
SPECFILE = SCRIPT_FILE[:-3] + '.spec'
def print_emphasis(s):
print('>>')
print('>> ' + '=' * (len(s) - 3))
print(s)
print('>> ' + '=' * (len(s) - 3))
print('>>')
print('[[ Building ' + PROJECT_NAME + ' ]]')
print('>> Please note: extra command-line arguments passed to this script will be passed through to PyInstaller.')
print('>> Destination directory: ' + DIR)
if os.path.isdir(DIR): shutil.rmtree(DIR)
if os.path.isdir(WORKPATH): shutil.rmtree(WORKPATH)
if os.path.isdir(SPECFILE): os.remove(SPECFILE)
def run_pyinstaller(args):
print('>>')
printMessage = ['>> Running PyInstaller with the following arguments:']
for a in args:
if ' ' in a:
printMessage.append('"' + a + '"')
else:
printMessage.append(a)
print(' '.join(printMessage))
print('>>')
PyInstaller.__main__.run(args)
########################################################################
######################### Environment detection ########################
########################################################################
print('>>')
print('>> Detecting environment...')
print('>>')
# Python optimization level
if sys.flags.optimize == 2:
print('>> [X] Python optimization level is -OO')
else:
print('>> [ ] Python optimization level is -OO')
# NSMBLib being installed
try:
import nsmblib
print('>> [X] NSMBLib is installed')
except ImportError:
nsmblib = None
print('>> [ ] NSMBLib is installed')
# UPX being installed
# There seems to be no reliable way to determine in this script if
# PyInstaller will detect UPX or not. PyInstaller itself provides no
# public API for this, and doing horrible things with its private API
# didn't ultimately work well enough to be useful.
# So all we can do is show this generic message, unfortunately.
print('>> [?] UPX is installed')
# Now show big warning messages if any of those failed
if sys.flags.optimize < 2:
msg = 'without' if sys.flags.optimize == 0 else 'with only one level of'
print_emphasis('>> WARNING: Python is being run ' + msg + ' optimizations enabled! Please consider building with -OO.')
if nsmblib is None:
print_emphasis('>> WARNING: NSMBLib does not seem to be installed! Please consider installing it prior to building.')
print_emphasis('>> NOTE: If the PyInstaller output below says "INFO: UPX is not available.", you should install UPX!')
########################################################################
######################### Excludes and Includes ########################
########################################################################
print('>>')
print('>> Populating excludes and includes...')
print('>>')
# Excludes
excludes = ['doctest', 'pdb', 'unittest', 'difflib',
'os2emxpath', 'optpath', 'multiprocessing', 'ssl',
'PyQt5.QtWebKit', 'PyQt5.QtNetwork']
if sys.platform == 'nt':
excludes.append('posixpath')
# Add excludes for other Qt modules
unneededQtModules = ['Designer', 'Network', 'OpenGL', 'Qml', 'Script', 'Sql', 'Test', 'WebKit', 'Xml']
neededQtModules = ['Core', 'Gui', 'Widgets']
targetQt = 'PyQt' + str(4 if sys.version_info.major < 3 else 5)
print('>> Targeting ' + targetQt)
for qt in ['PySide2', 'PyQt4', 'PyQt5']:
# Exclude all the stuff we don't use
for m in unneededQtModules:
excludes.append(qt + '.Qt' + m)
if qt != targetQt:
# Since we're not using this copy of Qt, exclude it
excludes.append(qt)
# As well as its QtCore/QtGui/etc
for m in neededQtModules:
excludes.append(qt + '.Qt' + m)
# Includes
includes = ['pkgutil']
# Binary excludes
excludes_binaries = []
if sys.platform == 'win32':
excludes_binaries = [
# Qt stuff
'Qt5Network.dll', 'Qt5Qml.dll', 'Qt5QmlModels.dll',
'Qt5Quick.dll', 'Qt5WebSockets.dll',
# Other stuff
'opengl32sw.dll',
'd3dcompiler_', # currently (2020-09-25) "d3dcompiler_47.dll",
# but that'll probably change eventually, so we
# just exclude anything that starts with this
# substring
]
elif sys.platform == 'darwin':
# Sadly, we can't exclude anything on macOS -- it just crashes. :(
# If a workaround could be found, here's the list we'd use:
# excludes_binaries = [
# # Qt stuff (none of these have any file extensions at all)
# 'QtNetwork', 'QtPrintSupport', 'QtQml', 'QtQmlModels',
# 'QtQuick', 'QtWebSockets',
# ]
pass
elif sys.platform == 'linux':
excludes_binaries = [
# Qt stuff
# Currently (2020-09-25) these all end with ".so.5", but that
# may change, so we exclude anything that starts with these
# substrings
'libQt5Network.so', 'libQt5Qml.so', 'libQt5QmlModels.so',
'libQt5Quick.so', 'libQt5WebSockets.so',
# Other stuff
'libgtk-3.so',
]
print('>> Will use the following excludes list: ' + ', '.join(excludes))
print('>> Will use the following includes list: ' + ', '.join(includes))
print('>> Will use the following binaries excludes list: ' + ', '.join(excludes_binaries))
########################################################################
################### Running PyInstaller (first time) ###################
########################################################################
# Our only goal here is to create a specfile we can edit. Unfortunately,
# there's no good way to do that without doing a full PyInstaller
# build...
args = [
'--windowed',
'--onefile',
'--upx-dir=/path/to/upx',
'--upx-exclude=vcruntime140.dll',
'--distpath=' + DIR,
'--workpath=' + WORKPATH,
]
if sys.platform == 'win32':
args.append('--icon=' + os.path.abspath(WIN_ICON))
elif sys.platform == 'darwin':
args.append('--icon=' + os.path.abspath(MAC_ICON))
args.append('--osx-bundle-identifier=' + MAC_BUNDLE_IDENTIFIER)
for e in excludes:
args.append('--exclude-module=' + e)
for i in includes:
args.append('--hidden-import=' + i)
args.extend(sys.argv[1:])
args.append(SCRIPT_FILE)
run_pyinstaller(args)
shutil.rmtree(DIR)
shutil.rmtree(WORKPATH)
########################################################################
########################## Adjusting specfile ##########################
########################################################################
print('>> Adjusting specfile...')
# New plist file data (if on Mac)
info_plist = {
'CFBundleName': PROJECT_NAME,
'CFBundleDisplayName': FULL_PROJECT_NAME,
'CFBundleShortVersionString': PROJECT_VERSION,
'CFBundleGetInfoString': FULL_PROJECT_NAME + ' ' + PROJECT_VERSION,
'CFBundleExecutable': SCRIPT_FILE.split('.')[0],
}
# Open original specfile
with open(SPECFILE, 'r', encoding='utf-8') as f:
lines = f.read().splitlines()
# Iterate over its lines, and potentially add new ones
new_lines = []
insert_info_plist = False
for line in lines:
if 'PYZ(' in line and excludes_binaries:
new_lines.append('EXCLUDES = ' + repr(excludes_binaries))
new_lines.append('new_binaries = []')
new_lines.append('for x, y, z in a.binaries:')
new_lines.append(' for e in EXCLUDES:')
new_lines.append(' if x.startswith(e):')
new_lines.append(' print("specfile: excluding " + x)')
new_lines.append(' break')
new_lines.append(' else:')
new_lines.append(' new_binaries.append((x, y, z))')
new_lines.append('a.binaries = new_binaries')
new_lines.append(line)
if insert_info_plist:
new_lines.append(' info_plist=' + json.dumps(info_plist) + ',')
insert_info_plist = False
if sys.platform == 'darwin' and 'BUNDLE(' in line:
# We cannot insert the info_plist keyword argument now, as the next
# argument is not a keyword argument. As such, we set a flag to add it
# after the next line.
insert_info_plist = True
# Save new specfile
with open(SPECFILE, 'w', encoding='utf-8') as f:
f.write('\n'.join(new_lines))
########################################################################
################### Running PyInstaller (second time) ##################
########################################################################
# Most of the arguments are now contained in the specfile. Thus, we can
# run with minimal arguments this time.
args = [
'--windowed',
'--upx-dir=/path/to/upx',
'--upx-exclude=vcruntime140.dll',
'--distpath=' + DIR,
'--workpath=' + WORKPATH,
SPECFILE,
]
run_pyinstaller(args)
shutil.rmtree(WORKPATH)
os.remove(SPECFILE)
########################################################################
######################## Copying required files ########################
########################################################################
print('>> Copying required files...')
if sys.platform == 'darwin':
dest_folder = os.path.join(DIR, AUTO_APP_BUNDLE_NAME, 'Contents', 'Resources')
else:
dest_folder = DIR
for f in DATA_FOLDERS:
if os.path.isdir(os.path.join(dest_folder, f)):
shutil.rmtree(os.path.join(dest_folder, f))
shutil.copytree(f, os.path.join(dest_folder, f))
for f in DATA_FILES:
shutil.copy(f, dest_folder)
########################################################################
################################ Cleanup ###############################
########################################################################
print('>> Cleaning up...')
# On macOS, there's a second "reggie" executable for some reason,
# separate from the app bundle. I don't know why it's there, but we
# delete it.
if sys.platform == 'darwin':
leftover_executable = os.path.join(DIR, SCRIPT_FILE.split('.')[0])
if os.path.isfile(leftover_executable):
os.unlink(leftover_executable)
# Also on macOS, we have to rename the .app folder to the display name
# because CFBundleDisplayName is dumb and doesn't actually affect
# the app name shown in Finder
if sys.platform == 'darwin':
os.rename(os.path.join(DIR, AUTO_APP_BUNDLE_NAME), os.path.join(DIR, FINAL_APP_BUNDLE_NAME))
########################################################################
################################## End #################################
########################################################################
print('>> %s has been built to the %s folder!' % (PROJECT_NAME, DIR))