Update Checks

Use RitsuLibFramework.RegisterModUpdateCheck(...) when a mod should check a small mirrored or self-hosted JSON file after the first main menu loads. Do not point ManifestUri at GitHub, GitHub API, or raw GitHub content; use a CDN, your own site, or another mirror. The release page can still be whichever page you want users to open.

RitsuLibFramework.RegisterModUpdateCheck(new()
{
    ModId = MyModConst.ModId,
    DisplayName = MyModConst.Name,
    CurrentVersion = MyModConst.Version,
    ManifestUri = new("https://example.com/my-mod/update.json"),
    ReleasePageUri = new("https://example.com/my-mod/releases"),
});

If the manifest version is newer, RitsuLib shows a normal non-persistent info toast. Clicking the toast opens release_page_url from the manifest, or ReleasePageUri from options when the manifest omits it.

{
  "schema": "ritsulib.update.v1",
  "latest_version": "1.2.3",
  "release_page_url": "https://example.com/my-mod/releases",
  "title": "My Mod update available",
  "message": "Version 1.2.3 of My Mod is available. Click to open the release page."
}

如果一个 Mod 需要在首次主菜单加载后检查更新，使用 RitsuLibFramework.RegisterModUpdateCheck(...)。ManifestUri 不要指向 GitHub、GitHub API 或 raw GitHub 内容；请使用 CDN、自有站点或其他镜像。发布页可以是你希望用户点击后打开的任意页面。

RitsuLibFramework.RegisterModUpdateCheck(new()
{
    ModId = MyModConst.ModId,
    DisplayName = MyModConst.Name,
    CurrentVersion = MyModConst.Version,
    ManifestUri = new("https://example.com/my-mod/update.json"),
    ReleasePageUri = new("https://example.com/my-mod/releases"),
});

如果 manifest 里的版本更新，RitsuLib 会显示一个普通、非持久的信息 toast。点击 toast 时优先打开 manifest 里的 release_page_url；如果 manifest 没有提供，则打开选项里的 ReleasePageUri。

{
  "schema": "ritsulib.update.v1",
  "latest_version": "1.2.3",
  "release_page_url": "https://example.com/my-mod/releases",
  "title": "My Mod update available",
  "message": "Version 1.2.3 of My Mod is available. Click to open the release page."
}