LiteyukiBot/en/dev/resource.html

38 lines
50 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>资源包开发 | LiteyukiBot</title>
<meta name="description" content="A high-performance, easy-to-use chatbot framework and application">
<meta name="generator" content="VitePress v1.3.4">
<link rel="preload stylesheet" href="/assets/style.DVPwihk6.css" as="style">
<script type="module" src="/assets/app.Xpkj2rQT.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/theme.B3wRU1ER.js">
<link rel="modulepreload" href="/assets/chunks/framework.C4_mTacX.js">
<link rel="modulepreload" href="/assets/en_dev_resource.md.Q8AwzAyN.lean.js">
<link rel="icon" type="image/x-icon" href="favicon.ico">
<link rel="stylesheet" href="https://fonts.font.im/css?family=Cousine:400,400i,700,700i|Poppins:100,100i,200,200i,300,300i,400,400i,500,500i,600,600i,700,700i,800,800i,900,900i">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-be658c97 data-v-4be82239><!--[--><!--]--><!--[--><span tabindex="-1" data-v-4a10e730></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-4a10e730> Skip to content </a><!--]--><!----><header class="VPNav" data-v-4be82239 data-v-10d5e81f><div class="VPNavBar has-sidebar top" data-v-10d5e81f data-v-03df6358><div class="wrapper" data-v-03df6358><div class="container" data-v-03df6358><div class="title" data-v-03df6358><div class="VPNavBarTitle has-sidebar" data-v-03df6358 data-v-01425599><a class="title" href="/en/" data-v-01425599><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/liteyuki-dark.svg" alt="LiteyukiBot Logo" data-v-8fba738a><!--]--><!--[--><img class="VPImage light logo" src="/liteyuki.svg" alt="LiteyukiBot Logo" data-v-8fba738a><!--]--><!--]--><!--]--><span data-v-01425599>LiteyukiBot</span><!--[--><!--]--></a></div></div><div class="content" data-v-03df6358><div class="content-body" data-v-03df6358><!--[--><!--]--><div class="VPNavBarSearch search" data-v-03df6358><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-03df6358 data-v-a0b069c0><span id="main-nav-aria-label" class="visually-hidden" data-v-a0b069c0> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/deploy/install.html" tabindex="0" data-v-a0b069c0 data-v-c1f5da45><!--[--><span data-v-c1f5da45>Deploy</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/usage/basic.html" tabindex="0" data-v-a0b069c0 data-v-c1f5da45><!--[--><span data-v-c1f5da45>Usage</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/store/resource.html" tabindex="0" data-v-a0b069c0 data-v-c1f5da45><!--[--><span data-v-c1f5da45>Extension</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/dev/guide.html" tabindex="0" data-v-a0b069c0 data-v-c1f5da45><!--[--><span data-v-c1f5da45>Develop</span><!--]--></a><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-03df6358 data-v-a0e85ae2 data-v-4e740509><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="Language" data-v-4e740509><span class="text" data-v-4e740509><span class="vpi-languages option-icon" data-v-4e740509></span><!----><span class="vpi-chevron-down text-icon" data-v-4e740509></span></span></button><div class="menu" data-v-4e740509><div class="VPMenu" data-v-4e740509 data-v-4397d6aa><!----><!--[--><!--[--><div class="items" data-v-a0e85ae2><p class="title" data-v-a0e85ae2>English</p><!--[--><div class="VPMenuLink" data-v-a0e85ae2 data-v-90280799><a class="VPLink link" href="/dev/resource.html" data-v-90280799><!--[-->简体中文<!--]--></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-03df6358 data-v-0e100a46><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Dark Mode" aria-checked="false" data-v-0e100a46 data-v-10656515 data-v-8727337c><span class="check" data-v-8727337c><span class="icon" data-v-8727337c><!--[--><span class="vpi-sun sun" data-v-10656515></span><span class="vpi-moon moon" data-v-10656515></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-03df6358 data-v-ca530fac data-v-b1e9369e><!--[--><a class="VPSocialLink no-icon" href="https://github.com/LiteyukiStudio/LiteyukiBot" aria-label="github" target="_blank" rel="noopener" data-v-b1e9369e data-v-9abc2d2a><span class="vpi-social-github" /></a><!--]--></div><div class="VPFlyout VPNavBarExtra
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">resources</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">└─resource_pack_1</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> ├─metadata.yml</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> ├─templates</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> └───...</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">└─resource_pack_2</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> ├─metadata.yml</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> └─...</span></span></code></pre></div><ul><li>你自己制作的资源包也应该遵循这个规则,并且应该在<code>metadata.yml</code>中填写一些信息</li><li>若没有<code>metadata.yml</code>文件,则该文件夹不会被识别为资源包</li></ul><div class="language-yaml vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">yaml</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">name</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;资源包名称&quot;</span></span>
<span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">version</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;1.0.0&quot;</span></span>
<span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">description</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;资源包描述&quot;</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># 你可以自定义一些信息,但请保证以上三个字段</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">...</span></span></code></pre></div><ul><li>资源包加载遵循一个优先级即后加载的资源包会覆盖前面的资源包例如你在A包中定义了一个<code>index.html</code>文件B包也定义了一个<code>index.html</code>文件那么加载B包后A包中的<code>index.html</code>文件会被覆盖</li><li>对于不同资源包的不同文件是可以相对引用的例如你在A中定义了<code>templates/index.html</code>在B中定义了<code>templates/style.css</code>可以在A的<code>index.html</code>中用<code>./style.css</code>相对路径引用B中的css</li></ul><div class="tip custom-block github-alert"><p class="custom-block-title">TIP</p><p>资源包的结构会随着轻雪的更新而有变动,第三方资源包开发者需要注意版本兼容性,同时用户也应该自行选择可用的资源包</p></div></div></div></main><footer class="VPDocFooter" data-v-1b1e6eb6 data-v-bb44dcf3><!--[--><!--]--><div class="edit-info" data-v-bb44dcf3><div class="edit-link" data-v-bb44dcf3><a class="VPLink link vp-external-link-icon no-icon edit-link-button" href="https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/docs/en/dev/resource.md" target="_blank" rel="noreferrer" data-v-bb44dcf3><!--[--><span class="vpi-square-pen edit-link-icon" data-v-bb44dcf3></span> Edit this page on GitHub<!--]--></a></div><div class="last-updated" data-v-bb44dcf3><p class="VPLastUpdated" data-v-bb44dcf3 data-v-e2247888>Last updated: <time datetime="2024-08-31T11:05:37.000Z" data-v-e2247888></time></p></div></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-bb44dcf3><span class="visually-hidden" id="doc-footer-aria-label" data-v-bb44dcf3>Pager</span><div class="pager" data-v-bb44dcf3><a class="VPLink link pager-link prev" href="/en/dev/guide.html" data-v-bb44dcf3><!--[--><span class="desc" data-v-bb44dcf3>Prev Page</span><span class="title" data-v-bb44dcf3>Development Guide</span><!--]--></a></div><div class="pager" data-v-bb44dcf3><a class="VPLink link pager-link next" href="/en/dev/lyfunc.html" data-v-bb44dcf3><!--[--><span class="desc" data-v-bb44dcf3>Next Page</span><span class="title" data-v-bb44dcf3>轻雪函数</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-4be82239 data-v-d5f9ff66><div class="container" data-v-d5f9ff66><p class="message" data-v-d5f9ff66>Documentation built with <a href="https://vitepress.dev/">VitePress</a> | API references generated by <a href="https://github.com/LiteyukiStudio/litedoc">litedoc</a></p><p class="copyright" data-v-d5f9ff66>Copyright (C) 2020-2024 LiteyukiStudio. All Rights Reserved</p></div></footer><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"deploy_config.md\":\"BBoJ_SVs\",\"deploy_fandq.md\":\"D3AaSKzf\",\"deploy_install.md\":\"DMcLeaSP\",\"dev_api_bot_index.md\":\"CO6VsP4-\",\"dev_api_bot_lifespan.md\":\"Brz5v0DB\",\"dev_api_comm_channel.md\":\"DqKQ48r8\",\"dev_api_comm_event.md\":\"CKj2UKdm\",\"dev_api_comm_index.md\":\"uufyI1S9\",\"dev_api_comm_rpc.md\":\"DZB2wFct\",\"dev_api_comm_socks_channel.md\":\"D_LOQMVo\",\"dev_api_comm_storage.md\":\"ByeStviG\",\"dev_api_config.md\":\"B6-1F5M4\",\"dev_api_core_index.md\":\"SSSl_XRw\",\"dev_api_core_manager.md\":\"CUxE2_uH\",\"dev_api_dev_index.md\":\"Ckrx8rJ6\",\"dev_api_dev_observer.md\":\"CK2VQ1dm\",\"dev_api_dev_plugin.md\":\"CQmBgdvS\",\"dev_api_exception.md\":\"CHNyxSqL\",\"dev_api_index.md\":\"D5E434zv\",\"dev_api_log.md\":\"BTzz4w7t\",\"dev_api_message_event.md\":\"ClMwOOd3\",\"dev_api_message_index.md\":\"CCG9t-zb\",\"dev_api_message_matcher.md\":\"C-ROK-bX\",\"dev_api_message_on.md\":\"BL6JkrM3\",\"dev_api_message_rule.md\":\"Cl4Pbacm\",\"dev_api_message_session.md\":\"CC5IECPx\",\"dev_api_mkdoc.md\":\"D83YPFf0\",\"dev_api_plugin_index.md\":\"s_ae6nFU\",\"dev_api_plugin_load.md\":\"Dr9bABNT\",\"dev_api_plugin_manager.md\":\"rRp7jB1O\",\"dev_api_plugin_model.md\":\"BDcYOOls\",\"dev_api_plugins_index.md\":\"CSspw-A7\",\"dev_api_plugins_liteecho.md\":\"B8fCIJFA\",\"dev_api_plugins_plugin_loader_index.md\":\"BUTV_7BY\",\"dev_api_utils.md\":\"CvLxJfa5\",\"dev_comm.md\":\"cMJIV6AK\",\"dev_guide.md\":\"DrgGe0HA\",\"dev_lyfunc.md\":\"D4LU5X67\",\"dev_plugin.md\":\"phZolwS6\",\"dev_resource.md\":\"CiEukBtC\",\"en_deploy_config.md\":\"DdMT5vqs\",\"en_deploy_fandq.md\":\"BKc7kj27\",\"en_deploy_install.md\":\"C00Sx2cS\",\"en_dev_api_bot_index.md\":\"BKlim-xP\",\"en_dev_api_bot_lifespan.md\":\"XWy-18_r\",\"en_dev_api_comm_channel.md\":\"BdNiQzBm\",\"en_dev_api_comm_event.md\":\"C-rHpKa9\",\"en_dev_api_comm_index.md\":\"Dg6nSUT4\",\"en_dev_api_comm_rpc.md\":\"Dot66ZOf\",\"en_dev_api_comm_socks_channel.md\":\"B-Ph112g\",\"en_dev_api_comm_storage.md\":\"Cmhtt_I0\",\"en_dev_api_config.md\":\"BeBusNL-\",\"en_dev_api_core_index.md\":\"CJrGoxVS\",\"en_dev_api_core_manager.md\":\"C-smFgZK\",\"en_dev_api_dev_index.md\":\"IWiJmN2l\",\"en_dev_api_dev_observer.md\":\"D-WCNidu\",\"en_dev_api_dev_plugin.md\":\"DKRyz1o4\",\"en_dev_api_exception.md\":\"DfRyv62x\",\"en_dev_api_index.md\":\"Clr1QQbT\",\"en_dev_api_log.md\":\"CDk5dyBa\",\"en_dev_api_message_event.md\":\"DEcIQdiK\",\"en_dev_api_message_index.md\":\"Cy6O48O3\",\"en_dev_api_message_matcher.md\":\"D8JXS8zE\",\"en_dev_api_message_on.md\":\"cvWZYehF\",\"en_dev_api_message_rule.md\":\"Gu_H8fye\",\"en_dev_api_message_session.md\":\"qPDLFiy0\",\"en_dev_api_mkdoc.md\":\"DWIWl3U9\",\"en_dev_api_plugin_index.md\":\"B1_Dcoud\",\"en_dev_api_plugin_load.md\":\"D4Kj7cH5\",\"en_dev_api_plugin_manager.md\":\"DwpN_WJP\",\"en_dev_api_plugin_model.md\":\"DJi_Hqis\",\"en_dev_api_plugins_index.md\":\"BP3-0fiD\",\"en_dev_api_plugins_liteecho.md\":\"qdho9nqc\",\"en_dev_api_plugins_plugin_loader_index.md\":\"CYeKyOFO\",\"en_dev_api_utils.md\":\"Cn9x0Itt\",\"en_dev_comm.md\":\"DWySVBZ2\",\"en_dev_guide.md\":\"DF3K9dKH\",\"en_dev_lyfunc.md\":\"BhYjNK3N\",\"en_dev_plugin.md\":\"CKzO3RVR\",\"en_dev_resource.md\":\"Q8AwzAyN\",\"en_index.md\":\"DS37TlOH\",\"en_store_plugin.md\":\"C0UyBVv2\",\"en_store_resource.md\":\"Ci-LBCav\",\"en_usage_agreement.md\":\"vFfahjeR\",\"en_usage_basic.md\":\"DVpsBy5w\",\"en_usage_extra.md\":\"DU-WQhbO\",\"index.md\":\"Dl11pd1E\",\"store_plugin.md\":\"BhQadjel\",\"store_resource.md\":\"CgUrr2wJ\",\"usage_agreement.md\":\"BYijSUyJ\",\"usage_basic.md\":\"CS9J19pD\",\"usage_extra.md\":\"CPLcG44C\"}");function deserializeFunctions(r){return Array.isArray(r)?r.map(deserializeFunctions):typeof r=="object"&&r!==null?Object.keys(r).reduce((t,n)=>(t[n]=deserializeFunctions(r[n]),t),{}):typeof r=="string"&&r.startsWith("_vp-fn_")?new Function(`return ${r.slice(7)}`)():r};window.__VP_SITE_DATA__=deserializeFunctions(JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"VitePress\",\"description\":\"A VitePress site\",\"base\
</body>
</html>