Make Copy: keep the movies, optional extras (#33)

Portable copies made with Make Copy... now include the game's movies. The save dialog has a checkbox for each optional folder the game folder has (the movies, the language packs), all ticked for a full copy.

Author: 007hacky007

README.md

@@ -331,7 +331,7 @@ the app › Open). If macOS says the app is damaged, run once in Terminal:
 
 **Can I carry the game to another Mac in one piece?**
 Yes. In the app's window, **Make Copy…** creates "NFSU2 Portable.app" with the
-game files inside (about 1.4 GB). It runs on its own; saves stay in
+game files inside: about 1.4 GB, plus the movies (1.1 GB) and the language packs in `LANGPACKS` if the game folder has them. Untick those when saving it for a smaller copy. It runs on its own; saves stay in
 `~/Library/Application Support/NFSU2 Saves` on each Mac. It contains the game,
 so keep it for yourself.
 

launcher/Model.swift

@@ -189,17 +189,41 @@ final class LauncherModel: ObservableObject {
         p.directoryURL = FileManager.default.isWritableFile(atPath: "/Applications")
             ? URL(fileURLWithPath: "/Applications")
             : FileManager.default.urls(for: .desktopDirectory, in: .userDomainMask).first
+        // A checkbox for each optional folder the game has, all on: a full copy unless unticked.
+        var boxes: [(String, NSButton)] = []
+        for (x, size) in PortableBuilder.extras(in: loc.folder) {
+            let b = NSButton(checkboxWithTitle: "Include " + x.title + " ("
+                             + ByteCountFormatter.string(fromByteCount: size, countStyle: .file) + ")",
+                             target: nil, action: nil)
+            b.toolTip = "Without: " + x.without + "."
+            b.state = .on
+            b.sizeToFit()
+            boxes.append((x.folder, b))
+        }
+        if !boxes.isEmpty {
+            let h = boxes.reduce(CGFloat(16)) { $0 + $1.1.frame.height + 6 }
+            let w = boxes.map { $0.1.frame.width }.max()! + 40
+            let v = NSView(frame: NSRect(x: 0, y: 0, width: w, height: h))
+            var y = h - 8
+            for (_, b) in boxes {
+                y -= b.frame.height
+                b.setFrameOrigin(NSPoint(x: 20, y: y))
+                y -= 6
+                v.addSubview(b)
+            }
+            p.accessoryView = v
+        }
         guard p.runModal() == .OK, var dest = p.url else { return }
         if dest.pathExtension.lowercased() != "app" { dest.appendPathExtension("app") }
         if dest.standardizedFileURL == Paths.bundle.standardizedFileURL {
             alert("Choose another name", "The copy can't replace the app that is running.")
             return
         }
-        startPortable(from: loc.folder, to: dest)
+        startPortable(from: loc.folder, to: dest, leaveOut: Set(boxes.filter { $0.1.state == .off }.map { $0.0 }))
     }
 
