LiteyukiBot/docs/dev/dev_resource_pack.md

53 lines
2.4 KiB
Markdown
Raw Normal View History

2024-04-06 01:10:01 +00:00
---
title: 资源包开发
icon: box
order: 1
category: 开发
2024-04-06 01:10:01 +00:00
---
## 简介
2024-04-06 20:16:53 +00:00
资源包,亦可根据用途称为主题包、字体包、语言包等,它允许你一定程度上自定义轻雪的外观,并且不用修改源代码
2024-04-06 20:16:53 +00:00
- [资源/主题商店](/store/)提供了一些资源包供你选择,你也可以自己制作资源包
2024-04-10 15:06:55 +00:00
- 资源包的制作很简单,如果你接触过`Minecraft`的资源包,那么你能够很快就上手,仅需按照原有路径进行文件替换即可,讲起打包成一个新的资源包。
2024-04-06 20:16:53 +00:00
- 部分内容制作需要一点点前端基础,例如`html``css`
- 轻雪原版资源包请查看`LiteyukiBot/liteyuki/resources`,可以在此基础上进行修改
2024-04-06 01:10:01 +00:00
- 欢迎各位投稿资源包到轻雪资源商店
请注意主题包中的html渲染使用Js来规定数据的渲染位置请确保您所编写的html代码能被Bot解析否则会导致渲染失败或渲染结果不理想/异常/错位等无法预料的事情发生。推荐在编写html时同时更改对应Js代码以避免出现无法预料的问题。
---
2024-04-06 01:10:01 +00:00
## 加载资源包
2024-04-06 20:16:53 +00:00
- 资源包通常是以`.zip`格式压缩的,只需要将其解压到根目录`resources`目录下即可,注意不要嵌套文件夹,正常的路径应该是这样的
2024-04-06 01:10:01 +00:00
```shell
main.py
resources
2024-04-06 20:16:53 +00:00
└─resource_pack_1
├─metadata.yml
├─templates
2024-04-06 01:10:01 +00:00
└───...
└─resource_pack_2
2024-04-06 20:16:53 +00:00
├─metadata.yml
└─...
2024-04-06 01:10:01 +00:00
```
2024-04-06 01:10:01 +00:00
- 你自己制作的资源包也应该遵循这个规则,并且应该在`metadata.yml`中填写一些信息
2024-04-06 20:16:53 +00:00
- 若没有`metadata.yml`文件,则该文件夹不会被识别为资源包
2024-04-06 01:10:01 +00:00
```yaml
name: "资源包名称"
version: "1.0.0"
description: "资源包描述"
2024-04-06 20:16:53 +00:00
# 你可以自定义一些信息,但请保证以上三个字段
...
2024-04-06 01:10:01 +00:00
```
2024-04-06 20:16:53 +00:00
- 资源包加载遵循一个优先级即后加载的资源包会覆盖前面的资源包例如你在A包中定义了一个`index.html`文件B包也定义了一个`index.html`文件那么加载B包后A包中的`index.html`文件会被覆盖
- 对于不同资源包的不同文件是可以相对引用的例如你在A中定义了`templates/index.html`在B中定义了`templates/style.css`可以在A的`index.html`中用`./style.css`相对路径引用B中的css
> [!tip]
> 资源包的结构会随着轻雪的更新而有变动,第三方资源包开发者需要注意版本兼容性,同时用户也应该自行选择可用的资源包