#Overview

It's common for free UO shards to have heavily modified assets, which is why we've created a custom patching system for shard owners. The system essentially creates efficient binary-delta patches using VCDIFF against an unmodified set of files and outputs them as a series of .patch files. We also convert any UOP based assets into their MUL equivalent which results in far smaller delta patches.

The patches are indexed by a file called the client-manifest, which tells CUO Web how to get your patches and what's needed to apply them. Your patches and the client-manifest are then stored somewhere that is HTTPS accessible, preferably on some kind of global CDN (e.g. Cloudflare, S3 etc).

When a player clicks Play CUO Web will first grab the client-manifest and then begin fetching the patches after which they are verified and initialized. During gameplay the patches are used in a random-access mode we call livepatching, the full patched UO asset is never written to disk to save players disk-space.

#What you will need

• Your shard files (duh)
• NodeJS v16 or higher installed
• A Webserver/CDN with HTTPS+CORS to serve your patches
• Your CUO Web Shard ID, to obtain one you need to apply with a Shard Request issue
• A code editor, e.g. VSCode

#Creating patches

The process boils down to these steps:

1. Preparing your files
2. Creating your patch config
3. Generating the patches
4. Uploading your patches to your webserver/cdn
5. Requesting CUO Web staff to change your manifest URL (if necessary)

Note: If you get stuck ask for help on the #for-shard-owners discord channel.

#1. Preparing your files

There are a few key folders you need to know about:

#Source directory

This is the directory where the CUO Web "source" files synchronized are to. On every start of the patching process the CLI will sync the remote files with this directory, always making sure you are patching against the right set of files.

#Target directory

This is your shards files. You can use your UO directory itself if you want. Only the files you list will be patched, the rest will be ignored.

#Output directory

This is where the .patch files and your client-manifest.json will be written. It is the directory you need to upload to your file hosting/CDN and will be publicly accessible.

#Create the structure

Create a folder structure similar to this and place your shard files in the middle target folder. We'll refer to the top level folder (e.g. cuo-web-patching) as the root folder.
Replace myshard with your shards name.

cuo-web-patching
   ├── classicuo-source  // source
   ├── myshard-files         // target
   └── myshard-patches       // output

#2. Creating your patch config

You now need to create the configuration file the patching tool will use to generate the shard patches. Create a new JSON file in the root folder with your shards name, e.g. myshard.json and open it in your favourite editor (e.g. VSCode).

Insert the following JSON:

{
  "shard": {
    "name": "My Shard",
    "id": <provided by CUO staff>,
    "clientVersion": "7.0.95.0",
    "region": "US",
    "focus": "PvP / PvM",
    "manifest": "https://myshard.com/myshard-patches/client-manifest.json",
    "logo": "https://myshard.com/assets/images/logo.png",
    "website": "https://myshard.com/",
    "discord": "https://discord.gg/Z141qfea",
    "encryption": 0,
    "useVerdata": false,
    "mapLayouts": "",
    "useTokenAuth": false,
    "testing": true
  },
  "patch": {
    "cdnBase": "https://myshard.com/myshard-patches",
    "files": [
    ]
  }
}

Update the following fields:

#shard

#patch

#⚠️ Important ⚠️

The files list is the only files CUO Web will see! Any files missing will not exist to the client.
You should list every file UO needs to load. The patcher will take care of patching only those with changes.

You can look at the ZHModern test center JSON file for an example of how a complete file should look.

#3. Generating the patches

If you haven't already, install NodeJS v16 or higher.

Your directory structure should look something like this:

cuo-web-patching
  ├── myshard.json
  ├── classicuo-source
  ├── myshard-files
  │   ├── artidx.mul
  │   ├── art.mul
  │   └── ... etc
  └── myshard-patches

Open a terminal at the root folder (e.g. cuo-web-patching), if you're on Windows you should use Powershell. Execute the patcher, replace the folder paths with the full-path to your root folder, and replace myshard.json with your shard configuration file.

npx @classicuo/[email protected] patching:create-v1 myshard.json --sourcePath C:/cuo-web-patching/classicuo-source --targetPath C:/cuo-web-patching/myshard-files --outputPath C:/cuo-web-patching/myshard-patches

Note: If patching fails please ask for help on the #for-shard-owners discord channel.

The CLI will take some, when patching is complete your output folder should contain .patch files and your client-manifest.json.

#4. Uploading your patches to your webserver/cdn

You can now take the output folder and upload it to your hosting/CDN where it should be accessible at the URL you set for cdnBase. How you upload your files is up to you and your chosen hosting, however you need to ensure a few things are set up:

1. Your cdnBase URL should be the output folder, with your patch files accessible via HTTPS publicly.
2. Enable CORS headers. If you're not sure what that is just google your webserver/host + CORS, e.g. IIS enable CORS to find how to do it.
3. Check you have enough bandwidth allowance for your shards' player-base to download your patches.

We recommend you use Cloudflare + R2 (it's what we use for the source files) to store your patches if you don't already have a host. Their free plan is more than enough for most shards (10GB free storage, 10 million requests p/month) and their global CDN will cache the files close to your users giving them extremely quick downloads.

#5. Requesting CUO Web staff to change your manifest URL (if necessary)

Drop a message in the #for-shard-owners channel asking one of the staff to change your manifest URL.

#FAQ/Troubleshooting

#The web client gets stuck during loading e.g. at Animations

This is likely because you're missing files, and/or gave the wrong files to the patcher. Try manually copying only the files you put into the files array into from your target folder into a new folder and launch Desktop CUO pointed to that folder.

If Desktop CUO loads fine with just those files ask for help in #for-shard-owners channel.

#I see MUL patches but I put in UOP?

The patcher will automatically convert your UOP asset files (exception being the Animation*.uop files) to MUL. We do this because of the compression in UOP files causes extremely large patch deltas, with MUL they are much smaller (e.g. 90MB to 2MB).

#File is being used by another process

Double-check your file list, it's likely your file list contains both the UOP and MUL version of the same asset(s), e.g. art.mul and artLegacyMUL.uop. Use only one.