promotional bannermobile promotional banner
premium banner
A mod for CTNH to review changelog

Description

CTNHChangelog

A Minecraft mod that displays changelog information and checks for updates.

Configuration / 配置说明

English

The configuration file is located at config/ctnhchangelog-client.toml.

Field Description
changelogUrl URL of the remote JSON changelog file (e.g., https://example.com/changelog.json).
enableChangelogTab If true, displays the changelog tab in the "Create New World" menu.
ModpackVersion Current modpack version. Used to compare with the remote version for update checks.
enableVersionCheck If true, compares ModpackVersion with the latest version in the remote file.
buttonLocation Button display location. Options: BOTH (show on both Title Screen and Select World Screen), TITLE_SCREEN (only Title Screen), SELECT_WORLD (only Select World Screen).

中文

配置文件位于 config/ctnhchangelog-client.toml

字段 说明
changelogUrl 远程 JSON 更新日志文件的 URL(例如:https://example.com/changelog.json)。
enableChangelogTab 设为 true 时,在"创建新的世界"菜单中显示更新日志标签页。
ModpackVersion 当前整合包版本号。用于与远程最新版本对比,检测更新。
enableVersionCheck 设为 true 时,会自动对比本地与远程版本。
buttonLocation 按钮显示位置。可选值:BOTH(标题界面和选择世界界面都显示)、TITLE_SCREEN(仅标题界面)、SELECT_WORLD(仅选择世界界面)。

Changelog JSON Format / 更新日志 JSON 格式

Field Description

Field Type Required Description
footer String No Gradient text rendered at the bottom of the tab page
tagColors Object No Custom tag colors, supports 0xAARRGGBB format (e.g., 0xFFFF5555) or #RRGGBB format
entries Array Yes Collection of changelog entries

Entry Fields:

Field Type Required Description
version String Yes Version identifier
date String No Release date (ISO 8601 format)
title String No Version title/name
type String/Array No Update type enumeration, affects left side icon and default tags; Available values: major/minor/patch/hotfix/danger, The type comes with its own color and cannot be modified
tags String/Array No Custom tags, used in conjunction with tagColors
color String No Left border color of the entry, supports 0xAARRGGBB or #RRGGBB format
changes Array Yes List of change details, each item is a single text entry

字段说明

字段 类型 必填 描述
footer String 标签页底部渲染的渐变色文本
tagColors Object 自定义标签颜色,支持 0xAARRGGBB 格式(如 0xFFFF5555)或 #RRGGBB 格式
entries Array 更新日志条目集合

Entry 字段:

字段 类型 必填 描述
version String 版本标识符
date String 发布日期(ISO 8601 格式)
title String 版本标题/名称
type String/Array 更新类型枚举,影响左侧图标及默认标签;可选值:major/minor/patch/hotfix/danger,type自带颜色且无法修改
tags String/Array 自定义标签,与 tagColors 配合使用
color String 条目左侧边框颜色,支持 0xAARRGGBB#RRGGBB 格式
changes Array 变更明细列表,每项为单条文本

Example: changelog.json


In-Game Editor / 游戏内编辑器

English

The mod includes a built-in changelog editor accessible from the changelog screen after configuring in the config file.

Opening the Editor:

  • Click the "Edit" button in the top-right corner of the changelog overview screen

Editor Features:

Tab Description
Entries Add, delete, reorder changelog entries; edit version, date, title, type, tags, color, and changes
Tag Define custom tag and their colors for use in entries
Footer Edit the gradient footer text displayed at the bottom

Editing Changes:

  • Double-click an existing change entry to edit it
  • Press Enter to confirm the edit
  • Press Escape to cancel and revert to the original text

Import/Export:

  • Use the 'Import' button to load cached JSON files obtained remotely from the game directory.
  • Use the "Export" button to save the current changelog as JSON to the game directory

中文

模组内置了更新日志编辑器,在config文件配置后可从更新日志界面打开。

打开编辑器:

  • 点击更新日志概览界面右上角的"编辑"按钮

编辑器功能:

标签页 说明
条目 添加、删除、排序更新日志条目;编辑版本号、日期、标题、类型、标签、颜色和变更内容
标签 定义自定义标签及其颜色,供条目使用
脚注 编辑显示在底部的渐变色脚注文本

编辑变更内容:

  • 双击已有变更条目即可进入编辑模式
  • Enter 确认修改
  • Escape 取消修改并恢复原文

导入/导出:

  • 使用"导入"按钮从游戏目录加载 从远端获取的已缓存的JSON 文件
  • 使用"导出"按钮将当前更新日志保存为 JSON 文件到游戏目录