Journal Mod By Pycoder

# Journal Book Mod v2.0.0 Release Notes ## English ### Version Overview `Journal Book Mod` v2.0.0 is the second major release. It keeps the original collectible journal book and journal page gameplay, while heavily improving reading flow, chapter organization, menu navigation, page numbering, automatic pagination, and configuration structure. ### Main Changes in v2.0.0 #### 1. English Default Configuration and Example Text - The default journal book name, cover title, and introduction text are now in English. - Default chapter names, page names, and example page contents are now in English. - English fallback text has been completed for GUI and page display cases, including unknown page names, lost page content, and cover prompts. - Chinese localization is still fully supported. In Chinese language environments, item names, tooltips, and GUI text will display in Chinese. #### 2. Chapter-Based Configuration Structure In v1.0.0, page names and page contents were stored in two separate lists. In v2.0.0, they have been merged into a clearer chapter-based structure. The new configuration alternates between chapter metadata and a list of pages: ```toml pageChapters = [ "Chapter Name":"Chapter Introduction", [ "Page Name":"Page Content", "Another Page":"Another Page Content" ] ] ``` Features: - Chapter names are configurable. - Chapter introductions are configurable. - Page names and page contents are stored together in entries formatted like `"Page Name":"Page Content"`. - The default examples are grouped into 3 chapters with a `2 + 3 + 3` page layout. - `\n` can be used inside strings to represent line breaks. - Page IDs are still assigned automatically according to configuration order, so `/give` usage remains straightforward. #### 3. More Readable Config File Formatting v2.0.0 adds automatic formatting for the journal content configuration. When the game starts, the relevant config section is automatically reformatted into a readable multi-line layout with proper indentation. Only journal content is reformatted; other config values are left untouched. #### 4. Journal Menu System The journal book now has a dedicated menu page: - The menu exists as soon as the journal book is opened. - If no pages have been collected, the menu only shows `MENU`, or `目录` in Chinese. - After pages are collected, menu entries are generated automatically. - Menu entries show page titles and page numbers. - Chapter entries are bold. - Normal page entries are indented to distinguish them from chapter entries. - Menu rows are clickable and jump directly to the corresponding chapter page or content page. - If there are too many entries, the menu automatically creates continuation pages. #### 5. Page Numbering System The journal now has formal page numbers: - The cover does not show a page number. - The introduction does not show a page number. - Menu pages do not show page numbers. - Numbering starts from the main content section, beginning at page `1`. - Generated chapter pages are included in page numbering. - Content pages are included in page numbering. - Continuation pages generated by long chapter introductions or long page contents are also included in page numbering. #### 6. Chapter Pages v2.0.0 adds generated chapter pages: - Chapter pages are not separate items. - When any page from a chapter is collected, a chapter page is automatically inserted before that chapter's content. - Chapter pages display the configured chapter title. - Chapter pages display the configured chapter introduction. - Chapter pages appear in the menu. - Chapter pages are included in page numbering. #### 7. Automatic Pagination and Continuation Pages The journal GUI has been rebuilt around a unified display-page model: - Cover, introduction, menu, chapter pages, and content pages can all paginate automatically. - If text exceeds the visible area of one page, continuation pages are generated automatically. - Continuation pages keep the behavior of their original page type. - Chapter and content continuation pages still show page numbers. - Chapter and content continuation pages still show the return-to-menu button. - After menu pagination, hyperlinks still jump to the correct target. #### 8. Return-to-Menu Button Main reading pages now include a return-to-menu button at the top: - Chapter pages show the return-to-menu button. - Content pages show the return-to-menu button. - Continuation pages for chapter and content pages also show it. - Clicking the button returns to the menu. - Cover, introduction, and menu pages do not show this button. #### 9. Journal GUI Layout Improvements The journal reading layout has been adjusted to better match the background texture: - The text drawing area is narrower and aligned with the ruled writing area of the book texture. - Titles are centered. - A separator line is drawn under titles. - Body text uses fixed line spacing to reduce overlap with borders or page edges. - Page numbers are centered near the bottom of the page. - Long menu rows, page titles, and page numbers are trimmed to avoid overflowing the page. #### 10. Original Gameplay Preserved v2.0.0 does not add world generation, loot tables, recipes, custom commands, or data generation. The core testing and page distribution method still works through vanilla `/give` commands: ```mcfunction /give @p journalmod:journal_book /give @p journalmod:journal_page{PageId:3} ``` A pre-filled journal book can also be created with NBT: ```mcfunction /give @p journalmod:journal_book{CollectedPages:[I;1,2,3]} ``` ### Player-Facing Summary In v2.0.0, the journal behaves more like a complete readable book. Players first see the cover and introduction, then enter the menu. The menu updates as pages are collected. Chapters appear automatically. Main content has page numbers. Long text continues onto additional pages. Players can return to the menu from reading pages or jump from the menu directly to a chapter or page. ### Pack Maker / Author Summary v2.0.0 is easier to maintain for long journal content. Chapter names, chapter introductions, page names, and page contents are all managed together in one place. The generated config is formatted into a readable multi-line structure. New chapters or pages can be added through config without changing code, as long as page items are distributed using the matching `PageId` order. ### Upgrade Notes - Forge does not automatically overwrite existing config files when upgrading from v1.0.0 to v2.0.0. - To use the new default config directly, delete the old generated config file and restart the game. - If you already customized journal content, migrate it manually into the new structure. - The old `PageId` mechanism still exists, but displayed page numbers are recalculated according to chapters and automatic pagination. --- ## 中文翻译 ### 版本概览 `Journal Book Mod` v2.0.0 是第二个主要版本。它保留了原本"日志书 + 可收集书页"的核心玩法，同时大幅完善了阅读流程、章节组织、目录导航、页码、自动分页和配置结构。 ### v2.0.0 主要改动 #### 1. 英文化默认配置和示例文字 - 默认日志书名称、封面标题、前言文本已改为英文。 - 默认章节名、书页名、书页正文示例已改为英文。 - GUI 和页面显示中的英文兜底文本已补齐，包括未知书页名、丢失页面内容和封面提示。 - 仍然保留完整的中文本地化支持。在中文语言环境下，物品名、提示和 GUI 文本会显示为中文。 #### 2. 基于章节的配置结构 在 1.0.0 中，书页名和书页内容分别存放在两个列表中。v2.0.0 将它们合并为更清晰的章节化结构。 新的配置采用章节信息和页面列表交替的结构： ```toml pageChapters = [ "Chapter Name":"Chapter Introduction", [ "Page Name":"Page Content", "Another Page":"Another Page Content" ] ] ``` 特点： - 章节名可配置。 - 章节前言可配置。 - 书页名和书页内容存放在同一个条目中，格式类似 `"Page Name":"Page Content"`。 - 默认示例被分为 3 个章节，书页数量按 `2 + 3 + 3` 分组。 - 可以在字符串中使用 `\n` 表示换行。 - 书页 ID 仍然会按配置顺序自动分配，因此 `/give` 用法保持不变。 #### 3. 更易读的配置文件格式 v2.0.0 为日志书内容配置增加了自动格式化。游戏启动时，相关配置段落会自动排版为易读的多行缩进结构。只有日志书内容会被格式化，其它配置值不会被改动。 #### 4. 日志书目录系统 日志书现在拥有独立目录页： - 日志书打开时目录就已经存在。 - 如果尚未收集任何书页，目录只显示 `MENU`，中文环境下显示 `目录`。 - 收集书页后，目录条目会自动生成。 - 目录条目会显示页面标题和页码。 - 章节条目会加粗。 - 普通书页条目会缩进，用于和章节条目区分。 - 目录行可以点击，并会直接跳转到对应章节页或正文页。 - 如果目录条目过多，目录会自动生成续页。 #### 5. 页码系统 日志书现在拥有正式页码： - 封面不显示页码。 - 前言不显示页码。 - 目录页不显示页码。 - 页码从正文部分开始，第一页为 `1`。 - 自动生成的章节页会参与页码排序。 - 正文页会参与页码排序。 - 长章节前言或长正文内容生成的续页也会参与页码排序。 #### 6. 章节页 v2.0.0 增加了自动生成的章节页： - 章节页不是独立物品。 - 当某个章节中的任意一页被收集后，该章节的内容前会自动插入章节页。 - 章节页显示配置中的章节标题。 - 章节页显示配置中的章节前言。 - 章节页会出现在目录中。 - 章节页会参与页码排序。 #### 7. 自动分页和续页 日志书 GUI 已围绕统一的显示页模型重构： - 封面、前言、目录、章节页和正文页都可以自动分页。 - 如果文字超出单页可视区域，会自动生成续页。 - 续页会保留原页面类型的行为。 - 章节页和正文页的续页仍然显示页码。 - 章节页和正文页的续页仍然显示返回目录按钮。 - 目录分页后，超链接仍然会跳转到正确目标。 #### 8. 返回目录按钮 正文阅读页面顶部现在包含返回目录按钮： - 章节页显示返回目录按钮。 - 正文页显示返回目录按钮。 - 章节页和正文页的续页也显示返回目录按钮。 - 点击按钮会返回目录。 - 封面、前言和目录页不显示该按钮。 #### 9. 日志书 GUI 排版优化 日志书阅读布局已调整，使其更贴合背景纹理： - 文本绘制区域更窄，并与书本纹理中的横线书写区域对齐。 - 标题居中显示。 - 标题下方绘制分隔线。 - 正文使用固定行距，减少文字压到边框或页面边缘的问题。 - 页码显示在页面底部居中位置。 - 过长的目录行、页面标题和页码会被截断，避免溢出页面。 #### 10. 保留原有玩法 v2.0.0 没有添加世界生成、战利品表、配方、自定义命令或数据生成。核心测试和发放方式仍然通过原版 `/give` 命令实现： ```mcfunction /give @p journalmod:journal_book /give @p journalmod:journal_page{PageId:3} ``` 也可以通过 NBT 创建预先收集书页的日志书： ```mcfunction /give @p journalmod:journal_book{CollectedPages:[I;1,2,3]} ``` ### 面向玩家的总结 在 v2.0.0 中，日志书更像一本完整的可阅读书籍。玩家会先看到封面和前言，然后进入目录。目录会随着收集到的书页自动更新。章节会自动出现。正文拥有页码。长文本会延续到后续页面。玩家可以从阅读页面返回目录，也可以从目录直接跳转到指定章节或书页。 ### 面向整合包/作者的总结 v2.0.0 更适合维护长篇日志内容。章节名、章节前言、书页名和书页内容都集中在同一个地方管理。生成的配置文件会格式化为易读的多行结构。后续添加章节或书页时，只需要修改配置，不需要改代码，只要按对应 `PageId` 顺序发放书页即可。 ### 升级注意事项 - 从 1.0.0 升级到 2.0.0 时，Forge 不会自动覆盖已有配置文件。 - 要直接使用新版默认配置，请删除旧的已生成配置文件后重新启动游戏。 - 如果已经自定义过日志内容，请手动迁移到新的结构。 - 旧的 `PageId` 机制仍然存在，但显示页码会根据章节和自动分页结果重新计算。