From 3b5d64703f50d6ecbb70b3bc2d5a9a1922d5d9a1 Mon Sep 17 00:00:00 2001 From: wixoaGit Date: Thu, 19 Oct 2023 23:29:21 -0400 Subject: [PATCH] Slight documentation --- OpenDreamPackageTool/ClientPackaging.cs | 3 +++ OpenDreamPackageTool/ServerPackaging.cs | 3 +++ OpenDreamPackageTool/TgsPackaging.cs | 4 ++++ 3 files changed, 10 insertions(+) diff --git a/OpenDreamPackageTool/ClientPackaging.cs b/OpenDreamPackageTool/ClientPackaging.cs index 26970c0eb0..0b2c1c8fd8 100644 --- a/OpenDreamPackageTool/ClientPackaging.cs +++ b/OpenDreamPackageTool/ClientPackaging.cs @@ -3,6 +3,9 @@ namespace OpenDreamPackageTool; +/// +/// Packages the client's resources & assemblies in a format ready to be downloaded by connecting clients +/// public static class ClientPackaging { private static readonly string[] ClientIgnoredResources = { "Maps", diff --git a/OpenDreamPackageTool/ServerPackaging.cs b/OpenDreamPackageTool/ServerPackaging.cs index d3ecf57585..fa0a810c8c 100644 --- a/OpenDreamPackageTool/ServerPackaging.cs +++ b/OpenDreamPackageTool/ServerPackaging.cs @@ -4,6 +4,9 @@ namespace OpenDreamPackageTool; +/// +/// Packages the server, and optionally the client alongside for hybrid ACZ +/// public static class ServerPackaging { private static readonly PlatformReg[] Platforms = { new("win-x64", "Windows", true), diff --git a/OpenDreamPackageTool/TgsPackaging.cs b/OpenDreamPackageTool/TgsPackaging.cs index 78a5a90894..c65f6c0f2c 100644 --- a/OpenDreamPackageTool/TgsPackaging.cs +++ b/OpenDreamPackageTool/TgsPackaging.cs @@ -4,6 +4,10 @@ namespace OpenDreamPackageTool; +/// +/// Packages the OpenDream server, client (hybrid ACZ), and compiler in a format friendly for TGS +/// See https://github.com/OpenDreamProject/OpenDream/issues/1495 +/// public static class TgsPackaging { public static void Package(Program.TgsOptions options) { if (Directory.Exists(options.OutputDir)) {