diff --git a/Kiseki.Launcher.Windows/Bootstrapper.cs b/Kiseki.Launcher.Windows/Bootstrapper.cs index 82a9aee..4fc2f4d 100644 --- a/Kiseki.Launcher.Windows/Bootstrapper.cs +++ b/Kiseki.Launcher.Windows/Bootstrapper.cs @@ -1,268 +1,267 @@ +namespace Kiseki.Launcher.Windows; + using System.Diagnostics; using System.Reflection; using Microsoft.Win32; -namespace Kiseki.Launcher.Windows +public class Bootstrapper : Interfaces.IBootstrapper { - public class Bootstrapper : IBootstrapper + public readonly static string Version = Assembly.GetExecutingAssembly().GetName().Version!.ToString()[..^2]; + + private readonly string Payload; + private readonly Dictionary Arguments = new(); + + public event EventHandler? OnHeadingChange; + public event EventHandler? OnProgressBarAdd; + public event EventHandler? OnProgressBarStateChange; + public event EventHandler? OnError; + + public Bootstrapper(string payload) { - public readonly static string Version = Assembly.GetExecutingAssembly().GetName().Version!.ToString()[..^2]; + Payload = payload; + } - private readonly string Payload; - private readonly Dictionary Arguments = new(); - - public event EventHandler? OnHeadingChange; - public event EventHandler? OnProgressBarAdd; - public event EventHandler? OnProgressBarStateChange; - public event EventHandler? OnError; - - public Bootstrapper(string payload) + public bool Initialize() + { + if (!Helpers.Base64.IsBase64String(Payload)) { - Payload = payload; + Error($"Failed to launch {Constants.PROJECT_NAME}", $"Try launching {Constants.PROJECT_NAME} from the website again."); + return false; } - - public bool Initialize() + + // { mode, version, ticket, joinscript } + string[] pieces = Helpers.Base64.ConvertBase64ToString(Payload).Split("|"); + if (pieces.Length != 4) { - if (!Helpers.Base64.IsBase64String(Payload)) - { - Error($"Failed to launch {Constants.PROJECT_NAME}", $"Try launching {Constants.PROJECT_NAME} from the website again."); - return false; - } - - // mode, version, ticket, joinscript - string[] pieces = Helpers.Base64.ConvertBase64ToString(Payload).Split("|"); - if (pieces.Length != 4) - { - Error($"Failed to launch {Constants.PROJECT_NAME}", $"Try launching {Constants.PROJECT_NAME} from the website again."); - return false; - } - - Arguments["Mode"] = pieces[0]; - Arguments["Version"] = pieces[1]; - Arguments["Ticket"] = pieces[2]; - Arguments["JoinScript"] = pieces[3]; - - return true; - } - - public void Run() - { - // - } - - public void Abort() - { - // - } - - #region MainWindow - - protected virtual void HeadingChange(string heading) - { - OnHeadingChange!.Invoke(this, heading); - } - - protected virtual void ProgressBarAdd(int value) - { - OnProgressBarAdd!.Invoke(this, value); - } - - protected virtual void ProgressBarStateChange(Enums.ProgressBarState state) - { - OnProgressBarStateChange!.Invoke(this, state); - } - - protected virtual void Error(string heading, string text) - { - // ugly hack for now (I don't want to derive EventHandler just for this) - OnError!.Invoke(this, new string[] { heading, text }); - } - - #endregion - #region Installation - - public static void Install() - { - // Cleanup our registry entries beforehand (if they exist) - Protocol.Unregister(); - Register(); - - Directory.CreateDirectory(Directories.Base); - Directory.CreateDirectory(Directories.Versions); - Directory.CreateDirectory(Directories.Logs); - - File.Copy(Application.ExecutablePath, Directories.Application, true); - - Register(); - Protocol.Register(); - - MessageBox.Show($"Sucessfully installed {Constants.PROJECT_NAME}!", Constants.PROJECT_NAME, MessageBoxButtons.OK, MessageBoxIcon.Information); - - Environment.Exit((int)Win32.ErrorCode.ERROR_SUCCESS); - } - - public static void Uninstall(bool quiet = false) - { - DialogResult answer = quiet ? DialogResult.Yes : MessageBox.Show($"Are you sure you want to uninstall {Constants.PROJECT_NAME}?", Constants.PROJECT_NAME, MessageBoxButtons.YesNo, MessageBoxIcon.Warning); - - if (answer != DialogResult.Yes) - Environment.Exit((int)Win32.ErrorCode.ERROR_CANCELLED); - - // Close active processes - if (Process.GetProcessesByName($"{Constants.PROJECT_NAME}.Player").Any() || Process.GetProcessesByName($"{Constants.PROJECT_NAME}.Studio").Any()) - { - answer = quiet ? DialogResult.Yes : MessageBox.Show($"Kiseki is currently running. Would you like to close Kiseki now?", Constants.PROJECT_NAME, MessageBoxButtons.YesNo, MessageBoxIcon.Warning); - - if (answer != DialogResult.Yes) - Environment.Exit((int)Win32.ErrorCode.ERROR_CANCELLED); - - try - { - foreach (Process process in Process.GetProcessesByName($"{Constants.PROJECT_NAME}.Player")) - process.Kill(); - - foreach (Process process in Process.GetProcessesByName($"{Constants.PROJECT_NAME}.Studio")) - process.Kill(); - } - catch - { - Environment.Exit((int)Win32.ErrorCode.ERROR_INTERNAL_ERROR); - } - } - - // Delete all files - if (Directory.Exists(Directories.Logs)) - Directory.Delete(Directories.Logs, true); - - if (Directory.Exists(Directories.Versions)) - Directory.Delete(Directories.Versions, true); - - if (File.Exists(Directories.License)) - File.Delete(Directories.License); - - // Cleanup our registry entries - Unregister(); - Protocol.Unregister(); - - answer = quiet ? DialogResult.OK : MessageBox.Show($"Sucessfully uninstalled {Constants.PROJECT_NAME}!", Constants.PROJECT_NAME, MessageBoxButtons.OK, MessageBoxIcon.Information); - if (answer == DialogResult.OK || answer == DialogResult.Cancel) - { - string command = $"del /Q \"{Directories.Application}\""; - - if (Directory.GetFiles(Directories.Base, "*", SearchOption.AllDirectories).Length == 1) - { - // We're the only file in the directory, so we can delete the entire directory - command += $" && rmdir \"{Directories.Base}\""; - } - - Process.Start(new ProcessStartInfo() - { - FileName = "cmd.exe", - Arguments = $"/c timeout 5 && {command}", - UseShellExecute = true, - WindowStyle = ProcessWindowStyle.Hidden - }); - - Environment.Exit((int)Win32.ErrorCode.ERROR_SUCCESS); - } - } - - #endregion - #region Registration - - public static void Register() - { - using RegistryKey uninstallKey = Registry.CurrentUser.CreateSubKey($@"Software\Microsoft\Windows\CurrentVersion\Uninstall\{Constants.PROJECT_NAME}"); - - uninstallKey.SetValue("NoModify", 1); - uninstallKey.SetValue("NoRepair", 1); - - uninstallKey.SetValue("DisplayIcon", $"{Directories.Application},0"); - uninstallKey.SetValue("DisplayName", Constants.PROJECT_NAME); - uninstallKey.SetValue("DisplayVersion", Version); - - if (uninstallKey.GetValue("InstallDate") is null) - uninstallKey.SetValue("InstallDate", DateTime.Now.ToString("yyyyMMdd")); - - uninstallKey.SetValue("InstallLocation", Directories.Base); - uninstallKey.SetValue("Publisher", Constants.PROJECT_NAME); - uninstallKey.SetValue("QuietUninstallString", $"\"{Directories.Application}\" -uninstall -quiet"); - uninstallKey.SetValue("UninstallString", $"\"{Directories.Application}\" -uninstall"); - uninstallKey.SetValue("URLInfoAbout", $"https://github.com/{Constants.PROJECT_REPOSITORY}"); - uninstallKey.SetValue("URLUpdateInfo", $"https://github.com/{Constants.PROJECT_REPOSITORY}/releases/latest"); - } - - public static void Unregister() - { - try - { - Registry.CurrentUser.DeleteSubKey($@"Software\Microsoft\Windows\CurrentVersion\Uninstall\{Constants.PROJECT_NAME}"); - } - catch - { -#if DEBUG - throw; -#endif - } - } - - #endregion - #region Licensing - - public static void License() - { - if (!File.Exists(Directories.License)) - { - if (!AskForLicense(Directories.License)) - { - // They don't want us :( - return; - } - } - - // ... load the license ... - while (!Web.LoadLicense(File.ReadAllText(Directories.License))) - { - // ... and if it's invalid, keep asking for a new one. - File.Delete(Directories.License); - MessageBox.Show($"Corrupt license file! Please verify the contents of your license file (it should be named \"license.bin\".)", Constants.PROJECT_NAME, MessageBoxButtons.OK, MessageBoxIcon.Error); - AskForLicense(Directories.License, false); - } - } - - public static void Unlicense() - { - if (File.Exists(Directories.License)) - { - File.Delete(Directories.License); - } - } - - private static bool AskForLicense(string licensePath, bool showDialog = true) - { - DialogResult answer = showDialog ? MessageBox.Show($"{Constants.PROJECT_NAME} is currently under maintenance and requires a license in order to access games. Would you like to look for the license file now?", Constants.PROJECT_NAME, MessageBoxButtons.YesNo, MessageBoxIcon.Warning) : DialogResult.Yes; - - if (answer == DialogResult.Yes) - { - using OpenFileDialog dialog = new() - { - Title = "Select your license file", - Filter = "License files (*.bin)|*.bin", - InitialDirectory = Win32.GetDownloadsPath() - }; - - if (dialog.ShowDialog() == DialogResult.OK) - { - File.Copy(dialog.FileName, licensePath, true); - } - - return true; - } - + Error($"Failed to launch {Constants.PROJECT_NAME}", $"Try launching {Constants.PROJECT_NAME} from the website again."); return false; } - #endregion + Arguments["Mode"] = pieces[0]; + Arguments["Version"] = pieces[1]; + Arguments["Ticket"] = pieces[2]; + Arguments["JoinScript"] = pieces[3]; + + return true; } + + public void Run() + { + // + } + + public void Abort() + { + // + } + + #region MainWindow + + protected virtual void HeadingChange(string heading) + { + OnHeadingChange!.Invoke(this, heading); + } + + protected virtual void ProgressBarAdd(int value) + { + OnProgressBarAdd!.Invoke(this, value); + } + + protected virtual void ProgressBarStateChange(Enums.ProgressBarState state) + { + OnProgressBarStateChange!.Invoke(this, state); + } + + protected virtual void Error(string heading, string text) + { + // Ugly hack for now (I don't want to derive EventHandler just for this) + OnError!.Invoke(this, new string[] { heading, text }); + } + + #endregion + #region Installation + + public static void Install() + { + // Cleanup our registry entries beforehand (if they even exist) + Protocol.Unregister(); + Register(); + + Directory.CreateDirectory(Directories.Base); + Directory.CreateDirectory(Directories.Versions); + Directory.CreateDirectory(Directories.Logs); + + File.Copy(Application.ExecutablePath, Directories.Application, true); + + Register(); + Protocol.Register(); + + MessageBox.Show($"Sucessfully installed {Constants.PROJECT_NAME}!", Constants.PROJECT_NAME, MessageBoxButtons.OK, MessageBoxIcon.Information); + + Environment.Exit((int)Win32.ErrorCode.ERROR_SUCCESS); + } + + public static void Uninstall(bool quiet = false) + { + DialogResult answer = quiet ? DialogResult.Yes : MessageBox.Show($"Are you sure you want to uninstall {Constants.PROJECT_NAME}?", Constants.PROJECT_NAME, MessageBoxButtons.YesNo, MessageBoxIcon.Warning); + + if (answer != DialogResult.Yes) + Environment.Exit((int)Win32.ErrorCode.ERROR_CANCELLED); + + // Close active processes + if (Process.GetProcessesByName($"{Constants.PROJECT_NAME}.Player").Any() || Process.GetProcessesByName($"{Constants.PROJECT_NAME}.Studio").Any()) + { + answer = quiet ? DialogResult.Yes : MessageBox.Show($"Kiseki is currently running. Would you like to close Kiseki now?", Constants.PROJECT_NAME, MessageBoxButtons.YesNo, MessageBoxIcon.Warning); + + if (answer != DialogResult.Yes) + Environment.Exit((int)Win32.ErrorCode.ERROR_CANCELLED); + + try + { + foreach (Process process in Process.GetProcessesByName($"{Constants.PROJECT_NAME}.Player")) + process.Kill(); + + foreach (Process process in Process.GetProcessesByName($"{Constants.PROJECT_NAME}.Studio")) + process.Kill(); + } + catch + { + Environment.Exit((int)Win32.ErrorCode.ERROR_INTERNAL_ERROR); + } + } + + // Delete all files + if (Directory.Exists(Directories.Logs)) + Directory.Delete(Directories.Logs, true); + + if (Directory.Exists(Directories.Versions)) + Directory.Delete(Directories.Versions, true); + + if (File.Exists(Directories.License)) + File.Delete(Directories.License); + + // Cleanup our registry entries + Unregister(); + Protocol.Unregister(); + + answer = quiet ? DialogResult.OK : MessageBox.Show($"Sucessfully uninstalled {Constants.PROJECT_NAME}!", Constants.PROJECT_NAME, MessageBoxButtons.OK, MessageBoxIcon.Information); + if (answer == DialogResult.OK || answer == DialogResult.Cancel) + { + string command = $"del /Q \"{Directories.Application}\""; + + if (Directory.GetFiles(Directories.Base, "*", SearchOption.AllDirectories).Length == 1) + { + // We're the only file in the directory, so we can delete the entire directory + command += $" && rmdir \"{Directories.Base}\""; + } + + Process.Start(new ProcessStartInfo() + { + FileName = "cmd.exe", + Arguments = $"/c timeout 5 && {command}", + UseShellExecute = true, + WindowStyle = ProcessWindowStyle.Hidden + }); + + Environment.Exit((int)Win32.ErrorCode.ERROR_SUCCESS); + } + } + + #endregion + #region Registration + + public static void Register() + { + using RegistryKey uninstallKey = Registry.CurrentUser.CreateSubKey($@"Software\Microsoft\Windows\CurrentVersion\Uninstall\{Constants.PROJECT_NAME}"); + + uninstallKey.SetValue("NoModify", 1); + uninstallKey.SetValue("NoRepair", 1); + + uninstallKey.SetValue("DisplayIcon", $"{Directories.Application},0"); + uninstallKey.SetValue("DisplayName", Constants.PROJECT_NAME); + uninstallKey.SetValue("DisplayVersion", Version); + + if (uninstallKey.GetValue("InstallDate") is null) + uninstallKey.SetValue("InstallDate", DateTime.Now.ToString("yyyyMMdd")); + + uninstallKey.SetValue("InstallLocation", Directories.Base); + uninstallKey.SetValue("Publisher", Constants.PROJECT_NAME); + uninstallKey.SetValue("QuietUninstallString", $"\"{Directories.Application}\" -uninstall -quiet"); + uninstallKey.SetValue("UninstallString", $"\"{Directories.Application}\" -uninstall"); + uninstallKey.SetValue("URLInfoAbout", $"https://github.com/{Constants.PROJECT_REPOSITORY}"); + uninstallKey.SetValue("URLUpdateInfo", $"https://github.com/{Constants.PROJECT_REPOSITORY}/releases/latest"); + } + + public static void Unregister() + { + try + { + Registry.CurrentUser.DeleteSubKey($@"Software\Microsoft\Windows\CurrentVersion\Uninstall\{Constants.PROJECT_NAME}"); + } + catch + { +#if DEBUG + throw; +#endif + } + } + + #endregion + #region Licensing + + public static void License() + { + if (!File.Exists(Directories.License)) + { + if (!AskForLicense(Directories.License)) + { + // User doesn't want to license this launcher + return; + } + } + + // Load the license... + while (!Web.LoadLicense(File.ReadAllText(Directories.License))) + { + // ...and if it's corrupt, keep asking for a new one. + File.Delete(Directories.License); + MessageBox.Show($"Corrupt license file! Please verify the contents of your license file (it should be named \"license.bin\".)", Constants.PROJECT_NAME, MessageBoxButtons.OK, MessageBoxIcon.Error); + AskForLicense(Directories.License, false); + } + } + + public static void Unlicense() + { + if (File.Exists(Directories.License)) + { + File.Delete(Directories.License); + } + } + + private static bool AskForLicense(string licensePath, bool showDialog = true) + { + DialogResult answer = showDialog ? MessageBox.Show($"{Constants.PROJECT_NAME} is currently undergoing maintenance and requires a license in order to access the test site. Would you like to look for the license file now?", Constants.PROJECT_NAME, MessageBoxButtons.YesNo, MessageBoxIcon.Warning) : DialogResult.Yes; + + if (answer == DialogResult.Yes) + { + using OpenFileDialog dialog = new() + { + Title = "Select your license file", + Filter = "License files (*.bin)|*.bin", + InitialDirectory = Win32.GetDownloadsPath() + }; + + if (dialog.ShowDialog() == DialogResult.OK) + { + File.Copy(dialog.FileName, licensePath, true); + } + + return true; + } + + return false; + } + + #endregion } \ No newline at end of file diff --git a/Kiseki.Launcher.Windows/Directories.cs b/Kiseki.Launcher.Windows/Directories.cs index 8dd85b8..2e931d9 100644 --- a/Kiseki.Launcher.Windows/Directories.cs +++ b/Kiseki.Launcher.Windows/Directories.cs @@ -1,29 +1,28 @@ -namespace Kiseki.Launcher.Windows +namespace Kiseki.Launcher.Windows; + +public static class Directories { - public static class Directories + public static string LocalAppData => Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData); + + public static string Base { get; private set; } = ""; + public static string Logs { get; private set; } = ""; + public static string Versions { get; private set; } = ""; + public static string License { get; private set; } = ""; + public static string Application { get; private set; } = ""; + + public static void Initialize(string baseDirectory) { - public static string LocalAppData => Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData); + Base = baseDirectory; - public static string Base { get; private set; } = ""; - public static string Logs { get; private set; } = ""; - public static string Versions { get; private set; } = ""; - public static string License { get; private set; } = ""; - public static string Application { get; private set; } = ""; - - public static void Initialize(string baseDirectory) + if (!Directory.Exists(Base)) { - Base = baseDirectory; - - if (!Directory.Exists(Base)) - { - Directory.CreateDirectory(Base); // just in case - } - - Logs = Path.Combine(Base, "Logs"); - Versions = Path.Combine(Base, "Versions"); - - License = Path.Combine(Base, "license.bin"); - Application = Path.Combine(Base, $"{Constants.PROJECT_NAME}.Launcher.exe"); + Directory.CreateDirectory(Base); } + + Logs = Path.Combine(Base, "Logs"); + Versions = Path.Combine(Base, "Versions"); + + License = Path.Combine(Base, "license.bin"); + Application = Path.Combine(Base, $"{Constants.PROJECT_NAME}.Launcher.exe"); } } \ No newline at end of file diff --git a/Kiseki.Launcher.Windows/MainWindow.cs b/Kiseki.Launcher.Windows/MainWindow.cs index b3029e2..1012c88 100644 --- a/Kiseki.Launcher.Windows/MainWindow.cs +++ b/Kiseki.Launcher.Windows/MainWindow.cs @@ -1,83 +1,82 @@ using Kiseki.Launcher.Windows.Properties; -namespace Kiseki.Launcher.Windows +namespace Kiseki.Launcher.Windows; + +[System.ComponentModel.DesignerCategory("")] +public class MainWindow : Form { - [System.ComponentModel.DesignerCategory("")] - public class MainWindow : Form + private readonly TaskDialogButton CloseButton; + private readonly TaskDialogPage Page; + private readonly Bootstrapper Bootstrapper; + + public MainWindow(string payload) { - private readonly TaskDialogButton CloseButton; - private readonly TaskDialogPage Page; - private readonly Bootstrapper Bootstrapper; + Bootstrapper = new Bootstrapper(payload); + Bootstrapper.OnHeadingChange += Bootstrapper_HeadingChanged; + Bootstrapper.OnProgressBarAdd += Bootstrapper_ProgressBarAdded; + Bootstrapper.OnProgressBarStateChange += Bootstrapper_ProgressBarStateChanged; + Bootstrapper.OnError += Bootstrapper_Errored; - public MainWindow(string payload) + CloseButton = TaskDialogButton.Close; + Page = new TaskDialogPage() { - Bootstrapper = new Bootstrapper(payload); - Bootstrapper.OnHeadingChange += Bootstrapper_HeadingChanged; - Bootstrapper.OnProgressBarAdd += Bootstrapper_ProgressBarAdded; - Bootstrapper.OnProgressBarStateChange += Bootstrapper_ProgressBarStateChanged; - Bootstrapper.OnError += Bootstrapper_Errored; - - CloseButton = TaskDialogButton.Close; - Page = new TaskDialogPage() + Caption = Constants.PROJECT_NAME, + AllowMinimize = true, + + ProgressBar = new TaskDialogProgressBar() { - Caption = Constants.PROJECT_NAME, - AllowMinimize = true, - - ProgressBar = new TaskDialogProgressBar() - { - State = TaskDialogProgressBarState.Marquee - }, + State = TaskDialogProgressBarState.Marquee + }, - Buttons = { CloseButton } - }; + Buttons = { CloseButton } + }; - Page.Created += (s, e) => - { - Bootstrapper.Run(); - }; - - ShowTaskDialog(); - } - - private void ShowTaskDialog() + Page.Created += (s, e) => { - TaskDialogIcon logo = new(Resources.IconKiseki); - Page.Icon = logo; + Bootstrapper.Run(); + }; - TaskDialog.ShowDialog(Page); - } + ShowTaskDialog(); + } - private void CloseButton_Click(object? sender, EventArgs e) + private void ShowTaskDialog() + { + TaskDialogIcon logo = new(Resources.IconKiseki); + Page.Icon = logo; + + TaskDialog.ShowDialog(Page); + } + + private void CloseButton_Click(object? sender, EventArgs e) + { + Bootstrapper.Abort(); + Environment.Exit(0); + } + + private void Bootstrapper_HeadingChanged(object? sender, string heading) + { + Page.Heading = heading; + } + + private void Bootstrapper_ProgressBarAdded(object? sender, int value) + { + Page.ProgressBar!.Value += value; + } + + private void Bootstrapper_ProgressBarStateChanged(object? sender, Enums.ProgressBarState state) + { + Page.ProgressBar!.State = state switch { - Bootstrapper.Abort(); - Environment.Exit(0); - } + Enums.ProgressBarState.Normal => TaskDialogProgressBarState.Normal, + Enums.ProgressBarState.Marquee => TaskDialogProgressBarState.Marquee, + _ => throw new NotImplementedException() + }; + } - private void Bootstrapper_HeadingChanged(object? sender, string heading) - { - Page.Heading = heading; - } - - private void Bootstrapper_ProgressBarAdded(object? sender, int value) - { - Page.ProgressBar!.Value += value; - } - - private void Bootstrapper_ProgressBarStateChanged(object? sender, Enums.ProgressBarState state) - { - Page.ProgressBar!.State = state switch - { - Enums.ProgressBarState.Normal => TaskDialogProgressBarState.Normal, - Enums.ProgressBarState.Marquee => TaskDialogProgressBarState.Marquee, - _ => throw new NotImplementedException() - }; - } - - private void Bootstrapper_Errored(object? sender, string[] texts) - { - Page.Icon = TaskDialogIcon.Error; - Page.Heading = texts[0]; - Page.Text = texts[1]; - } + private void Bootstrapper_Errored(object? sender, string[] texts) + { + Page.Icon = TaskDialogIcon.Error; + Page.Heading = texts[0]; + Page.Text = texts[1]; } } \ No newline at end of file diff --git a/Kiseki.Launcher.Windows/Program.cs b/Kiseki.Launcher.Windows/Program.cs index f409df8..1c48cad 100644 --- a/Kiseki.Launcher.Windows/Program.cs +++ b/Kiseki.Launcher.Windows/Program.cs @@ -1,72 +1,71 @@ using System.Diagnostics; -namespace Kiseki.Launcher.Windows +namespace Kiseki.Launcher.Windows; + +internal static class Program { - internal static class Program + [STAThread] + static void Main(string[] args) { - [STAThread] - static void Main(string[] args) + // Initialize directories + string parentFolder = Path.GetDirectoryName(Application.StartupPath)!; + + if (Path.GetDirectoryName(parentFolder)!.ToLower().Contains(Constants.PROJECT_NAME.ToLower())) { - // Initialize directories - string parentFolder = Path.GetDirectoryName(Application.ExecutablePath)!; - - if (Path.GetDirectoryName(parentFolder)!.ToLower().Contains(Constants.PROJECT_NAME.ToLower())) - { - // Set to the current directory (user likely has installed the launcher, seeing as parent folder name contains the project name) - Directories.Initialize(parentFolder); - } - else - { - // Set to the default directory (user likely hasn't installed the launcher yet) - Directories.Initialize(Path.Combine(Directories.LocalAppData, Constants.PROJECT_NAME)); - } - - bool isConnected = Web.Initialize(); - if (!isConnected && Web.IsInMaintenance) - { - // Try licensing this launcher and attempt to connect again - Bootstrapper.License(); - isConnected = Web.Initialize(); - } - - if (!isConnected) - { - if (Web.IsInMaintenance) - { - // Unlicense this launcher - Bootstrapper.Unlicense(); - } - - MessageBox.Show($"Failed to connect to {Constants.PROJECT_NAME}. Please check your internet connection and try again.", Constants.PROJECT_NAME, MessageBoxButtons.OK, MessageBoxIcon.Error); - return; - } - - if (!File.Exists(Directories.Application)) - { - Bootstrapper.Install(); - return; - } - - if (args.Length == 0) - { - // Nothing for us to do :P - Process.Start(new ProcessStartInfo() - { - FileName = Web.Url("/games"), - UseShellExecute = true - }); - - return; - } - - if (args[0] == "-uninstall") - { - Bootstrapper.Uninstall(args[0] == "-quiet"); - return; - } - - ApplicationConfiguration.Initialize(); - Application.Run(new MainWindow(args[0])); + // Set to the current directory (user likely has installed the launcher, seeing as parent folder name contains the project name) + Directories.Initialize(parentFolder); } + else + { + // Set to the default directory (user likely hasn't installed the launcher yet) + Directories.Initialize(Path.Combine(Directories.LocalAppData, Constants.PROJECT_NAME)); + } + + bool isConnected = Web.Initialize(); + if (!isConnected && Web.IsInMaintenance) + { + // Try licensing this launcher and attempt to connect again + Bootstrapper.License(); + isConnected = Web.Initialize(); + } + + if (!isConnected) + { + if (Web.IsInMaintenance) + { + // Unlicense this launcher + Bootstrapper.Unlicense(); + } + + MessageBox.Show($"Failed to connect to {Constants.PROJECT_NAME}. Please check your internet connection and try again.", Constants.PROJECT_NAME, MessageBoxButtons.OK, MessageBoxIcon.Error); + return; + } + + if (!File.Exists(Directories.Application)) + { + Bootstrapper.Install(); + return; + } + + if (args.Length == 0) + { + // Nothing for us to do :P + Process.Start(new ProcessStartInfo() + { + FileName = Web.Url("/games"), + UseShellExecute = true + }); + + return; + } + + if (args[0] == "-uninstall") + { + Bootstrapper.Uninstall(args[0] == "-quiet"); + return; + } + + ApplicationConfiguration.Initialize(); + Application.Run(new MainWindow(args[0])); } } \ No newline at end of file diff --git a/Kiseki.Launcher.Windows/Protocol.cs b/Kiseki.Launcher.Windows/Protocol.cs index aa8790d..1bd067e 100644 --- a/Kiseki.Launcher.Windows/Protocol.cs +++ b/Kiseki.Launcher.Windows/Protocol.cs @@ -1,45 +1,44 @@ using Microsoft.Win32; -namespace Kiseki.Launcher.Windows +namespace Kiseki.Launcher.Windows; + +public class Protocol : Interfaces.IProtocol { - public class Protocol : IProtocol + public static void Register() { - public static void Register() + string arguments = $"\"{Directories.Application}\" \"%1\""; + + RegistryKey uriKey = Registry.CurrentUser.CreateSubKey(@$"Software\Classes\{Constants.PROTOCOL_KEY}"); + RegistryKey uriIconKey = uriKey.CreateSubKey("DefaultIcon"); + RegistryKey uriCommandKey = uriKey.CreateSubKey(@"shell\open\command"); + + if (uriKey.GetValue("") is null) { - string arguments = $"\"{Directories.Application}\" \"%1\""; - - RegistryKey uriKey = Registry.CurrentUser.CreateSubKey(@$"Software\Classes\{Constants.PROTOCOL_KEY}"); - RegistryKey uriIconKey = uriKey.CreateSubKey("DefaultIcon"); - RegistryKey uriCommandKey = uriKey.CreateSubKey(@"shell\open\command"); - - if (uriKey.GetValue("") is null) - { - uriKey.SetValue("", $"URL: {Constants.PROJECT_NAME} Protocol"); - uriKey.SetValue("URL Protocol", ""); - } - - if ((string?)uriCommandKey.GetValue("") != arguments) - { - uriCommandKey.SetValue("", arguments); - } - - uriKey.Close(); - uriIconKey.Close(); - uriCommandKey.Close(); + uriKey.SetValue("", $"URL: {Constants.PROJECT_NAME} Protocol"); + uriKey.SetValue("URL Protocol", ""); } - public static void Unregister() + if ((string?)uriCommandKey.GetValue("") != arguments) + { + uriCommandKey.SetValue("", arguments); + } + + uriKey.Close(); + uriIconKey.Close(); + uriCommandKey.Close(); + } + + public static void Unregister() + { + try + { + Registry.CurrentUser.DeleteSubKeyTree(@$"Software\Classes\{Constants.PROTOCOL_KEY}"); + } + catch { - try - { - Registry.CurrentUser.DeleteSubKeyTree(@$"Software\Classes\{Constants.PROTOCOL_KEY}"); - } - catch - { #if DEBUG - throw; + throw; #endif - } } } } \ No newline at end of file diff --git a/Kiseki.Launcher.Windows/README.md b/Kiseki.Launcher.Windows/README.md new file mode 100644 index 0000000..773cf0a --- /dev/null +++ b/Kiseki.Launcher.Windows/README.md @@ -0,0 +1,11 @@ +# Kiseki.Launcher.Windows + +This is the Kiseki launcher for Windows, containing Windows-specific code and assemblies. This project may only compile on Windows. + +## Arguments + +- **To install**: *(none required)* +- **To open the games page**: *(none required if installed on system)* +- **To play a game**: `Kiseki.Launcher.Windows.exe ` +- **To uninstall**: `Kiseki.Launcher.Windows.exe -uninstall` +- **To uninstall quietly** (i.e. no confirmation dialogs): `Kiseki.Launcher.Windows -uninstall -quiet` \ No newline at end of file diff --git a/Kiseki.Launcher.Windows/Win32.cs b/Kiseki.Launcher.Windows/Win32.cs index 91e1942..c3dc860 100644 --- a/Kiseki.Launcher.Windows/Win32.cs +++ b/Kiseki.Launcher.Windows/Win32.cs @@ -4,8 +4,8 @@ namespace Kiseki.Launcher.Windows { public static class Win32 { - // https://learn.microsoft.com/en-us/windows/win32/msi/error-codes - // https://i-logic.com/serial/errorcodes.htm + // Ref: https://learn.microsoft.com/en-us/windows/win32/msi/error-codes + // Ref: https://i-logic.com/serial/errorcodes.htm public enum ErrorCode { ERROR_SUCCESS = 0, @@ -15,7 +15,7 @@ namespace Kiseki.Launcher.Windows ERROR_INTERNAL_ERROR = 1359 } - // https://www.codeproject.com/Articles/878605/Getting-All-Special-Folders-in-NET + // Source: https://www.codeproject.com/Articles/878605/Getting-All-Special-Folders-in-NET public static string GetDownloadsPath() { return SHGetKnownFolderPath(new("374DE290-123F-4565-9164-39C4925E467B"), 0); diff --git a/Kiseki.Launcher/Constants.cs b/Kiseki.Launcher/Constants.cs index a10f741..d2e09e2 100644 --- a/Kiseki.Launcher/Constants.cs +++ b/Kiseki.Launcher/Constants.cs @@ -1,13 +1,12 @@ -namespace Kiseki.Launcher +namespace Kiseki.Launcher; + +public static class Constants { - public static class Constants - { - public const string PROJECT_NAME = "Kiseki"; - public const string PROJECT_REPOSITORY = "kiseki-lol/launcher"; + public const string PROJECT_NAME = "Kiseki"; + public const string PROJECT_REPOSITORY = "kiseki-lol/launcher"; - public const string BASE_URL = "kiseki.lol"; - public const string MAINTENANCE_DOMAIN = "test"; + public const string BASE_URL = "kiseki.lol"; + public const string MAINTENANCE_DOMAIN = "test"; - public const string PROTOCOL_KEY = "kiseki"; - } + public const string PROTOCOL_KEY = "kiseki"; } \ No newline at end of file diff --git a/Kiseki.Launcher/Enums/PackageType.cs b/Kiseki.Launcher/Enums/PackageType.cs index 4079bf1..c7a6bdc 100644 --- a/Kiseki.Launcher/Enums/PackageType.cs +++ b/Kiseki.Launcher/Enums/PackageType.cs @@ -1,8 +1,7 @@ -namespace Kiseki.Launcher.Enums +namespace Kiseki.Launcher.Enums; + +public enum PackageType { - public enum PackageType - { - Bootstrapper, - Client, - } + Bootstrapper, + Client, } \ No newline at end of file diff --git a/Kiseki.Launcher/Enums/ProgressBarState.cs b/Kiseki.Launcher/Enums/ProgressBarState.cs index 79c1f39..6b2d74d 100644 --- a/Kiseki.Launcher/Enums/ProgressBarState.cs +++ b/Kiseki.Launcher/Enums/ProgressBarState.cs @@ -1,8 +1,7 @@ -namespace Kiseki.Launcher.Enums +namespace Kiseki.Launcher.Enums; + +public enum ProgressBarState { - public enum ProgressBarState - { - Normal, - Marquee - } + Normal, + Marquee } \ No newline at end of file diff --git a/Kiseki.Launcher/Helpers/Base64.cs b/Kiseki.Launcher/Helpers/Base64.cs index 0a15efd..5f1a297 100644 --- a/Kiseki.Launcher/Helpers/Base64.cs +++ b/Kiseki.Launcher/Helpers/Base64.cs @@ -1,23 +1,22 @@ +namespace Kiseki.Launcher.Helpers; + using System.Text; -namespace Kiseki.Launcher.Helpers +public static class Base64 { - public static class Base64 + // Source: https://stackoverflow.com/a/54143400 + public static bool IsBase64String(string base64) { - // https://stackoverflow.com/a/54143400 - public static bool IsBase64String(string base64) - { - Span buffer = new(new byte[base64.Length]); - - return Convert.TryFromBase64String(base64, buffer, out _); - } + Span buffer = new(new byte[base64.Length]); + + return Convert.TryFromBase64String(base64, buffer, out _); + } - public static string ConvertBase64ToString(string base64) - { - Span buffer = new(new byte[base64.Length]); - Convert.TryFromBase64String(base64, buffer, out _); + public static string ConvertBase64ToString(string base64) + { + Span buffer = new(new byte[base64.Length]); + Convert.TryFromBase64String(base64, buffer, out _); - return Encoding.UTF8.GetString(buffer); - } + return Encoding.UTF8.GetString(buffer); } } \ No newline at end of file diff --git a/Kiseki.Launcher/Helpers/Http.cs b/Kiseki.Launcher/Helpers/Http.cs index 5f097e4..cb26105 100644 --- a/Kiseki.Launcher/Helpers/Http.cs +++ b/Kiseki.Launcher/Helpers/Http.cs @@ -1,21 +1,20 @@ +namespace Kiseki.Launcher.Helpers; + using System.Text.Json; -namespace Kiseki.Launcher.Helpers +public static class Http { - public static class Http + public static async Task GetJson(string url) { - public static async Task GetJson(string url) + try { - try - { - string json = await Web.HttpClient.GetStringAsync(url); + string json = await Web.HttpClient.GetStringAsync(url); - return JsonSerializer.Deserialize(json); - } - catch - { - return default; - } + return JsonSerializer.Deserialize(json); + } + catch + { + return default; } } } \ No newline at end of file diff --git a/Kiseki.Launcher/Interfaces/IBootstrapper.cs b/Kiseki.Launcher/Interfaces/IBootstrapper.cs index a5c1115..6d21116 100644 --- a/Kiseki.Launcher/Interfaces/IBootstrapper.cs +++ b/Kiseki.Launcher/Interfaces/IBootstrapper.cs @@ -1,28 +1,27 @@ -namespace Kiseki.Launcher +namespace Kiseki.Launcher.Interfaces; + +public interface IBootstrapper { - public interface IBootstrapper - { - // These connect to MainWindow - event EventHandler? OnHeadingChange; - event EventHandler? OnProgressBarAdd; - event EventHandler? OnProgressBarStateChange; - event EventHandler? OnError; - - // Actual bootstrapping - bool Initialize(); - void Run(); - void Abort(); + // These connect to MainWindow + event EventHandler? OnHeadingChange; + event EventHandler? OnProgressBarAdd; + event EventHandler? OnProgressBarStateChange; + event EventHandler? OnError; + + // Actual bootstrapping + bool Initialize(); + void Run(); + void Abort(); - // Installation (i.e. putting the launcher in the Kiseki folder) - static abstract void Install(); - static abstract void Uninstall(bool quiet = false); + // Installation (i.e. putting the launcher in the Kiseki folder) + static abstract void Install(); + static abstract void Uninstall(bool quiet = false); - // Registering the launcher onto the system (as well as creating shortcuts) - static abstract void Register(); - static abstract void Unregister(); + // Registering the launcher onto the system (as well as creating shortcuts) + static abstract void Register(); + static abstract void Unregister(); - // Licensing the launcher - static abstract void License(); - static abstract void Unlicense(); - } + // Licensing the launcher + static abstract void License(); + static abstract void Unlicense(); } \ No newline at end of file diff --git a/Kiseki.Launcher/Interfaces/IProtocol.cs b/Kiseki.Launcher/Interfaces/IProtocol.cs index f4cb6a2..bc41352 100644 --- a/Kiseki.Launcher/Interfaces/IProtocol.cs +++ b/Kiseki.Launcher/Interfaces/IProtocol.cs @@ -1,9 +1,8 @@ -namespace Kiseki.Launcher +namespace Kiseki.Launcher.Interfaces; + +// This cl is responsible for handling registration of the Kiseki protcool handler +public interface IProtocol { - // This is responsible for handling registration of the Kiseki protcool handler - public interface IProtocol - { - static abstract void Register(); - static abstract void Unregister(); - } + static abstract void Register(); + static abstract void Unregister(); } \ No newline at end of file diff --git a/Kiseki.Launcher/Models/HealthCheck.cs b/Kiseki.Launcher/Models/HealthCheck.cs index 4a9f71f..7854c07 100644 --- a/Kiseki.Launcher/Models/HealthCheck.cs +++ b/Kiseki.Launcher/Models/HealthCheck.cs @@ -1,10 +1,9 @@ +namespace Kiseki.Launcher.Models; + using System.Text.Json.Serialization; -namespace Kiseki.Launcher.Models +public class HealthCheck { - public class HealthCheck - { - [JsonPropertyName("status")] - public int Status { get; set; } = -1; - } + [JsonPropertyName("status")] + public int Status { get; set; } = -1; } \ No newline at end of file diff --git a/Kiseki.Launcher/README.md b/Kiseki.Launcher/README.md new file mode 100644 index 0000000..98eab38 --- /dev/null +++ b/Kiseki.Launcher/README.md @@ -0,0 +1,3 @@ +# Kiseki.Launcher + +This is a platform-agnostic project that providers for the interfaces and other utilities to be implemented in the end-user launcher. \ No newline at end of file diff --git a/Kiseki.Launcher/Web.cs b/Kiseki.Launcher/Web.cs index 35e5412..f471283 100644 --- a/Kiseki.Launcher/Web.cs +++ b/Kiseki.Launcher/Web.cs @@ -1,69 +1,68 @@ -using System.Net; +namespace Kiseki.Launcher; + using System.Text.Json; -namespace Kiseki.Launcher +public static class Web { - public static class Web + public const int RESPONSE_FAILURE = -1; + public const int RESPONSE_SUCCESS = 0; + public const int RESPONSE_MAINTENANCE = 1; + + public static string CurrentUrl { get; private set; } = ""; + public static bool IsInMaintenance { get; private set; } = false; + + public static readonly HttpClient HttpClient = new(); + + public static bool Initialize() { - public const int RESPONSE_FAILURE = -1; - public const int RESPONSE_SUCCESS = 0; - public const int RESPONSE_MAINTENANCE = 1; + CurrentUrl = IsInMaintenance ? $"{Constants.MAINTENANCE_DOMAIN}.{Constants.BASE_URL}" : Constants.BASE_URL; - public static string CurrentUrl { get; private set; } = ""; - public static bool IsInMaintenance { get; private set; } = false; + // Synchronous block is intentional + Task task = CheckHealth(); + task.Wait(); - public static readonly HttpClient HttpClient = new(); + int response = task.Result; - public static bool Initialize() + if (response != RESPONSE_SUCCESS) { - CurrentUrl = IsInMaintenance ? $"{Constants.MAINTENANCE_DOMAIN}.{Constants.BASE_URL}" : Constants.BASE_URL; + if (response == RESPONSE_MAINTENANCE) + IsInMaintenance = true; - Task task = CheckHealth(); - task.Wait(); - - int response = task.Result; - - if (response != RESPONSE_SUCCESS) - { - if (response == RESPONSE_MAINTENANCE) - IsInMaintenance = true; - - return false; - } - - return true; + return false; } - public static string Url(string path) => $"https://{CurrentUrl}{path}"; + return true; + } - public static async Task CheckHealth() + public static string Url(string path) => $"https://{CurrentUrl}{path}"; + + public static async Task CheckHealth() + { + var response = await Helpers.Http.GetJson(Url("/api/health")); + + return response is null ? RESPONSE_FAILURE : response.Status; + } + + public static bool LoadLicense(string license) + { + // The license is just headers required to access the website in a JSON document + + Dictionary headers; + + try { - var response = await Helpers.Http.GetJson(Url("/api/health")); - - return response is null ? RESPONSE_FAILURE : response.Status; + headers = JsonSerializer.Deserialize>(license)!; + } + catch + { + return false; + } + + for (int i = 0; i < headers.Count; i++) + { + HttpClient.DefaultRequestHeaders.Add(headers.ElementAt(i).Key, headers.ElementAt(i).Value); } - public static bool LoadLicense(string license) - { - // the "license" is actually just headers required to access the website. - // this can be cloudflare zero-trust headers (like what Kiseki does), or however - // else you'd like to do auth-walls. either way; it's just a JSON document - - try - { - HttpClient.DefaultRequestHeaders.Clear(); - - var headers = JsonSerializer.Deserialize>(license)!; - - for (int i = 0; i < headers.Count; i++) - HttpClient.DefaultRequestHeaders.Add(headers.ElementAt(i).Key, headers.ElementAt(i).Value); - } - catch - { - return false; - } - - return true; - } + return true; } } \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index e72bfdd..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - 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 3 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, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..496acdb --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,675 @@ +# GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +## Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 3 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, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/README.md b/README.md index 626581a..94deead 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,11 @@ # Kiseki.Launcher +[![License](https://img.shields.io/github/license/kiseki-lol/launcher)](https://github.com/kiseki-lol/launcher/blob/trunk/LICENSE) +[![GitHub Build Status](https://img.shields.io/github/actions/workflow/status/kiseki-lol/launcher/build.yml?branch=trunk&label=builds)](https://github.com/kiseki-lol/launcher/actions) +[![Star](https://img.shields.io/github/stars/kiseki-lol/launcher?style=social)](https://github.com/kiseki-lol/launcher/stargazers) + Launches Kiseki game clients from the website # License -Kiseki.Launcher is licensed under the Licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.txt). A copy of it has been included with Kiseki.Launcher. +Kiseki.Launcher is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.md). A copy of it has been included with Kiseki.Launcher. Some parts of Kiseki.Launcher are loosely adapted from [@pizzaboxer/bloxstrap](https://github.com/pizzaboxer/bloxstrap). Bloxstrap is a project licensed under the [MIT license](https://github.com/pizzaboxer/bloxstrap/blob/main/LICENSE). \ No newline at end of file