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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601import argparse
import subprocess
from pathlib import Path
import json
import shutil
import re
from typing import Callable
import sys
from datetime import datetime
import time
import os
from dataclasses import dataclass
class UnrealIni:
def __init__(self, content: str):
commentmatch = re.compile(r";(.*)")
subsectionmatch = re.compile(r"\[(.*)\]")
valuematch = re.compile(r"([^=]*)=(.*)")
subsections = []
cur_section = []
cur_section_name = []
for line in content.splitlines():
m_comment = commentmatch.match(line)
m1 = subsectionmatch.match(line)
m2 = valuematch.match(line)
if m_comment is not None:
subsections.append((None, m_comment.group(1)))
elif m1 is not None:
if len(cur_section) > 0:
subsections.append((cur_section_name, cur_section))
cur_section_name = m1.group(1)
cur_section = []
elif m2 is not None:
cur_section.append((m2.group(1), m2.group(2)))
if len(cur_section) > 0:
subsections.append((cur_section_name, cur_section))
self.subsections = subsections
assert self.reconstruct().strip("\n") == content.strip("\n")
def reconstruct(self):
reconstructed = ""
for name, values in self.subsections:
if name is None:
reconstructed += ";" + values + "\n"
else:
reconstructed += "[" + name + "]\n"
for k, v in values:
reconstructed += f"{k}={v}\n"
reconstructed += "\n"
return reconstructed
def update_value(self, enabled, value, modifier):
done_update = False
(target_section, target_key) = value
for name, values in self.subsections:
if name == target_section:
for i, (k, v) in enumerate(values):
if k == target_key:
done_update = True
values[i] = [k, modifier(enabled, v)]
print(self.reconstruct())
@dataclass
class BuildFlavour:
flavour_name: str
plugin_name: str
engine_keys: tuple[str,dict] | None = None
engine_version_override: str | None = None
dont_build: bool = False
def update_uproject(self, project_dict: dict, enabled: bool):
if not self.plugin_name:
return True
found_plugin = False
for plugin_info in project_dict["Plugins"]:
name = plugin_info["Name"]
if name == self.plugin_name:
found_plugin = True
plugin_info["Enabled"] = enabled
return found_plugin
def update_defaultengine(self, config_ini: UnrealIni, enabled: bool):
if self.engine_keys != None:
for val, modifier in self.engine_keys:
print(val, modifier)
config_ini.update_value(enabled, val, modifier)
return config_ini.reconstruct()
BUILD_FLAVOURS = [
BuildFlavour(
"quest",
"OculusXR",
[
(
(
"/Script/AndroidRuntimeSettings.AndroidRuntimeSettings",
"bPackageForMetaQuest",
),
lambda enabled, current: str(enabled),
),
(
(
"/Script/AndroidRuntimeSettings.AndroidRuntimeSettings",
"ExtraApplicationSettings",
),
lambda enabled, current: (
r'<meta-data android:name="com.oculus.supportedDevices" android:value="quest|quest2|questpro" />'
if enabled
else ""
),
),
(
(
"/Script/AndroidRuntimeSettings.AndroidRuntimeSettings",
"MinSDKVersion",
),
lambda enabled, current: r"32" if enabled else current,
),
(
(
"/Script/AndroidRuntimeSettings.AndroidRuntimeSettings",
"TargetSDKVersion",
),
lambda enabled, current: r"32" if enabled else current,
),
],
),
BuildFlavour(
"android",
"XRBase",
[
(
(
"/Script/Engine.RendererSettings",
"vr.MobileMultiView",
),
lambda enabled, current: "False" if enabled else "True",
),
],
),
BuildFlavour(
"pico",
"PICOOpenXR",
[
(
(
"/Script/AndroidRuntimeSettings.AndroidRuntimeSettings",
"MinSDKVersion",
),
lambda enabled, current: r"29" if enabled else current,
),
(
(
"/Script/AndroidRuntimeSettings.AndroidRuntimeSettings",
"TargetSDKVersion",
),
lambda enabled, current: r"29" if enabled else current,
),
(
(
"/Script/AndroidRuntimeSettings.AndroidRuntimeSettings",
"ExtraActivitySettings",
),
lambda enabled, current: (
r'<meta-data android:name="pvr.app.type" android:value="vr" />'
if enabled
else current.replace(
'<meta-data android:name="pvr.app.type" android:value="vr" />',
"",
)
),
),
],
),
BuildFlavour("vivefocus", "ViveOpenXR", engine_version_override="5.3"),
BuildFlavour("old_pico", "PicoXR", dont_build=True),
]
parser = argparse.ArgumentParser(
prog="MakeReleases",
description="Makes releases of directvideoexample for a particular target device",
)
subparsers = parser.add_subparsers(help="Command to run", required=True, dest="command")
parser_launch = subparsers.add_parser(
"launch", help="Launch the uproject in Unreal Editor"
)
parser_launch.add_argument("engine_version", help="Version of editor to run")
parser_launch.add_argument(
"--ue-path",
"-ue",
default="c:\\epic\\",
help="Path to folder containng Unreal Engine versions",
type=Path,
)
parser_build = subparsers.add_parser("build", help="Build the example")
parser_build.add_argument(
"--ue-path", "-ue", default="c:\\epic\\", help="Path to Unreal Engine builds"
)
parser_build.add_argument(
"--engine-version", default="5.5", help="Version of engine to use", type=str
)
parser_build.add_argument(
"device",
nargs="+",
help="One or more devices to build for, or 'all' to build everything.",
choices=[x.flavour_name for x in BUILD_FLAVOURS] + ["all"],
)
parser_build.add_argument(
"--development", "-d", help="make development build", action="store_true"
)
parser_build.add_argument(
"--install", "-i", help="install to device after build", action="store_true"
)
parser_build.add_argument(
"--run", "-r", help="Run app after build", action="store_true"
)
parser_build.add_argument(
"--grablog",
"-g",
help="Run app and save log to log_<date>.txt",
action="store_true",
)
parser_build.add_argument("--logname", "-l", help="Set log text file name")
parser_build.add_argument(
"--sanitizer", "-s", help="Set sanitizer", choices=["asan", "ubsan", "tsan"]
)
parser_build.add_argument(
"--skipbuild", "-sb", help="Skip the build step", action="store_true"
)
validation_group = parser_build.add_mutually_exclusive_group()
validation_group.add_argument(
"--validation", help="Do vulkan validation", action="store_true"
)
validation_group.add_argument(
"--novalidation", help="Don't do vulkan validation", action="store_false"
)
parser_release = subparsers.add_parser("release", help="Upload github release")
parser_release.add_argument("version", help="version tag for release")
parser_release.add_argument(
"--force", "-f", help="Update existing release if tag exists", action="store_true"
)
parser_run = subparsers.add_parser(
"run", help="Run the project on device"
)
parser_run.add_argument(
"device",
help="A device to run on.",
choices=[x.flavour_name for x in BUILD_FLAVOURS],
)
parser_run.add_argument("--development", "-d", help="Run development build", action="store_true")
parser_run.add_argument(
"--grablog",
"-g",
help="Run app and save log to log_<date>.txt",
action="store_true",
)
parser_run.add_argument("--logname", "-l", help="Set log text file name")
args = parser.parse_args()
if getattr(args,"logname",None) is not None:
args.grablog = True
project_folder = Path(__file__).parent
project_short_name = project_folder.name
project_file = list(project_folder.glob("*.uproject"))[0]
defaultengine_file = project_folder / "Config/DefaultEngine.ini"
if (args.command != "release") and getattr(args, "development", False):
release_folder = Path(__file__).parent / "DevReleases"
else:
release_folder = Path(__file__).parent / "Releases"
def command_launch(args):
ue_base_path = args.ue_path
if re.match(r"UE_\d+\.\d+", ue_base_path.name):
# path to a single engine, get parent path to choose version
ue_base_path = ue_base_path.parent
version = args.engine_version
version_groups = re.match(r"(\d+)\.(\d+)(.(\d+))*", version)
editor_path = None
if version_groups:
maj = version_groups.group(1)
min = version_groups.group(2)
editor_path = (
ue_base_path
/ f"UE_{maj}.{min}"
/ "Engine"
/ "Binaries"
/ "Win64"
/ "UnrealEditor.exe"
)
if editor_path and editor_path.exists():
subprocess.Popen(
[editor_path, project_file, '-logcmds="LogDerivedDataCache Verbose"']
)
else:
print(f"Bad engine version number {args.engine_version}:{editor_path}")
sys.exit(-1)
def command_build(args):
use_validation_layer = False
if args.development:
use_validation_layer = args.novalidation
else:
use_validation_layer = args.validation
enabled_build_plugins = []
if "all" in args.device:
enabled_build_plugins = [f for f in BUILD_FLAVOURS if not f.dont_build]
else:
for f in BUILD_FLAVOURS:
if f.flavour_name in args.device:
enabled_build_plugins.append(f)
if args.install:
if len(enabled_build_plugins) != 1:
print("Can only call install with a single build flavour")
sys.exit(-1)
print("Building for:", [f.flavour_name for f in enabled_build_plugins])
print("*****************************")
orig_project_file = project_file.read_text()
uproject_data = json.loads(orig_project_file)
orig_defaultengine_file = defaultengine_file.read_text()
try:
defaultengine_data = UnrealIni(orig_defaultengine_file)
release_folder.mkdir(exist_ok=True)
for current_flavour in enabled_build_plugins:
for all_flavour in BUILD_FLAVOURS:
enabled = all_flavour.flavour_name == current_flavour.flavour_name
plugin_found = all_flavour.update_uproject(uproject_data, enabled)
if not plugin_found and enabled and not all_flavour.dont_build:
print(
f"Plugin {all_flavour.plugin_name} not found in uproject file"
)
sys.exit(-1)
all_flavour.update_defaultengine(defaultengine_data, enabled)
if current_flavour.engine_version_override is None:
engine_path = Path(args.ue_path) / f"UE_{args.engine_version}"
else:
engine_path = (
Path(args.ue_path) / f"UE_{current_flavour.engine_version_override}"
)
# set derived data cache path to be different for each build flavour
# because e.g. quest, pico, and android versions of cached assets are incompatible
# and don't always get rebuilt if the plugins change
engine_version = (
current_flavour.engine_version_override or args.engine_version
)
os.environ["UE-LocalDataCachePath"] = str(
project_folder
/ "DerivedDataCache"
/ engine_version
/ current_flavour.flavour_name
)
# do vulkan validation in dev builds (or if --validation is on)
for plugin_info in uproject_data["Plugins"]:
name = plugin_info["Name"]
if name == "AndroidVulkanValidation":
plugin_info["Enabled"] = use_validation_layer
project_file.write_text(json.dumps(uproject_data, indent=4))
defaultengine_file.write_text(defaultengine_data.reconstruct())
platform_folder = release_folder / current_flavour.flavour_name
if args.skipbuild:
print(f"Skipping build for {current_flavour.flavour_name}")
else:
intermediate_source_folder = Path("Intermediate\\Source")
# remove the intermediate source folder so that it is rebuilt
# because it has autogen project source files which are engine version dependent
if (project_folder / intermediate_source_folder).exists():
shutil.rmtree(
project_folder / intermediate_source_folder, ignore_errors=True
)
print(
f"Building for {current_flavour.flavour_name} in {platform_folder}"
)
if platform_folder.exists():
shutil.rmtree(platform_folder, ignore_errors=True)
platform_folder.mkdir(exist_ok=True)
if args.development:
config = "Development"
else:
config = "Shipping"
cmdline = [
f"{str(engine_path)}\\Engine\\Build\\BatchFiles\\RunUAT.bat",
"buildcookrun",
f"-project={str(project_file)}",
"-platform=android",
"-build",
"-stage",
"-skipbuildeditor",
"-nocompileeditor",
"-package",
"-pak",
"-cook",
"-compressed",
f"-configuration={config}",
"-archive",
f"-archivedirectory={platform_folder}",
]
if args.sanitizer:
cmdline.append(
{
"asan": "-EnableASan",
"ubsan": "-EnableUBSan",
"tsan": "-EnableTSan",
}[args.sanitizer]
)
subprocess.check_call(cmdline, shell=True)
# if the build is to a subfolder of the target folder (e.g. Android / Android_ASTC etc.) then move that up one
if (platform_folder / "Android").exists():
for x in (platform_folder / "Android").iterdir():
shutil.move(x, platform_folder)
if args.install or args.run or args.grablog:
# Check for connected devices before install/run
while True:
print("Checking for connected Android devices...")
result = subprocess.run(
["adb", "devices"], capture_output=True, text=True
)
lines = result.stdout.strip().splitlines()
if len(lines) < 2 or not any(line.strip() for line in lines[1:]):
print(
"No Android device detected by adb. Please connect a device and try again."
)
time.sleep(2)
else:
print("Found connected Android device")
break
# find the install batch file
for b in platform_folder.glob("*.bat"):
if b.name.lower().startswith("install"):
subprocess.check_call(
[str(b)], shell=True, cwd=str(platform_folder)
)
break
if args.grablog:
subprocess.check_call(
["adb", "logcat", "-c"], shell=True, cwd=str(project_folder)
)
if args.run or args.grablog:
subprocess.check_call(
[
"adb",
"shell",
"am",
"start",
"-n",
"com.YourCompany.DirectVideoExample/com.epicgames.unreal.GameActivity",
]
)
if args.grablog:
if args.logname:
log_name = args.logname
else:
now = datetime.now()
log_name = now.strftime(
f"{project_short_name}-%Y_%m_%d-%H_%M_%S.txt"
)
print(f"Grabbing log to {log_name}. Press ctrl+c to exit")
subprocess.check_call(
["adb", "logcat", ">", str(log_name)],
shell=True,
cwd=str(project_folder),
)
finally:
project_file.write_text(orig_project_file)
defaultengine_file.write_text(orig_defaultengine_file)
def command_release(args):
version = args.version
if not version.startswith("v"):
version = "v" + version
print("Version:", version)
cmdline = ["gh", "release", "create", version, "--notes", f"Release {version}"]
if args.force:
# ignore if release already exists
subprocess.call(cmdline)
else:
subprocess.check_call(cmdline)
uploading_zips = []
for subfolder in release_folder.iterdir():
if subfolder.is_dir():
# make a zip from this folder
print(f"Making zip {subfolder}")
uploading_zips.append(
shutil.make_archive(
str(subfolder), format="zip", root_dir=subfolder, base_dir=subfolder
)
)
print("Uploading:", *uploading_zips)
subprocess.check_call(
["gh", "release", "upload", version, "--clobber"]
+ [str(x) for x in uploading_zips]
)
def command_run(args):
device = args.device
if args.development:
print(f"Running development build on {device}")
else:
print(f"Running release build on {device}")
current_flavour = None
for f in BUILD_FLAVOURS:
if f.flavour_name == args.device:
current_flavour = f
if current_flavour is None:
print(f"Unknown device {args.device}")
sys.exit(-1)
while True:
print("Checking for connected Android devices...")
result = subprocess.run(
["adb", "devices"], capture_output=True, text=True
)
lines = result.stdout.strip().splitlines()
if len(lines) < 2 or not any(line.strip() for line in lines[1:]):
print(
"No Android device detected by adb. Please connect a device and try again."
)
time.sleep(2)
else:
print("Found connected Android device")
break
# find the install batch file
platform_folder = release_folder / current_flavour.flavour_name
for b in platform_folder.glob("*.bat"):
if b.name.lower().startswith("install"):
subprocess.check_call(
[str(b)], shell=True, cwd=str(platform_folder)
)
break
if args.grablog:
subprocess.check_call(
["adb", "logcat", "-c"], shell=True, cwd=str(project_folder)
)
# run it
subprocess.check_call(
[
"adb",
"shell",
"am",
"start",
"-n",
"com.YourCompany.DirectVideoExample/com.epicgames.unreal.GameActivity",
]
)
# log it
if args.grablog:
if args.logname:
log_name = args.logname
else:
now = datetime.now()
log_name = now.strftime(
f"{project_short_name}-%Y_%m_%d-%H_%M_%S.txt"
)
print(f"Grabbing log to {log_name}. Press ctrl+c to exit")
subprocess.check_call(
["adb", "logcat", ">", str(log_name)],
shell=True,
cwd=str(project_folder),
)
locals()["command_" + args.command](args)