add launcher

.gitignore

@@ -4,3 +4,4 @@
 !RecRoom_Data/il2cpp_data/Metadata/global-metadata.zip
 !RecRoomVR.bat
 !RecRoomScreen.bat
+!RecFlareSetup.iss

README.md

@@ -6,6 +6,16 @@ Automatic download and setup of a game client to play [RecFlare](https://github.
 
 ## Download/update and play
 
+### Easy way: installer
+
+Download and run `RecFlareSetup.exe` from the [releases page](https://github.com/djdevin/recflare-client/releases). The wizard asks whether you have Rec Room in your Steam library: if you do, it downloads the game client from Steam (DepotDownloader, signing in with your username or a Steam mobile app QR code); if not, it downloads the game files from a mirror instead. It then installs BepInEx and the RecNet plugin, and creates Start menu/desktop shortcuts for desktop and VR mode.
+
+If Windows SmartScreen shows "Windows protected your PC", click **More info** and then **Run anyway** (the installer is unsigned).
+
+To build the installer yourself, compile `RecFlareSetup.iss` with [Inno Setup](https://jrsoftware.org/isinfo.php) 6.1 or later: `iscc RecFlareSetup.iss`.
+
+### Manual way: scripts
+
 1. Check out this repository or extract the ZIP: https://github.com/djdevin/recflare-client/archive/refs/heads/master.zip
 2. Run `download.bat`. The script will ask whether you have Rec Room in your Steam library: if you do, it downloads the game client from Steam (DepotDownloader); if not, it syncs the game files from a mirror instead. Either way it then applies patches and configuration.
 3. Run `RecRoomScreen.bat` or `RecRoomVR.bat`

RecFlareSetup.iss

@@ -0,0 +1,222 @@
+; RecFlare installer - GUI equivalent of download.bat.
+; Build with Inno Setup 6.1+ (https://jrsoftware.org/isinfo.php):
+;   iscc RecFlareSetup.iss
+; Output: Output\RecFlareSetup.exe
+
+[Setup]
+AppId={{8E1D2A7B-6C43-4F0A-9B7E-3D5F80C21A96}
+AppName=RecFlare
+AppVersion=20230414
+AppPublisher=RecFlare project
+AppSupportURL=https://github.com/djdevin/recflare
+DefaultDirName={sd}\Games\RecFlare
+PrivilegesRequired=lowest
+; tar.exe ships with Windows 10 1803+; the downloads and extraction depend on it
+MinVersion=10.0.17134
+WizardStyle=modern
+DisableProgramGroupPage=yes
+OutputBaseFilename=RecFlareSetup
+SolidCompression=yes
+UninstallDisplayName=RecFlare
+
+[Tasks]
+Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}"; GroupDescription: "{cm:AdditionalIcons}"
+
+[Files]
+Source: "RecRoomScreen.bat"; DestDir: "{app}"; Flags: ignoreversion
+Source: "RecRoomVR.bat"; DestDir: "{app}"; Flags: ignoreversion
+; Points the client at the RecFlare server. Never overwrite: users may have
+; edited it to use their own instance (see README "Custom server").
+Source: "BepInEx\config\net.rec.plugin.cfg"; DestDir: "{app}\BepInEx\config"; Flags: onlyifdoesntexist
+
+[Icons]
+Name: "{autoprograms}\RecFlare (Desktop mode)"; Filename: "{app}\recroom.exe"; Parameters: "+forcemode:screen"; WorkingDir: "{app}"
+Name: "{autoprograms}\RecFlare (VR)"; Filename: "{app}\recroom.exe"; Parameters: "+forcemode:vr"; WorkingDir: "{app}"
+Name: "{autodesktop}\RecFlare (Desktop mode)"; Filename: "{app}\recroom.exe"; Parameters: "+forcemode:screen"; WorkingDir: "{app}"; Tasks: desktopicon
+Name: "{autodesktop}\RecFlare (VR)"; Filename: "{app}\recroom.exe"; Parameters: "+forcemode:vr"; WorkingDir: "{app}"; Tasks: desktopicon
+
+[UninstallDelete]
+; The game files are downloaded, not installed, so Inno does not track them;
+; remove the whole folder on uninstall.
+Type: filesandordirs; Name: "{app}"
+
+[Code]
+const
+  ClientMD5 = '4c4a94624eba99028bb36445ccb03253';
+  ClientURL = 'https://s3.g.megas4.com/2koayuyiwxv4groxzwdbbxg43cwustavrkvfb/recflare/client.zip';
+  DepotDownloaderURL = 'https://github.com/SteamRE/DepotDownloader/releases/download/DepotDownloader_3.4.0/DepotDownloader-windows-x64.zip';
+  BepInExURL = 'https://github.com/BepInEx/BepInEx/releases/download/v6.0.0-pre.2/BepInEx-Unity.IL2CPP-win-x64-6.0.0-pre.2.zip';
+  PluginURL = 'https://github.com/djdevin/recnet-plugin/releases/download/20230414.1/RecNetPlugin.dll';
+
+var
+  SourcePage: TInputOptionWizardPage;
+  SteamPage: TInputQueryWizardPage;
+  DownloadPage: TDownloadWizardPage;
+  ReuseLocalClientZip: Boolean;
+
+function UsingSteam: Boolean;
+begin
+  Result := SourcePage.Values[0];
+end;
+
+function OnDownloadProgress(const Url, FileName: String; const Progress, ProgressMax: Int64): Boolean;
+begin
+  if Progress = ProgressMax then
+    Log(Format('Downloaded %s', [FileName]));
+  Result := True;
+end;
+
+procedure InitializeWizard;
+begin
+  SourcePage := CreateInputOptionPage(wpSelectDir,
+    'Game client source', 'Where should the game files come from?',
+    'Setup needs a copy of the Rec Room game client. Pick the option that applies to you, then click Next.',
+    True, False);
+  SourcePage.Add('I have Rec Room in my Steam library - download it from Steam');
+  SourcePage.Add('I do not have it on Steam - download from the community mirror');
+  SourcePage.SelectedValueIndex := 0;
+
+  SteamPage := CreateInputQueryPage(SourcePage.ID,
+    'Steam sign-in', 'How should the Steam download sign in?',
+    'Enter your Steam username, or leave it blank to sign in by scanning a QR code with the Steam mobile app. ' +
+    'A separate Steam window will open during installation to finish signing in; ' +
+    'this installer never sees your password.');
+  SteamPage.Add('Steam username (optional):', False);
+
+  DownloadPage := CreateDownloadPage(SetupMessage(msgWizardPreparing),
+    SetupMessage(msgPreparingDesc), @OnDownloadProgress);
+end;
+
+function ShouldSkipPage(PageID: Integer): Boolean;
+begin
+  Result := (PageID = SteamPage.ID) and not UsingSteam;
+end;
+
+function NextButtonClick(CurPageID: Integer): Boolean;
+begin
+  Result := True;
+  if CurPageID = wpReady then begin
+    DownloadPage.Clear;
+    ReuseLocalClientZip := False;
+    if UsingSteam then
+      DownloadPage.Add(DepotDownloaderURL, 'DepotDownloader.zip', '')
+    else begin
+      { A client.zip left behind by download.bat (or a previous run) is reused
+        when it matches the expected hash, like the .bat does. }
+      if FileExists(ExpandConstant('{app}\client.zip')) and
+         SameText(GetMD5OfFile(ExpandConstant('{app}\client.zip')), ClientMD5) then
+        ReuseLocalClientZip := True
+      else
+        DownloadPage.Add(ClientURL, 'client.zip', '');
+    end;
+    DownloadPage.Add(BepInExURL, 'BepInEx.zip', '');
+    DownloadPage.Add(PluginURL, 'RecNetPlugin.dll', '');
+    DownloadPage.Show;
+    try
+      try
+        DownloadPage.Download;
+        if not UsingSteam and not ReuseLocalClientZip and
+           not SameText(GetMD5OfFile(ExpandConstant('{tmp}\client.zip')), ClientMD5) then begin
+          SuppressibleMsgBox('The downloaded game client did not match the expected checksum. ' +
+            'Please run Setup again.', mbCriticalError, MB_OK, IDOK);
+          Result := False;
+        end;
+      except
+        if DownloadPage.AbortedByUser then
+          Log('Download aborted by user.')
+        else
+          SuppressibleMsgBox(AddPeriod(GetExceptionMessage), mbCriticalError, MB_OK, IDOK);
+        Result := False;
+      end;
+    finally
+      DownloadPage.Hide;
+    end;
+  end;
+end;
+
+procedure SetPreparingStatus(const Msg: String);
+begin
+  WizardForm.PreparingLabel.Visible := True;
+  WizardForm.PreparingLabel.Caption := Msg;
+  WizardForm.Refresh;
+end;
+
+function ExtractZip(const ZipPath, DestDir: String): Boolean;
+var
+  ResultCode: Integer;
+begin
+  Result := ForceDirectories(DestDir) and
+    Exec(ExpandConstant('{sys}\tar.exe'), Format('-xf "%s" -C "%s"', [ZipPath, DestDir]),
+      '', SW_HIDE, ewWaitUntilTerminated, ResultCode) and (ResultCode = 0);
+end;
+
+function RunDepotDownloader(var ErrorMsg: String): Boolean;
+var
+  Args: String;
+  ResultCode: Integer;
+begin
+  Result := False;
+  if not ExtractZip(ExpandConstant('{tmp}\DepotDownloader.zip'), ExpandConstant('{tmp}\DepotDownloader')) then begin
+    ErrorMsg := 'Could not extract DepotDownloader.';
+    Exit;
+  end;
+  Args := '-app 471710 -depot 471711 -manifest 6426603215211043630 -remember-password' +
+    ' -dir "' + ExpandConstant('{app}') + '"';
+  if Trim(SteamPage.Values[0]) <> '' then
+    Args := Args + ' -username "' + Trim(SteamPage.Values[0]) + '"'
+  else
+    Args := Args + ' -qr';
+  SetPreparingStatus('Downloading the game from Steam - follow the sign-in steps in the window that just opened...');
+  if not Exec(ExpandConstant('{tmp}\DepotDownloader\DepotDownloader.exe'), Args,
+      ExpandConstant('{tmp}\DepotDownloader'), SW_SHOWNORMAL, ewWaitUntilTerminated, ResultCode)
+     or (ResultCode <> 0) then begin
+    ErrorMsg := 'The Steam download did not complete (exit code ' + IntToStr(ResultCode) + '). ' +
+      'Check that your sign-in succeeded and that Rec Room is in your Steam library, then run Setup again.';
+    Exit;
+  end;
+  Result := True;
+end;
+
+function PrepareToInstall(var NeedsRestart: Boolean): String;
+var
+  ClientZip: String;
+begin
+  Result := '';
+  if not ForceDirectories(ExpandConstant('{app}')) then begin
+    Result := 'Could not create the installation folder.';
+    Exit;
+  end;
+
+  if UsingSteam then begin
+    if not RunDepotDownloader(Result) then
+      Exit;
+  end else begin
+    if ReuseLocalClientZip then
+      ClientZip := ExpandConstant('{app}\client.zip')
+    else
+      ClientZip := ExpandConstant('{tmp}\client.zip');
+    SetPreparingStatus('Extracting the game client (this can take a few minutes)...');
+    if not ExtractZip(ClientZip, ExpandConstant('{app}')) then begin
+      Result := 'Could not extract the game client archive.';
+      Exit;
+    end;
+  end;
+
+  SetPreparingStatus('Installing BepInEx...');
+  if not ExtractZip(ExpandConstant('{tmp}\BepInEx.zip'), ExpandConstant('{app}')) then begin
+    Result := 'Could not extract BepInEx.';
+    Exit;
+  end;
+
+  if not SaveStringToFile(ExpandConstant('{app}\steam_appid.txt'), '480', False) then begin
+    Result := 'Could not write steam_appid.txt.';
+    Exit;
+  end;
+
+  if not ForceDirectories(ExpandConstant('{app}\BepInEx\plugins')) or
+     not FileCopy(ExpandConstant('{tmp}\RecNetPlugin.dll'),
+       ExpandConstant('{app}\BepInEx\plugins\RecNetPlugin.dll'), False) then begin
+    Result := 'Could not install RecNetPlugin.dll.';
+    Exit;
+  end;
+end;