-    func startPortable(from game: URL, to dest: URL) {
-        let b = PortableBuilder(sourceApp: Paths.bundle, gameFolder: game, destination: dest)
+    func startPortable(from game: URL, to dest: URL, leaveOut: Set<String> = []) {
+        let b = PortableBuilder(sourceApp: Paths.bundle, gameFolder: game, destination: dest, leaveOut: leaveOut)
         builder = b
         job = Job(phase: "Starting…")
         DispatchQueue.global(qos: .userInitiated).async {

launcher/Portable.swift

@@ -21,14 +21,37 @@ final class PortableBuilder {
     private let lock = NSLock()
     private var cancelFlag = false
 
-    // The engine never reads these: no video decoder (MOVIES, ~250 MB) and Windows-only plugins.
-    static let skippedGameItems: Set<String> = ["MOVIES", "SCRIPTS", "dinput8.dll", "server.dll",
+    // The engine never reads these: Windows-only plugins and scripts.
+    static let skippedGameItems: Set<String> = ["SCRIPTS", "dinput8.dll", "server.dll",
                                                 "server.cfg", "SafeMode.bat"]
+    // Copied unless left out (the Make Copy dialog's checkboxes): the game plays on without them.
+    struct Extra { let folder: String; let title: String; let without: String }
+    static let extras = [
+        Extra(folder: "MOVIES", title: "the movies", without: "the game skips its movies"),
+        Extra(folder: "LANGPACKS", title: "the language packs", without: "only the languages in LANGUAGES"),
+    ]
 
-    init(sourceApp: URL, gameFolder: URL, destination: URL) {
+    let leaveOut: Set<String>    // folder names of `extras`, upper case
+
+    init(sourceApp: URL, gameFolder: URL, destination: URL, leaveOut: Set<String> = []) {
         self.sourceApp = sourceApp
         self.gameFolder = gameFolder
         self.destination = destination
+        self.leaveOut = Set(leaveOut.map { $0.uppercased() })
+    }
+
+    /// The extras the game folder has, with their sizes.
+    static func extras(in gameFolder: URL) -> [(Extra, Int64)] {
+        let fm = FileManager.default
+        let names = (try? fm.contentsOfDirectory(atPath: gameFolder.path)) ?? []
+        return extras.compactMap { x in
+            guard let name = names.first(where: { $0.caseInsensitiveCompare(x.folder) == .orderedSame }),
+                  let e = fm.enumerator(at: gameFolder.appendingPathComponent(name),
+                                        includingPropertiesForKeys: [.fileSizeKey]) else { return nil }
+            var total: Int64 = 0
+            for case let u as URL in e { total += Int64((try? u.resourceValues(forKeys: [.fileSizeKey]))?.fileSize ?? 0) }
+            return (x, total)
+        }
     }
 
     func cancel() { lock.lock(); cancelFlag = true; lock.unlock() }
@@ -101,7 +124,10 @@ final class PortableBuilder {
 
         report(Progress(done: 0, total: 0, phase: "Looking at the game files…"))
         let appItems = list(sourceApp) { rel, _ in rel == "Contents/Resources/Game" || rel == "Contents/_CodeSignature" }
-        let gameItems = list(gameFolder) { rel, level in level == 1 && Self.skippedGameItems.contains(rel) }
+        let gameItems = list(gameFolder) { rel, level in
+            level == 1 && (Self.skippedGameItems.contains(rel)
+                           || leaveOut.contains(rel.uppercased()))
+        }
         let total = (appItems + gameItems).reduce(Int64(0)) { $0 + $1.size }
 
         // Clones on the same disk need no space; on another disk the whole size is needed.

launcher/Views.swift

@@ -161,7 +161,7 @@ struct MoreCard: View {
             HStack(alignment: .center, spacing: 12) {
                 VStack(alignment: .leading, spacing: 2) {
                     Text("Portable copy").font(.system(size: 12.5, weight: .medium)).foregroundColor(Theme.text)
-                    Text("One app with the game inside (about 1.4 GB), for another Mac or a USB drive.")
+                    Text("One app with the game inside, for another Mac or a USB drive. Movies and language packs can be left out to make it smaller.")
                         .font(.system(size: 11)).foregroundColor(Theme.dim)
                         .fixedSize(horizontal: false, vertical: true)
                 }

launcher/main.swift

@@ -16,6 +16,7 @@
 //   NFSU2_LAUNCHER_SNAPSHOT=x.png  draw the window into a PNG and quit (never shown)
 //   NFSU2_LAUNCHER_STATE=ready|notfound|unsupported|embedded|copying|done   fake state for the snapshot
 //   NFSU2_LAUNCHER_TEST=portable:<game folder>:<destination.app>   build a portable copy, quit
+//                                (NFSU2_LAUNCHER_TEST_LEAVE_OUT=MOVIES,LANGPACKS: without those)
 //   NFSU2_LAUNCHER_TEST=play     window off screen, press Play after a second (tests the
 //                                normal path: window open -> Play -> engine)
 import AppKit
@@ -32,7 +33,9 @@ final class AppDelegate: NSObject, NSApplicationDelegate, NSWindowDelegate {
         if let t = env["NFSU2_LAUNCHER_TEST"], t.hasPrefix("portable:") {
             let parts = t.dropFirst("portable:".count).split(separator: ":", maxSplits: 1).map(String.init)
             guard parts.count == 2 else { print("bad NFSU2_LAUNCHER_TEST"); exit(2) }
-            model.startPortable(from: URL(fileURLWithPath: parts[0]), to: URL(fileURLWithPath: parts[1]))
+            model.startPortable(from: URL(fileURLWithPath: parts[0]), to: URL(fileURLWithPath: parts[1]),
+                                leaveOut: Set((env["NFSU2_LAUNCHER_TEST_LEAVE_OUT"] ?? "")
+                                                .split(separator: ",").map(String.init)))
             return
         }