TriM-Organization/LiteyukiBot-TriM
2
0
Fork 0
mirror of https://github.com/TriM-Organization/LiteyukiBot-TriM.git synced 2024-11-25 00:25:04 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Update resource_pack.md

Browse Source
This commit is contained in:
Snowykami 2024-04-07 04:16:53 +08:00 committed by GitHub
parent c45061a95a
commit 2781c8bdfb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/usage/resource_pack.md
View File

@ -6,32 +6,34 @@ category: 使用手册
--- ---
## 简介 ## 简介
资源包,也可根据用途称为主题包、字体包、语言包等,它允许你一定程度上自定义轻雪的外观,并且不用修改源码 资源包,亦可根据用途称为主题包、字体包、语言包等，它允许你一定程度上自定义轻雪的外观,并且不用修改源代码
- [资源/主题商店](/store/)提供了一些资源包供你选择,你也可以自己制作资源包 - [资源/主题商店](/store/)提供了一些资源包供你选择，你也可以自己制作资源包
- 资源包的制作很简单,如果你接触过`Minecraft`的资源包,那么你会很快上手 - 资源包的制作很简单，如果你接触过`Minecraft`的资源包，那么你能够很快就上手，仅需按照原有路径进行文件替换即刻，讲起打包成一个新的资源包。
- 部分内容制作需要一点点前端基础,例如`html`,`css`,如果你不懂,可以参考一些教程 - 部分内容制作需要一点点前端基础,例如`html`，`css`
- 轻雪原版资源包请查看`LiteyukiBot/liteyuki/resources`，可以在此基础上进行修改
- 欢迎各位投稿资源包到轻雪资源商店 - 欢迎各位投稿资源包到轻雪资源商店
## 加载资源包 ## 加载资源包
- 下载的资源包通常是以`.zip`格式压缩的,你只需要将其解压到根目录`resources`目录下即可,注意不要嵌套文件夹,正常的路径应该是这样的 - 资源包通常是以`.zip`格式压缩的，只需要将其解压到根目录`resources`目录下即可，注意不要嵌套文件夹,正常的路径应该是这样的
```shell ```shell
main.py main.py
resources resources
├─resource_pack_1 └─resource_pack_1
├───metadata.yml ├─metadata.yml
├───templates ├─templates
└───... └───...
└─resource_pack_2 └─resource_pack_2
├───metadata.yml ├─metadata.yml
└───... └─...
``` ```
- 你自己制作的资源包也应该遵循这个规则,并且应该在`metadata.yml`中填写一些信息 - 你自己制作的资源包也应该遵循这个规则,并且应该在`metadata.yml`中填写一些信息
- 若没有`metadata.yml`文件,则轻雪不会加载这个资源包 - 若没有`metadata.yml`文件，则该文件夹不会被识别为资源包
```yaml ```yaml
name: "资源包名称" name: "资源包名称"
version: "1.0.0" version: "1.0.0"
description: "资源包描述" description: "资源包描述"
... # 你可以自定义一些信息,但请保证以上三个字段 # 你可以自定义一些信息,但请保证以上三个字段
...
``` ```
- 资源包加载遵循一个优先级，即后加载的资源包会覆盖前面的资源包，也就是说，你在A资源包中定义了一个`index.html`文件，B资源包也定义了一个`index.html`文件，那么加载B资源包后，A资源包中的`index.html`文件会被覆盖 - 资源包加载遵循一个优先级，即后加载的资源包会覆盖前面的资源包，例如，你在A包中定义了一个`index.html`文件，B包也定义了一个`index.html`文件，那么加载B包后，A包中的`index.html`文件会被覆盖
- 对于不同资源包的不同文件，是可以相对引用的，例如你在A资源包中的`index.html`文件中引用了B资源包中的`style.css`文件，那么加载A资源包后，轻雪会自动加载B资源包中的`style.css`文件 - 对于不同资源包的不同文件，是可以相对引用的，例如你在A中定义了`templates/index.html`，在B中定义了`templates/style.css`，可以在A的`index.html`中用`./style.css`相对路径引用B中的css