Guidebook.md

模组

· 作者 Garkatron

为 BTA 添加 Markdown 指南功能,使模组开发者能够高效地创建和格式化指南。 BTA 中新增了 Markdown 书籍功能,允许用户创建、编辑和组织完整的、兼容 Markdown 的文档结构。

0 本站下载 0 关注 更新于 1 年前

需要前置:HalpLibe

最新 1.1.0 · BTA Babric

一键开服(送7天)

指南书.md

帮助 BTA 模组开发者快速、轻松地使用带有额外功能的 Markdown 创建模组指南

如何使用?
创建一个继承自 MDBookScreen 的类。
从资源路径加载配置,包含 .md 文件。
像普通屏幕一样使用,通过触发器打开。

格式

使用 < & > 字符表示颜色代码:

- 0 = &0黑色
- 1 = &1深蓝色
- 2 = &2深绿色
- 3 = &3深青色
- 4 = &4深红色
- 5 = &5深紫色
- 6 = &6金色
- 7 = &7灰色
- 8 = &8深灰色
- 9 = &9蓝色
- a = &a绿色
- b = &b青色
- c = &c红色
- d = &d浅紫色
- e = &e黄色
- f = &f白色
- s = &s阴影
- r = 重置

语法

适用于 &6BTA 指南书格式的常规 &3Markdown 语法:
# H1
## H2
### H3
#### H4
##### H5
###### H6
* 无序列表
- 无序列表
1. 有序列表

特殊功能

**图片**
- [文本](/assets/modid/textures/path/to/img.png)(宽度,高度,类型)
- ![物品栏槽位](modid:item/name)
- ![工作台](空,空,空,空,空,空,空,空,空, 空)
  • 宽度和高度单位为像素
  • 类型 = default(默认)| icon(图标)或留空以使用默认选项
  • 工作台的最后一个槽位用于输出物品

如何使用?

Markdown 指南书

public class MyBook extends MarkdownGuidebook<MDPage> {

    public IntroBook() {
        String path = "/assets/modid/markdown/mybook/";
        config = BookConfig.fromJsonResource(getClass(), path + "config.json");

DecimalFormat formatter = new DecimalFormat("000");
        for (int i = 0; i<11; i++) {
            String fileName = "page_" + formatter.format(i + 1) + ".md";

            loadMarkdownPages(path + fileName);
        }
    }
}

显示 Markdown

查看父类以获取更多信息。

public class MyMDScreen extends MDScreen {
    public MyMDScreen() {
        currentPage = MarkdownCompiler.compile("/assets/modid/markdown/path/to/your/file.md", getClass());
    }
}

游戏内 Markdown 编辑器

在游戏中使用可编辑的书,并将 Markdown 内容导出以供在你的项目中使用! 或者用它来与世界中的朋友分享信息!

image image

命令

导出或加载 Markdown 书籍。

  • 用法: /guidebook export <title>

    • 导出到: btafolder/guidebook/exported/<title>
  • 用法: /guidebook load <title>

    • 从以下位置加载: btafolder/guidebook/load/<title>

展示

下载发布页面中包含文件的 zip 包 image

你是这个资源的作者?登录后可认领此资源。

评论 0

0.0
暂无评分
5 星
0
4 星
0
3 星
0
2 星
0
1 星
0
我的评分

登录后参与评分

还没有评论,来抢沙发吧

评论配图

相似资源