Create a launchConfig.zon that can be used to overwrite the global cubyz dir and save location

fixes PixelGuys#1836

Author: IntegratedQuantum

.github/workflows/release.yml

@@ -20,16 +20,16 @@ jobs:
           version: ${{ env.VERSION }}
 
       - run: zig build -Dtarget=x86_64-linux-gnu -Doptimize=ReleaseFast -Drelease=true -Dcpu=baseline
-      - run: tar -czf Linux-x86_64.tar.gz --transform 's,^,Cubyz/,' assets/cubyz -C zig-out/bin Cubyz
+      - run: tar -czf Linux-x86_64.tar.gz --transform 's,^,Cubyz/,' assets/cubyz launchConfig.zon -C zig-out/bin Cubyz
 
       - run: zig build -Dtarget=aarch64-linux-gnu -Doptimize=ReleaseFast -Drelease=true -Dcpu=baseline
-      - run: tar -czf Linux-aarch64.tar.gz --transform 's,^,Cubyz/,' assets/cubyz -C zig-out/bin Cubyz
+      - run: tar -czf Linux-aarch64.tar.gz --transform 's,^,Cubyz/,' assets/cubyz launchConfig.zon -C zig-out/bin Cubyz
 
       - run: zig build -Dtarget=x86_64-windows-gnu -Doptimize=ReleaseFast -Drelease=true -Dcpu=baseline
-      - run: tar -czf Windows-x86_64.tar.gz --transform 's,^,Cubyz/,' assets/cubyz -C zig-out/bin Cubyz.exe
+      - run: tar -czf Windows-x86_64.tar.gz --transform 's,^,Cubyz/,' assets/cubyz launchConfig.zon -C zig-out/bin Cubyz.exe
 
       - run: zig build -Dtarget=aarch64-windows-gnu -Doptimize=ReleaseFast -Drelease=true -Dcpu=baseline
-      - run: tar -czf Windows-aarch64.tar.gz --transform 's,^,Cubyz/,' assets/cubyz -C zig-out/bin Cubyz.exe
+      - run: tar -czf Windows-aarch64.tar.gz --transform 's,^,Cubyz/,' assets/cubyz launchConfig.zon -C zig-out/bin Cubyz.exe
 
       - name: Create release
         env:

.gitignore

@@ -6,6 +6,7 @@ zig-cache/
 serverAssets/
 gamecontrollerdb.txt
 gamecontrollerdb.stamp
+launchConfig.zon
 
 test.png
 

build.zig

@@ -141,7 +141,18 @@ pub fn makeModFeaturesStep(step: *std.Build.Step, _: std.Build.Step.MakeOptions)
 	try makeModFeature(step, "rotation");
 }
 
