Getting started
Early access. These steps match package com.jacoo.remendo 3.1.0, Remendo Cloud 0.1 and the pinned Unity 2022.3 editor. Try them in a disposable project first: the sample build menus change project settings.
1. Add the packages
Copy com.jacoo.remendo (and, to use Remendo Cloud, com.jacoo.remendo.cloud) completely into your project's Packages/ folder. Then run Jacoo Remendo → Verify Package and Jacoo Remendo → Install. Install works in the project-local JacooRemendoData folder and never modifies the Unity installation.
License file
Base and patch builds need your license file. On your license page, enter the package names of your game (Player Settings > Identification, e.g. com.studio.game) and download the file. Import it with Jacoo Remendo → License → Import License File…; it is stored as ProjectSettings/JacooRemendoLicense.json, so commit it for CI (or point JACOO_REMENDO_LICENSE_FILE at it). The editor refreshes it online about once a week and keeps working offline for 21 days. Games and patches you already shipped never check a license.
2. Choose the patchable assemblies
In Jacoo Remendo → Settings…, list the assemblies (without .dll) whose code you want to patch, typically your gameplay assemblies. Keep the bootstrap code in a separate assembly that is not patchable and does not reference the patchable ones directly.
3. Create the signing key
Run Jacoo Remendo → Security → Create Patch Signing Key… and save the private key outside the project, in your secret store. The public part is written to Assets/Resources/JacooRemendoPatchTrust.json and ships inside the player; only patches signed with the matching private key will load.
4. Bootstrap
With Remendo Cloud, load the active patch before any patchable code runs and check for updates in the background:
using JacooRemendo;
using JacooRemendo.Cloud;
RemendoLoadReport report = RemendoCloud.LoadAtStartup(new RemendoCloudConfig
{
serverUrl = "https://patches.example.com",
clientKey = "rmd_pub_…", // public, from `remendo project create`
channel = "production"
});
StartCoroutine(RemendoCloud.CheckForUpdate());
// later, once the game is known to work:
RemendoCloud.MarkHealthy();
Without Remendo Cloud, call RemendoLoader.LoadAll(RemendoPatch.FromDirectory(dir)) with a patch directory you deliver yourself.
5. Build the base player
Use Jacoo Remendo → Build → Base Player…. It builds the player and stores a snapshot of exactly what shipped. Keep the snapshot with the release: every patch for that player is built against it. Never overwrite a snapshot of a build you distributed.
6. Build and check a patch
Fix the code, then run Jacoo Remendo → Build → Patch… against the snapshot, with the private key from your secret store (JACOO_REMENDO_PATCH_SIGNING_KEY in CI). Check the result locally:
remendo patch verify Builds/Patch-v2 --trust Assets/Resources/JacooRemendoPatchTrust.json
7. Release it gradually
export REMENDO_SERVER=https://patches.example.com
export REMENDO_PROJECT=prj_…
export REMENDO_ADMIN_TOKEN=rmd_admin_… # from your CI secret store
remendo patch upload Builds/Patch-v2
remendo release create --patch pat_… --channel production --percent 5
remendo release list # adoption and failure counters per release
remendo release set rel_… --percent 50
remendo release set rel_… --halt # roll back: installs return to the previous release or the shipped code
A downloaded patch is activated at the next launch. Raising the percentage only adds installs. Use remendo resolve --build … --install … to see what a given install receives.
8. Run the server yourself
Remendo Cloud is a single .NET service with SQLite and content-addressed file storage. Put a CDN or reverse proxy with TLS in front of it.
RemendoCloud__OperatorKey=<long random secret> \
RemendoCloud__DataDirectory=/var/lib/remendo \
dotnet Remendo.Cloud.Server.dll --urls http://0.0.0.0:8080
remendo project create --name "My Game" --trust JacooRemendoPatchTrust.json # with REMENDO_OPERATOR_KEY set
Store policies
Use patches to fix and tune what players already installed. Read Apple's App Review Guidelines 2.5.2 and the interpreted-code terms of the Apple Developer Program License Agreement, and Google Play's Device and Network Abuse policy, for every store you ship to.