+fn createLaunchConfig() !void {
+	std.fs.cwd().access("launchConfig.zon", .{}) catch {
+		try std.fs.cwd().writeFile(.{
+			.data = ".{\n\t.cubyzDir = \"\",\n}\n",
+			.sub_path = "launchConfig.zon",
+		});
+	};
+}
+
 pub fn build(b: *std.Build) !void {
+	try createLaunchConfig();
+
 	// Standard target options allows the person running `zig build` to choose
 	// what target to build for. Here we do not override the defaults, which
 	// means any target is allowed, and the default is native. Other options

src/files.zig

@@ -51,16 +51,21 @@ pub fn cubyzDirStr() []const u8 {
 }
 
 fn flawedInit() !void {
+	if(main.settings.launchConfig.cubyzDir.len != 0) {
+		cubyzDir_ = try std.fs.cwd().makeOpenPath(main.settings.launchConfig.cubyzDir, .{});
+		cubyzDirStr_ = main.globalAllocator.dupe(u8, main.settings.launchConfig.cubyzDir);
+		return;
+	}
 	const homePath = try std.process.getEnvVarOwned(main.stackAllocator.allocator, if(builtin.os.tag == .windows) "USERPROFILE" else "HOME");
 	defer main.stackAllocator.free(homePath);
 	var homeDir = try std.fs.openDirAbsolute(homePath, .{});
 	defer homeDir.close();
 	if(builtin.os.tag == .windows) {
 		cubyzDir_ = try homeDir.makeOpenPath("Saved Games/Cubyz", .{});
-		cubyzDirStr_ = std.mem.concat(main.stackAllocator.allocator, u8, &.{homePath, "/Saved Games/Cubyz"}) catch unreachable;
+		cubyzDirStr_ = std.mem.concat(main.globalAllocator.allocator, u8, &.{homePath, "/Saved Games/Cubyz"}) catch unreachable;
 	} else {
 		cubyzDir_ = try homeDir.makeOpenPath(".cubyz", .{});
-		cubyzDirStr_ = std.mem.concat(main.stackAllocator.allocator, u8, &.{homePath, "/.cubyz"}) catch unreachable;
+		cubyzDirStr_ = std.mem.concat(main.globalAllocator.allocator, u8, &.{homePath, "/.cubyz"}) catch unreachable;
 	}
 }
 
@@ -75,7 +80,7 @@ pub fn deinit() void {
 		cubyzDir_.?.close();
 	}
 	if(cubyzDirStr_.ptr != ".".ptr) {
-		main.stackAllocator.free(cubyzDirStr_);
+		main.globalAllocator.free(cubyzDirStr_);
 	}
 }
 

src/main.zig

@@ -578,6 +578,9 @@ pub fn main() void { // MARK: main()
 	gui.initWindowList();
 	defer gui.deinitWindowList();
 
+	settings.launchConfig.init();
+	defer settings.launchConfig.deinit();
+
 	files.init();
 	defer files.deinit();
 

src/renderer.zig

@@ -538,19 +538,19 @@ pub const MenuBackGround = struct {
 	}
 
 	fn chooseBackgroundImagePath(allocator: main.heap.NeverFailingAllocator) ![]const u8 {
+		var dir = try main.files.cubyzDir().openIterableDir("backgrounds");
+		defer dir.close();
+
 		// Whenever the version changes copy over the new background image and display it.
 		if(!std.mem.eql(u8, settings.lastVersionString, settings.version.version)) {
 			const defaultImageData = try main.files.cwd().read(main.stackAllocator, "assets/cubyz/default_background.png");
 			defer main.stackAllocator.free(defaultImageData);
-			try main.files.cubyzDir().write("backgrounds/default_background.png", defaultImageData);
+			try dir.write("default_background.png", defaultImageData);
 
 			return std.fmt.allocPrint(allocator.allocator, "{s}/backgrounds/default_background.png", .{main.files.cubyzDirStr()}) catch unreachable;
 		}
 
 		// Otherwise load a random texture from the backgrounds folder. The player may make their own pictures which can be chosen as well.
-		var dir = try main.files.cubyzDir().openIterableDir("backgrounds");
-		defer dir.close();
-
 		var walker = dir.walk(main.stackAllocator);
 		defer walker.deinit();
 		var fileList = main.List([]const u8).init(main.stackAllocator);

src/settings.zig

@@ -182,3 +182,21 @@ pub fn save() void {
 		std.log.err("Couldn't write settings to file: {s}", .{@errorName(err)});
 	};
 }
+
+pub const launchConfig = struct {
+	pub var cubyzDir: []const u8 = "";
+
+	pub fn init() void {
+		const zon: ZonElement = main.files.cwd().readToZon(main.stackAllocator, "launchConfig.zon") catch |err| blk: {
+			std.log.err("Could not read launchConfig.zon: {s}", .{@errorName(err)});
+			break :blk .null;
+		};
+		defer zon.deinit(main.stackAllocator);
+
+		cubyzDir = main.globalAllocator.dupe(u8, zon.get([]const u8, "cubyzDir", cubyzDir));
+	}
+
+	pub fn deinit() void {
+		main.globalAllocator.free(cubyzDir);
+	}
+};