mirror of
https://github.com/LiteyukiStudio/LiteyukiBot.git
synced 2024-11-25 07:45:06 +08:00
27 lines
56 KiB
HTML
27 lines
56 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-US" dir="ltr">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<title>Development Guide | 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.BptoPPZv.css" as="style">
|
||
|
||
<script type="module" src="/assets/app.-ZqTsXQn.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.BhLBD9XT.js">
|
||
<link rel="modulepreload" href="/assets/chunks/framework.C4_mTacX.js">
|
||
<link rel="modulepreload" href="/assets/chunks/ContributorBar.DZkY60nH.js">
|
||
<link rel="modulepreload" href="/assets/en_dev_guide.md.C1967iq1.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-2391887b data-v-5047c77d><!--[--><!--]--><!--[--><span tabindex="-1" data-v-5ffb6bc3></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-5ffb6bc3> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5047c77d data-v-3aff48bd><div class="VPNavBar has-sidebar top" data-v-3aff48bd data-v-6db865c9><div class="wrapper" data-v-6db865c9><div class="container" data-v-6db865c9><div class="title" data-v-6db865c9><div class="VPNavBarTitle has-sidebar" data-v-6db865c9 data-v-d1e2cfaa><a class="title" href="/en/" data-v-d1e2cfaa><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/liteyuki-dark.svg" alt="LiteyukiBot Logo" data-v-e2df84be><!--]--><!--[--><img class="VPImage light logo" src="/liteyuki.svg" alt="LiteyukiBot Logo" data-v-e2df84be><!--]--><!--]--><!--]--><span data-v-d1e2cfaa>LiteyukiBot</span><!--[--><!--]--></a></div></div><div class="content" data-v-6db865c9><div class="content-body" data-v-6db865c9><!--[--><!--]--><div class="VPNavBarSearch search" data-v-6db865c9><!--[--><!----><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-6db865c9 data-v-dc270a69><span id="main-nav-aria-label" class="visually-hidden" data-v-dc270a69> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/deploy/install.html" tabindex="0" data-v-dc270a69 data-v-2a328df5><!--[--><span data-v-2a328df5>Deploy</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/usage/basic.html" tabindex="0" data-v-dc270a69 data-v-2a328df5><!--[--><span data-v-2a328df5>Usage</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/store/resource.html" tabindex="0" data-v-dc270a69 data-v-2a328df5><!--[--><span data-v-2a328df5>Extension</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/en/dev/guide.html" tabindex="0" data-v-dc270a69 data-v-2a328df5><!--[--><span data-v-2a328df5>Develop</span><!--]--></a><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-6db865c9 data-v-1cf30254 data-v-062a5734><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="Language" data-v-062a5734><span class="text" data-v-062a5734><span class="vpi-languages option-icon" data-v-062a5734></span><!----><span class="vpi-chevron-down text-icon" data-v-062a5734></span></span></button><div class="menu" data-v-062a5734><div class="VPMenu" data-v-062a5734 data-v-ce2cf657><!----><!--[--><!--[--><div class="items" data-v-1cf30254><p class="title" data-v-1cf30254>English</p><!--[--><div class="VPMenuLink" data-v-1cf30254 data-v-01a82388><a class="VPLink link" href="/dev/guide.html" data-v-01a82388><!--[-->简体中文<!--]--></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-6db865c9 data-v-06e253f6><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Dark Mode" aria-checked="false" data-v-06e253f6 data-v-d86ee44f data-v-be0da757><span class="check" data-v-be0da757><span class="icon" data-v-be0da757><!--[--><span class="vpi-sun sun" data-v-d86ee44f></span><span class="vpi-moon moon" data-v-d86ee44f></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-6db865c9 data-v-489228c3 data-v-ca9cff1c><!--[--><a class="VPSocialLink no-icon" href="https://github.com/LiteyukiStudio/LiteyukiBot" aria-label="github" target="_blank" rel="noopener" data-v-ca9cff1c data-v-99aaa61b><span class="vpi-social-github" /></a><a class="VPSocialLink no-icon" href="https://git.liteyuki.icu/LiteyukiStudio/LiteyukiBot" aria-label target="_blank" rel="noopener" data-v-ca9cff1c data-v-99aaa61b><svg t="1725391346807" class="icon" viewBox="0 0 1025 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="5067" width="256" height="256"><path d="M1004.692673 466.396616l-447.094409-447.073929c-25.743103-25.763582-67.501405-25.763582-93.264987 0l-103.873521 103.873521 78.171378 78.171378c12.533635-6.00058 26.562294-9.359266 41.389666-9.359266 53.02219 0 96.00928 42.98709 96.00928 96.00928 0 14.827372-3.358686 28.856031-9.359266 41.389666l127.97824 127.97824c12.533635-6.00058 26.562294-9.359266 41.389666-9.359266 53.02219 0 96.00928 42.98709 96.00928 96.00928s-42.98709 96.00928-96.00928 96.00928-96.00928-42.98709-96.00928-96.00928c0-14.827372 3.358686-28.856031 9.359266-41.389666l-127.97824-127.97824c-3.051489 1.454065-6.184898 2.744293-9.379746 3.870681l0 266.97461c37.273227 13.188988 63.99936 48.721433 63.99936 90.520695 0 53.02219-42.98709 96.00928-96.00928 96.00928s-96.00928-42.98709-96.00928-96.00928c0-41.799262 26.726133-77.331707 63.99936-90.520695l0-266.97461c-37.273227-13.188988-63.99936-48.721433-63.99936-90.520695 0-14.827372 3.358686-28.856031 9.359266-41.389666l-78.171378-78.171378-295.892081 295.871601c-25.743103 25.784062-25.743103 67.542365 0 93.285467l447.114889 447.073929c25.743103 25.743103 67.480925 25.743103 93.264987 0l445.00547-445.00547c25.763582-25.763582 25.763582-67.542365 0-93.285467z" fill="#a2d8f4" p-id="5068"></path></svg></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-6db865c9 data-v-cf308650 data-v-062a5734><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-062a5734><span class="vpi-more-horizontal icon" data-v-062a5734></span></button><div class="menu" data-v-062a5734><div class="VPMenu" data-v-062a5734 data-v-ce2cf657><!----><!--[--><!--[--><div class="group translations" data-v-cf308650><p class="trans-title" data-v-cf308650>English</p><!--[--><div class="VPMenuLink" data-v-cf308650 data-v-01a82388><a class="VPLink link" href="/dev/guide.html" data-v-01a82388><!--[-->简体中文<!--]--></a></div><!--]--></div><div class="group" data-v-cf308650><div class="item appearance" data-v-cf308650><p class="label" data-v-cf308650>Theme</p><div class="appearance-action" data-v-cf308650><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Dark Mode" aria-checked="false" data-v-cf308650 data-v-d86ee44f data-v-be0da757><span class="check" data-v-be0da757><span class="icon" data-v-be0da757><!--[--><span class="vpi-sun sun" data-v-d86ee44f></span><span class="vpi-moon moon" data-v-d86ee44f></span><!--]--></span></span></button></div></div></div><div class="group" data-v-cf308650><div class="item social-links" data-v-cf308650><div class="VPSocialLinks social-links-list" data-v-cf308650 data-v-ca9cff1c><!--[--><a class="VPSocialLink no-icon" href="https://github.com/LiteyukiStudio/LiteyukiBot" aria-label="github" target="_blank" rel="noopener" data-v-ca9cff1c data-v-99aaa61b><span class="vpi-social-github" /></a><a class="VPSocialLink no-icon" href="https://git.liteyuki.icu/LiteyukiStudio/LiteyukiBot" aria-label target="_blank" rel="noopener" data-v-ca9cff1c data-v-99aaa61b><svg t="1725391346807" class="icon" viewBox="0 0 1025 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="5067" width="256" height="256"><path d="M1004.692673 466.396616l-447.094409-447.073929c-25.743103-25.763582-67.501405-25.763582-93.264987 0l-103.873521 103.873521 78.171378 78.171378c12.533635-6.00058 26.562294-9.359266 41.389666-9.359266 53.02219 0 96.00928 42.98709 96.00928 96.00928 0 14.827372-3.358686 28.856031-9.359266 41.389666l127.97824 127.97824c12.533635-6.00058 26.562294-9.359266 41.389666-9.359266 53.02219 0 96.00928 42.98709 96.00928 96.00928s-42.98709 96.00928-96.00928 96.00928-96.00928-42.98709-96.00928-96.00928c0-14.827372 3.358686-28.856031 9.359266-41.389666l-127.97824-127.97824c-3.051489 1.454065-6.184898 2.744293-9.379746 3.870681l0 266.97461c37.273227 13.188988 63.99936 48.721433 63.99936 90.520695 0 53.02219-42.98709 96.00928-96.00928 96.00928s-96.00928-42.98709-96.00928-96.00928c0-41.799262 26.726133-77.331707 63.99936-90.520695l0-266.97461c-37.273227-13.188988-63.99936-48.721433-63.99936-90.520695 0-14.827372 3.358686-28.856031 9.359266-41.389666l-78.171378-78.171378-295.892081 295.871601c-25.743103 25.784062-25.743103 67.542365 0 93.285467l447.114889 447.073929c25.743103 25.743103 67.480925 25.743103 93.264987 0l445.00547-445.00547c25.763582-25.763582 25.763582-67.542365 0-93.285467z" fill="#a2d8f4" p-id="5068"></path></svg></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-6db865c9 data-v-cdf5d88e><span class="container" data-v-cdf5d88e><span class="top" data-v-cdf5d88e></span><span class="middle" data-v-cdf5d88e></span><span class="bottom" data-v-cdf5d88e></span></span></button></div></div></div></div><div class="divider" data-v-6db865c9><div class="divider-line" data-v-6db865c9></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-5047c77d data-v-cb0eba99><div class="container" data-v-cb0eba99><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-cb0eba99><span class="vpi-align-left menu-icon" data-v-cb0eba99></span><span class="menu-text" data-v-cb0eba99>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-cb0eba99 data-v-c1bcce0a><button data-v-c1bcce0a>Back to top</button><!----></div></div></div><aside class="VPSidebar" data-v-5047c77d data-v-bc2dce68><div class="curtain" data-v-bc2dce68></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-bc2dce68><span class="visually-hidden" id="sidebar-aria-label" data-v-bc2dce68> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-1e9a5d2e><section class="VPSidebarItem level-0 has-active" data-v-1e9a5d2e data-v-fe6d72fb><div class="item" role="button" tabindex="0" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><h2 class="text" data-v-fe6d72fb>LITEYUKIBOT</h2><!----></div><div class="items" data-v-fe6d72fb><!--[--><div class="VPSidebarItem level-1 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/guide.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>Development Guide</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/resource.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>Resource Pack</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/lyfunc.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>Liteyuki Function</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/plugin.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>Liteyuki Plugin</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/comm.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>Process Communication</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/best_practices.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>Best Practices</p><!--]--></a><!----></div><!----></div><section class="VPSidebarItem level-1 collapsible collapsed is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" tabindex="0" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/index.html" data-v-fe6d72fb><!--[--><h3 class="text" data-v-fe6d72fb>liteyuki API</h3><!--]--></a><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-fe6d72fb><span class="vpi-chevron-right caret-icon" data-v-fe6d72fb></span></div></div><div class="items" data-v-fe6d72fb><!--[--><section class="VPSidebarItem level-2 collapsible collapsed is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" tabindex="0" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/bot/index.html" data-v-fe6d72fb><!--[--><h4 class="text" data-v-fe6d72fb>liteyuki.bot</h4><!--]--></a><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-fe6d72fb><span class="vpi-chevron-right caret-icon" data-v-fe6d72fb></span></div></div><div class="items" data-v-fe6d72fb><!--[--><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/bot/" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.bot</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/bot/lifespan.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.bot.lifespan</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-2 collapsible collapsed is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" tabindex="0" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/comm/index.html" data-v-fe6d72fb><!--[--><h4 class="text" data-v-fe6d72fb>liteyuki.comm</h4><!--]--></a><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-fe6d72fb><span class="vpi-chevron-right caret-icon" data-v-fe6d72fb></span></div></div><div class="items" data-v-fe6d72fb><!--[--><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/comm/channel.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.comm.channel</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/comm/event.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.comm.event</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/comm/" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.comm</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/comm/rpc.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.comm.rpc</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/comm/socks_channel.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.comm.socks_channel</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/comm/storage.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.comm.storage</p><!--]--></a><!----></div><!----></div><!--]--></div></section><div class="VPSidebarItem level-2 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/config.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.config</p><!--]--></a><!----></div><!----></div><section class="VPSidebarItem level-2 collapsible collapsed is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" tabindex="0" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/core/index.html" data-v-fe6d72fb><!--[--><h4 class="text" data-v-fe6d72fb>liteyuki.core</h4><!--]--></a><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-fe6d72fb><span class="vpi-chevron-right caret-icon" data-v-fe6d72fb></span></div></div><div class="items" data-v-fe6d72fb><!--[--><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/core/" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.core</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/core/manager.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.core.manager</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-2 collapsible collapsed is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" tabindex="0" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/dev/index.html" data-v-fe6d72fb><!--[--><h4 class="text" data-v-fe6d72fb>liteyuki.dev</h4><!--]--></a><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-fe6d72fb><span class="vpi-chevron-right caret-icon" data-v-fe6d72fb></span></div></div><div class="items" data-v-fe6d72fb><!--[--><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/dev/" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.dev</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/dev/observer.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.dev.observer</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/dev/plugin.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.dev.plugin</p><!--]--></a><!----></div><!----></div><!--]--></div></section><div class="VPSidebarItem level-2 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/exception.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.exception</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/log.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.log</p><!--]--></a><!----></div><!----></div><section class="VPSidebarItem level-2 collapsible collapsed is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" tabindex="0" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/message/index.html" data-v-fe6d72fb><!--[--><h4 class="text" data-v-fe6d72fb>liteyuki.message</h4><!--]--></a><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-fe6d72fb><span class="vpi-chevron-right caret-icon" data-v-fe6d72fb></span></div></div><div class="items" data-v-fe6d72fb><!--[--><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/message/event.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.message.event</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/message/" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.message</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/message/matcher.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.message.matcher</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/message/on.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.message.on</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/message/rule.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.message.rule</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/message/session.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.message.session</p><!--]--></a><!----></div><!----></div><!--]--></div></section><div class="VPSidebarItem level-2 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/mkdoc.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.mkdoc</p><!--]--></a><!----></div><!----></div><section class="VPSidebarItem level-2 collapsible collapsed is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" tabindex="0" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/plugin/index.html" data-v-fe6d72fb><!--[--><h4 class="text" data-v-fe6d72fb>liteyuki.plugin</h4><!--]--></a><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-fe6d72fb><span class="vpi-chevron-right caret-icon" data-v-fe6d72fb></span></div></div><div class="items" data-v-fe6d72fb><!--[--><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/plugin/" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.plugin</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/plugin/load.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.plugin.load</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/plugin/manager.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.plugin.manager</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/plugin/model.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.plugin.model</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-2 collapsible collapsed is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" tabindex="0" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/plugins/index.html" data-v-fe6d72fb><!--[--><h4 class="text" data-v-fe6d72fb>liteyuki.plugins</h4><!--]--></a><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-fe6d72fb><span class="vpi-chevron-right caret-icon" data-v-fe6d72fb></span></div></div><div class="items" data-v-fe6d72fb><!--[--><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/plugins/" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.plugins</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/plugins/liteecho.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.plugins.liteecho</p><!--]--></a><!----></div><!----></div><section class="VPSidebarItem level-3 collapsible collapsed is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" tabindex="0" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/plugins/plugin_loader/index.html" data-v-fe6d72fb><!--[--><h5 class="text" data-v-fe6d72fb>liteyuki.plugins.plugin_loader</h5><!--]--></a><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-fe6d72fb><span class="vpi-chevron-right caret-icon" data-v-fe6d72fb></span></div></div><div class="items" data-v-fe6d72fb><!--[--><div class="VPSidebarItem level-4 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/plugins/plugin_loader/" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.plugins.plugin_loader</p><!--]--></a><!----></div><!----></div><!--]--></div></section><!--]--></div></section><div class="VPSidebarItem level-2 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/utils.html" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki.utils</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-fe6d72fb data-v-fe6d72fb><div class="item" data-v-fe6d72fb><div class="indicator" data-v-fe6d72fb></div><a class="VPLink link link" href="/en/dev/api/" data-v-fe6d72fb><!--[--><p class="text" data-v-fe6d72fb>liteyuki API</p><!--]--></a><!----></div><!----></div><!--]--></div></section><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-5047c77d data-v-f70c28c5><div class="VPDoc has-sidebar has-aside" data-v-f70c28c5 data-v-1c9751e9><!--[--><!--]--><div class="container" data-v-1c9751e9><div class="aside" data-v-1c9751e9><div class="aside-curtain" data-v-1c9751e9></div><div class="aside-container" data-v-1c9751e9><div class="aside-content" data-v-1c9751e9><div class="VPDocAside" data-v-1c9751e9 data-v-2fb953a0><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-2fb953a0 data-v-d2c84864><div class="content" data-v-d2c84864><div class="outline-marker" data-v-d2c84864></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-d2c84864>Page Content</div><ul class="VPDocOutlineItem root" data-v-d2c84864 data-v-1406b17f><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-2fb953a0></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-1c9751e9><div class="content-container" data-v-1c9751e9><!--[--><!--]--><main class="main" data-v-1c9751e9><div style="position:relative;" class="vp-doc _en_dev_guide" data-v-1c9751e9><div><h1 id="development-guide" tabindex="-1">Development Guide <a class="header-anchor" href="#development-guide" aria-label="Permalink to "Development Guide""></a></h1><h2 id="how-to-develop" tabindex="-1">How to Develop <a class="header-anchor" href="#how-to-develop" aria-label="Permalink to "How to Develop""></a></h2><p>Please read the <a href="./plugin.html">Plugin Development</a> and <a href="./api/">API Reference</a> documents if you are developing a plugin.</p><p>If you need to submit code to the Liteyuki repository, please read the following:</p><ol><li>First <a href="https://github.com/LiteyukiStudio/LiteyukiBot/fork" target="_blank" rel="noreferrer">fork</a> a copy of the Liteyuki repository to your personal/organization account.</li><li>Develop in your repository.</li><li>Create a new branch in your repository and submit your code to this branch.</li><li>Create a Pull Request in your repository to merge your branch into the <code>main</code> branch of the Liteyuki repository.</li></ol><ul><li>Participation in development assumes that you are already familiar with the basic usage of the Python language and the Liteyuki framework.</li><li>If you are developing documentation, please ensure that you are familiar with Markdown syntax and basic front-end knowledge.</li><li>Contact the repository maintainer in case of conflicts.</li></ul><h3 id="suggestions" tabindex="-1">Suggestions <a class="header-anchor" href="#suggestions" aria-label="Permalink to "Suggestions""></a></h3><ul><li>During development, you can use tools such as <code>mypy</code>, <code>flake8</code>, and <code>black</code> for code checking and formatting.</li><li>Enable developer mode by setting <code>dev_mode: true</code> in <code>config.yml</code> to see more debugging information in the console.</li></ul><h2 id="project-structure" tabindex="-1">Project Structure <a class="header-anchor" href="#project-structure" aria-label="Permalink to "Project Structure""></a></h2><ul><li><code>main.py</code>: Bot entry file</li><li><code>liteyuki</code>: Framework directory (liteyukibot)</li><li><code>src</code>: Bot application source code directory <ul><li><code>liteyuki_plugins</code>: Liteyuki plugin directory</li><li><code>nonebot_plugins</code>: Nonebot plugin directory</li><li><code>resources</code>: Built-in resource packs directory</li><li><code>utils</code>: Utility directory</li></ul></li><li><code>tests</code>: Unit test directory</li><li><code>docs</code>: Documentation directory <ul><li><code>en</code>: English documentation</li><li><code>zh</code>: Chinese documentation</li></ul></li><li><code>docker</code>: Docker related content directory</li></ul><p>The <code>liteyuki</code> framework is included in the <code>LiteyukiBot</code> application, so this project is both the <code>LiteyukiBot</code> application repository and the <code>liteyuki</code> framework repository.</p><p>The <code>src</code> directory is the application part, please develop business logic in this directory. <code>liteyuki_plugins</code> and <code>nonebot_plugins</code> directories are plugin directories, please develop plugins in these directories.</p><h2 id="standardization" tabindex="-1">Standardization <a class="header-anchor" href="#standardization" aria-label="Permalink to "Standardization""></a></h2><ul><li>Code should follow <a href="https://pep8.org/" target="_blank" rel="noreferrer"><code>PEP8</code></a> and <a href="https://google.github.io/styleguide/pyguide.html" target="_blank" rel="noreferrer"><code>Google Python Style Guide</code></a>.</li><li>In addition, code submitted to the Liteyuki repository should follow the following guidelines: <ul><li>Ensure that the code is runnable and harmless.</li><li>Ensure that the type hints in the code are correct.</li><li>Ensure that the comment style is <a href="https://google.github.io/styleguide/pyguide.html" target="_blank" rel="noreferrer"><code>Google Docstring</code></a> or <a href="https://github.com/LiteyukiStudio/litedoc?tab=readme-ov-file#liteyuki-docstring" target="_blank" rel="noreferrer"><code>Liteyuki Docstring</code></a>(recommended) to ensure that Litedoc can parse and generate documentation correctly.</li><li>Strings should be enclosed in double quotes <code>"</code> as much as possible, and single quotes <code>'</code> should be used when nesting strings.</li><li>If there is a part for ordinary users, ensure that the documentation is complete (each language has corresponding documentation).</li></ul></li><li>commit message should follow the following guidelines: <ul><li>You should commit the code after completing a feature or fixing a bug, and not mix the code of multiple features or bugs together.</li><li>We use gitmoji to mark the type of commit, such as <code>:sparkles:</code> for introducing new features, <code>:bug:</code> for fixing bugs, etc., please refer to <a href="https://gitmoji.dev/" target="_blank" rel="noreferrer">gitmoji</a> for details.</li><li>The format of the commit message is <code><emoji> [type:] <message></code>, such as <code>:sparkles: feat: add new field to event</code>, where the type field is the type of commit, not much is required, but please fill in as much as possible; the message field is a brief description, in summary, what you did.</li><li>There is no restriction on the language of the commit message, and bilingual use is possible if conditions permit.</li></ul></li><li>The documentation should follow <a href="https://www.markdownguide.org/" target="_blank" rel="noreferrer"><code>Markdown</code></a> syntax and support vitepress-related content: <ul><li>Revise the documentation for each language when editing.</li><li>Ensure that the links in the document are correct and do not lead to inaccessible links.</li><li>Ensure that the <strong>User Documentation</strong> is easy to understand and the <strong>Development Documentation</strong> is detailed.</li></ul></li></ul><h2 id="finally" tabindex="-1">Finally <a class="header-anchor" href="#finally" aria-label="Permalink to "Finally""></a></h2><ul><li>This project is a non-profit open-source project, and we welcome anyone to participate in development. Your contributions will make Liteyuki better.</li></ul><div class="contributor-bar" data-v-bc374713><h2 data-v-bc374713>Thanks the following contributors!</h2><a href="https://github.com/LiteyukiStudio/LiteyukiBot/graphs/contributors" data-v-bc374713><div class="contributor-list" data-v-bc374713><img src="https://contrib.rocks/image?repo=LiteyukiStudio/LiteyukiBot" alt="Contributors" data-v-bc374713></div></a></div></div></div></main><footer class="VPDocFooter" data-v-1c9751e9 data-v-655c432b><!--[--><!--]--><div class="edit-info" data-v-655c432b><div class="edit-link" data-v-655c432b><a class="VPLink link vp-external-link-icon no-icon edit-link-button" href="https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/docs/en/dev/guide.md" target="_blank" rel="noreferrer" data-v-655c432b><!--[--><span class="vpi-square-pen edit-link-icon" data-v-655c432b></span> Edit this page on GitHub<!--]--></a></div><div class="last-updated" data-v-655c432b><p class="VPLastUpdated" data-v-655c432b data-v-8a8c5efc>Last updated: <time datetime="2024-09-03T18:43:44.000Z" data-v-8a8c5efc></time></p></div></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-655c432b><span class="visually-hidden" id="doc-footer-aria-label" data-v-655c432b>Pager</span><div class="pager" data-v-655c432b><!----></div><div class="pager" data-v-655c432b><a class="VPLink link pager-link next" href="/en/dev/resource.html" data-v-655c432b><!--[--><span class="desc" data-v-655c432b>Next Page</span><span class="title" data-v-655c432b>Resource Pack</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-5047c77d data-v-1a52749f><div class="container" data-v-1a52749f><p class="message" data-v-1a52749f>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-1a52749f>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\":\"CygawBD3\",\"dev_api_bot_lifespan.md\":\"DBf_PC3G\",\"dev_api_comm_channel.md\":\"B_Q8RkLg\",\"dev_api_comm_event.md\":\"Dkw9vL8j\",\"dev_api_comm_index.md\":\"BubSUNVe\",\"dev_api_comm_rpc.md\":\"ZF5gW_b7\",\"dev_api_comm_socks_channel.md\":\"D0z-3box\",\"dev_api_comm_storage.md\":\"DlCQ-bAW\",\"dev_api_config.md\":\"BWciqFj4\",\"dev_api_core_index.md\":\"B0E7Phf1\",\"dev_api_core_manager.md\":\"B3hq0Rpu\",\"dev_api_dev_index.md\":\"Chgr0inF\",\"dev_api_dev_observer.md\":\"DXfnQgLO\",\"dev_api_dev_plugin.md\":\"Cops7KZu\",\"dev_api_exception.md\":\"Bo7F9S9r\",\"dev_api_index.md\":\"mhROT_CR\",\"dev_api_log.md\":\"B0RBm2Ui\",\"dev_api_message_event.md\":\"DyDwsc6d\",\"dev_api_message_index.md\":\"Ox32xQC5\",\"dev_api_message_matcher.md\":\"DVuQfqJD\",\"dev_api_message_on.md\":\"CApMkdr1\",\"dev_api_message_rule.md\":\"DtsqYM0_\",\"dev_api_message_session.md\":\"Dvgy6WBS\",\"dev_api_mkdoc.md\":\"BQNdAtbl\",\"dev_api_plugin_index.md\":\"DyFjlTCa\",\"dev_api_plugin_load.md\":\"CqVkk0P5\",\"dev_api_plugin_manager.md\":\"WWoouVFL\",\"dev_api_plugin_model.md\":\"BmVr2u82\",\"dev_api_plugins_index.md\":\"kWwCXP54\",\"dev_api_plugins_liteecho.md\":\"sryx6SuS\",\"dev_api_plugins_plugin_loader_index.md\":\"DVvGETw-\",\"dev_api_utils.md\":\"wryzX8vr\",\"dev_best_practices.md\":\"CJZXAqyp\",\"dev_comm.md\":\"cMJIV6AK\",\"dev_guide.md\":\"CO55__eP\",\"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\":\"C4r8HhEl\",\"en_dev_api_bot_lifespan.md\":\"B-nofctY\",\"en_dev_api_comm_channel.md\":\"VoA9irwY\",\"en_dev_api_comm_event.md\":\"Crpo-bJ4\",\"en_dev_api_comm_index.md\":\"BghEev94\",\"en_dev_api_comm_rpc.md\":\"DKVp72_P\",\"en_dev_api_comm_socks_channel.md\":\"B8_s4Hv_\",\"en_dev_api_comm_storage.md\":\"WX6gT40z\",\"en_dev_api_config.md\":\"CRNFMcJd\",\"en_dev_api_core_index.md\":\"NuGEgKq2\",\"en_dev_api_core_manager.md\":\"D7QE1GyX\",\"en_dev_api_dev_index.md\":\"UZwSl7RN\",\"en_dev_api_dev_observer.md\":\"DAh-d3XU\",\"en_dev_api_dev_plugin.md\":\"ByOqvpeD\",\"en_dev_api_exception.md\":\"HPP9FBE6\",\"en_dev_api_index.md\":\"Bem5oMXv\",\"en_dev_api_log.md\":\"t5U3-0Tg\",\"en_dev_api_message_event.md\":\"C6I96y2L\",\"en_dev_api_message_index.md\":\"CTleW7FS\",\"en_dev_api_message_matcher.md\":\"CtCEbUVJ\",\"en_dev_api_message_on.md\":\"DOPTBR4O\",\"en_dev_api_message_rule.md\":\"BBaFECzV\",\"en_dev_api_message_session.md\":\"BJvZrFxU\",\"en_dev_api_mkdoc.md\":\"B0odpxJC\",\"en_dev_api_plugin_index.md\":\"ibr3u-4e\",\"en_dev_api_plugin_load.md\":\"BqElTQmm\",\"en_dev_api_plugin_manager.md\":\"LGDmEnuh\",\"en_dev_api_plugin_model.md\":\"C8mVVzkp\",\"en_dev_api_plugins_index.md\":\"CBJItUz2\",\"en_dev_api_plugins_liteecho.md\":\"BkpA_Gke\",\"en_dev_api_plugins_plugin_loader_index.md\":\"cG7vDNwD\",\"en_dev_api_utils.md\":\"DKuaapxu\",\"en_dev_best_practices.md\":\"rGudE50n\",\"en_dev_comm.md\":\"bOf5Cc-F\",\"en_dev_guide.md\":\"C1967iq1\",\"en_dev_lyfunc.md\":\"DjX4Hm-0\",\"en_dev_plugin.md\":\"DoGEEBa3\",\"en_dev_resource.md\":\"DtkAy8nT\",\"en_index.md\":\"r_vtXGDB\",\"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\":\"C2Q5V-UK\",\"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\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":{\"light\":\"/liteyuki.svg\",\"dark\":\"/liteyuki-dark.svg\",\"alt\":\"LiteyukiBot Logo\"},\"sidebar\":{\"/dev/\":{\"base\":\"/dev/\",\"items\":[{\"text\":\"LITEYUKIBOT\",\"items\":[{\"text\":\"开发指南\",\"link\":\"guide\"},{\"text\":\"资源包开发\",\"link\":\"resource\"},{\"text\":\"轻雪函数\",\"link\":\"lyfunc\"},{\"text\":\"轻雪插件开发\",\"link\":\"plugin\"},{\"text\":\"进程通信\",\"link\":\"comm\"},{\"text\":\"最佳实践\",\"link\":\"best_practices\"},{\"text\":\"liteyuki API\",\"link\":\"api/index.md\",\"items\":[{\"text\":\"liteyuki.bot\",\"link\":\"api/bot/index.md\",\"items\":[{\"text\":\"liteyuki.bot\",\"link\":\"api/bot/\"},{\"text\":\"liteyuki.bot.lifespan\",\"link\":\"api/bot/lifespan\"}],\"collapsed\":true},{\"text\":\"liteyuki.comm\",\"link\":\"api/comm/index.md\",\"items\":[{\"text\":\"liteyuki.comm.channel\",\"link\":\"api/comm/channel\"},{\"text\":\"liteyuki.comm.event\",\"link\":\"api/comm/event\"},{\"text\":\"liteyuki.comm\",\"link\":\"api/comm/\"},{\"text\":\"liteyuki.comm.rpc\",\"link\":\"api/comm/rpc\"},{\"text\":\"liteyuki.comm.socks_channel\",\"link\":\"api/comm/socks_channel\"},{\"text\":\"liteyuki.comm.storage\",\"link\":\"api/comm/storage\"}],\"collapsed\":true},{\"text\":\"liteyuki.config\",\"link\":\"api/config\"},{\"text\":\"liteyuki.core\",\"link\":\"api/core/index.md\",\"items\":[{\"text\":\"liteyuki.core\",\"link\":\"api/core/\"},{\"text\":\"liteyuki.core.manager\",\"link\":\"api/core/manager\"}],\"collapsed\":true},{\"text\":\"liteyuki.dev\",\"link\":\"api/dev/index.md\",\"items\":[{\"text\":\"liteyuki.dev\",\"link\":\"api/dev/\"},{\"text\":\"liteyuki.dev.observer\",\"link\":\"api/dev/observer\"},{\"text\":\"liteyuki.dev.plugin\",\"link\":\"api/dev/plugin\"}],\"collapsed\":true},{\"text\":\"liteyuki.exception\",\"link\":\"api/exception\"},{\"text\":\"liteyuki.log\",\"link\":\"api/log\"},{\"text\":\"liteyuki.message\",\"link\":\"api/message/index.md\",\"items\":[{\"text\":\"liteyuki.message.event\",\"link\":\"api/message/event\"},{\"text\":\"liteyuki.message\",\"link\":\"api/message/\"},{\"text\":\"liteyuki.message.matcher\",\"link\":\"api/message/matcher\"},{\"text\":\"liteyuki.message.on\",\"link\":\"api/message/on\"},{\"text\":\"liteyuki.message.rule\",\"link\":\"api/message/rule\"},{\"text\":\"liteyuki.message.session\",\"link\":\"api/message/session\"}],\"collapsed\":true},{\"text\":\"liteyuki.mkdoc\",\"link\":\"api/mkdoc\"},{\"text\":\"liteyuki.plugin\",\"link\":\"api/plugin/index.md\",\"items\":[{\"text\":\"liteyuki.plugin\",\"link\":\"api/plugin/\"},{\"text\":\"liteyuki.plugin.load\",\"link\":\"api/plugin/load\"},{\"text\":\"liteyuki.plugin.manager\",\"link\":\"api/plugin/manager\"},{\"text\":\"liteyuki.plugin.model\",\"link\":\"api/plugin/model\"}],\"collapsed\":true},{\"text\":\"liteyuki.plugins\",\"link\":\"api/plugins/index.md\",\"items\":[{\"text\":\"liteyuki.plugins\",\"link\":\"api/plugins/\"},{\"text\":\"liteyuki.plugins.liteecho\",\"link\":\"api/plugins/liteecho\"},{\"text\":\"liteyuki.plugins.plugin_loader\",\"link\":\"api/plugins/plugin_loader/index.md\",\"items\":[{\"text\":\"liteyuki.plugins.plugin_loader\",\"link\":\"api/plugins/plugin_loader/\"}],\"collapsed\":true}],\"collapsed\":true},{\"text\":\"liteyuki.utils\",\"link\":\"api/utils\"},{\"text\":\"liteyuki API\",\"link\":\"api/\"}],\"collapsed\":true}]}]},\"/store/\":{\"base\":\"/store/\",\"items\":[{\"text\":\"LITEYUKIBOT\",\"items\":[{\"text\":\"资源商店\",\"link\":\"resource\"},{\"text\":\"插件商店\",\"link\":\"plugin\"}]}]},\"/usage/\":{\"base\":\"/usage/\",\"items\":[{\"text\":\"LITEYUKIBOT\",\"items\":[{\"text\":\"基础插件\",\"link\":\"basic\"},{\"text\":\"功能命令\",\"link\":\"extra\"},{\"text\":\"用户协议\",\"link\":\"agreement\"}]}]},\"/deploy/\":{\"base\":\"/deploy/\",\"items\":[{\"text\":\"LITEYUKIBOT\",\"items\":[{\"text\":\"安装\",\"link\":\"install\"},{\"text\":\"配置\",\"link\":\"config\"},{\"text\":\"答疑\",\"link\":\"fandq\"}]}]},\"/en/dev/\":{\"base\":\"/en/dev/\",\"items\":[{\"text\":\"LITEYUKIBOT\",\"items\":[{\"text\":\"Development Guide\",\"link\":\"guide\"},{\"text\":\"Resource Pack\",\"link\":\"resource\"},{\"text\":\"Liteyuki Function\",\"link\":\"lyfunc\"},{\"text\":\"Liteyuki Plugin\",\"link\":\"plugin\"},{\"text\":\"Process Communication\",\"link\":\"comm\"},{\"text\":\"Best Practices\",\"link\":\"best_practices\"},{\"text\":\"liteyuki API\",\"link\":\"api/index.md\",\"items\":[{\"text\":\"liteyuki.bot\",\"link\":\"api/bot/index.md\",\"items\":[{\"text\":\"liteyuki.bot\",\"link\":\"api/bot/\"},{\"text\":\"liteyuki.bot.lifespan\",\"link\":\"api/bot/lifespan\"}],\"collapsed\":true},{\"text\":\"liteyuki.comm\",\"link\":\"api/comm/index.md\",\"items\":[{\"text\":\"liteyuki.comm.channel\",\"link\":\"api/comm/channel\"},{\"text\":\"liteyuki.comm.event\",\"link\":\"api/comm/event\"},{\"text\":\"liteyuki.comm\",\"link\":\"api/comm/\"},{\"text\":\"liteyuki.comm.rpc\",\"link\":\"api/comm/rpc\"},{\"text\":\"liteyuki.comm.socks_channel\",\"link\":\"api/comm/socks_channel\"},{\"text\":\"liteyuki.comm.storage\",\"link\":\"api/comm/storage\"}],\"collapsed\":true},{\"text\":\"liteyuki.config\",\"link\":\"api/config\"},{\"text\":\"liteyuki.core\",\"link\":\"api/core/index.md\",\"items\":[{\"text\":\"liteyuki.core\",\"link\":\"api/core/\"},{\"text\":\"liteyuki.core.manager\",\"link\":\"api/core/manager\"}],\"collapsed\":true},{\"text\":\"liteyuki.dev\",\"link\":\"api/dev/index.md\",\"items\":[{\"text\":\"liteyuki.dev\",\"link\":\"api/dev/\"},{\"text\":\"liteyuki.dev.observer\",\"link\":\"api/dev/observer\"},{\"text\":\"liteyuki.dev.plugin\",\"link\":\"api/dev/plugin\"}],\"collapsed\":true},{\"text\":\"liteyuki.exception\",\"link\":\"api/exception\"},{\"text\":\"liteyuki.log\",\"link\":\"api/log\"},{\"text\":\"liteyuki.message\",\"link\":\"api/message/index.md\",\"items\":[{\"text\":\"liteyuki.message.event\",\"link\":\"api/message/event\"},{\"text\":\"liteyuki.message\",\"link\":\"api/message/\"},{\"text\":\"liteyuki.message.matcher\",\"link\":\"api/message/matcher\"},{\"text\":\"liteyuki.message.on\",\"link\":\"api/message/on\"},{\"text\":\"liteyuki.message.rule\",\"link\":\"api/message/rule\"},{\"text\":\"liteyuki.message.session\",\"link\":\"api/message/session\"}],\"collapsed\":true},{\"text\":\"liteyuki.mkdoc\",\"link\":\"api/mkdoc\"},{\"text\":\"liteyuki.plugin\",\"link\":\"api/plugin/index.md\",\"items\":[{\"text\":\"liteyuki.plugin\",\"link\":\"api/plugin/\"},{\"text\":\"liteyuki.plugin.load\",\"link\":\"api/plugin/load\"},{\"text\":\"liteyuki.plugin.manager\",\"link\":\"api/plugin/manager\"},{\"text\":\"liteyuki.plugin.model\",\"link\":\"api/plugin/model\"}],\"collapsed\":true},{\"text\":\"liteyuki.plugins\",\"link\":\"api/plugins/index.md\",\"items\":[{\"text\":\"liteyuki.plugins\",\"link\":\"api/plugins/\"},{\"text\":\"liteyuki.plugins.liteecho\",\"link\":\"api/plugins/liteecho\"},{\"text\":\"liteyuki.plugins.plugin_loader\",\"link\":\"api/plugins/plugin_loader/index.md\",\"items\":[{\"text\":\"liteyuki.plugins.plugin_loader\",\"link\":\"api/plugins/plugin_loader/\"}],\"collapsed\":true}],\"collapsed\":true},{\"text\":\"liteyuki.utils\",\"link\":\"api/utils\"},{\"text\":\"liteyuki API\",\"link\":\"api/\"}],\"collapsed\":true}]}]},\"/en/store/\":{\"base\":\"/en/store/\",\"items\":[{\"text\":\"LITEYUKIBOT\",\"items\":[{\"text\":\"Resource Store\",\"link\":\"resource\"},{\"text\":\"Plugin Store\",\"link\":\"plugin\"}]}]},\"/en/usage/\":{\"base\":\"/en/usage/\",\"items\":[{\"text\":\"LITEYUKIBOT\",\"items\":[{\"text\":\"基础插件\",\"link\":\"basic\"},{\"text\":\"功能命令\",\"link\":\"extra\"},{\"text\":\"用户协议\",\"link\":\"agreement\"}]}]},\"/en/deploy/\":{\"base\":\"/en/deploy/\",\"items\":[{\"text\":\"LITEYUKIBOT\",\"items\":[{\"text\":\"Install\",\"link\":\"install\"},{\"text\":\"Configurations\",\"link\":\"config\"},{\"text\":\"FAQ\",\"link\":\"fandq\"}]}]}},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/LiteyukiStudio/LiteyukiBot\"},{\"icon\":{\"svg\":\"<svg t=\\\"1725391346807\\\" class=\\\"icon\\\" viewBox=\\\"0 0 1025 1024\\\" version=\\\"1.1\\\" xmlns=\\\"http://www.w3.org/2000/svg\\\" p-id=\\\"5067\\\" width=\\\"256\\\" height=\\\"256\\\"><path d=\\\"M1004.692673 466.396616l-447.094409-447.073929c-25.743103-25.763582-67.501405-25.763582-93.264987 0l-103.873521 103.873521 78.171378 78.171378c12.533635-6.00058 26.562294-9.359266 41.389666-9.359266 53.02219 0 96.00928 42.98709 96.00928 96.00928 0 14.827372-3.358686 28.856031-9.359266 41.389666l127.97824 127.97824c12.533635-6.00058 26.562294-9.359266 41.389666-9.359266 53.02219 0 96.00928 42.98709 96.00928 96.00928s-42.98709 96.00928-96.00928 96.00928-96.00928-42.98709-96.00928-96.00928c0-14.827372 3.358686-28.856031 9.359266-41.389666l-127.97824-127.97824c-3.051489 1.454065-6.184898 2.744293-9.379746 3.870681l0 266.97461c37.273227 13.188988 63.99936 48.721433 63.99936 90.520695 0 53.02219-42.98709 96.00928-96.00928 96.00928s-96.00928-42.98709-96.00928-96.00928c0-41.799262 26.726133-77.331707 63.99936-90.520695l0-266.97461c-37.273227-13.188988-63.99936-48.721433-63.99936-90.520695 0-14.827372 3.358686-28.856031 9.359266-41.389666l-78.171378-78.171378-295.892081 295.871601c-25.743103 25.784062-25.743103 67.542365 0 93.285467l447.114889 447.073929c25.743103 25.743103 67.480925 25.743103 93.264987 0l445.00547-445.00547c25.763582-25.763582 25.763582-67.542365 0-93.285467z\\\" fill=\\\"#a2d8f4\\\" p-id=\\\"5068\\\"></path></svg>\"},\"link\":\"https://git.liteyuki.icu/LiteyukiStudio/LiteyukiBot\"}],\"search\":{\"provider\":\"local\",\"options\":{\"locales\":{\"root\":{\"translations\":{\"button\":{\"buttonText\":\"搜索文档\",\"buttonAriaLabel\":\"打开搜索框\"},\"modal\":{\"noResultsText\":\"没有找到搜索结果\",\"resetButtonTitle\":\"清除查询条件\",\"footer\":{\"selectText\":\"选择\",\"navigateText\":\"切换\"}}}},\"en\":{\"translations\":{\"button\":{\"buttonText\":\"Search\",\"buttonAriaLabel\":\"Search\"},\"modal\":{\"noResultsText\":\"No results found\",\"resetButtonTitle\":\"Reset search query\",\"footer\":{\"selectText\":\"Select\",\"navigateText\":\"Navigate\"}}}}}}}},\"locales\":{\"root\":{\"label\":\"简体中文\",\"lang\":\"zh-Hans\",\"title\":\"轻雪机器人\",\"description\":\"一个综合性的机器人应用及管理框架\",\"themeConfig\":{\"nav\":[{\"text\":\"部署\",\"link\":\"/deploy/install\"},{\"text\":\"使用\",\"link\":\"/usage/basic\"},{\"text\":\"扩展\",\"link\":\"/store/resource\"},{\"text\":\"开发\",\"link\":\"/dev/guide\"}],\"docFooter\":{\"prev\":\"上一页\",\"next\":\"下一页\"},\"editLink\":{\"pattern\":\"_vp-fn_({ filePath }) => {\\n const regex = /^[^\\\\/]+\\\\/dev\\\\/api/;\\n console.log(filePath);\\n if (regex.test(filePath)) {\\n filePath = filePath.replace(regex, \\\"\\\").replace(\\\"index.md\\\", \\\"__init__.py\\\").replace(\\\".md\\\", \\\".py\\\");\\n if (filePath.split(\\\"/\\\").pop().split(\\\".\\\")[0] === filePath.split(\\\"/\\\").slice(-2, -1)[0]) {\\n filePath = filePath.split(\\\"/\\\").slice(0, -1).join(\\\"/\\\") + \\\"/__init__.py\\\";\\n }\\n return `https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/liteyuki${filePath}`;\\n } else {\\n return `https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/docs/${filePath}`;\\n }\\n }\",\"text\":\"在 GitHub 上编辑此页\"},\"footer\":{\"message\":\"文档由 <a href=\\\"https://vitepress.dev/\\\">VitePress</a> 构建 | API引用由 <a href=\\\"https://github.com/LiteyukiStudio/litedoc\\\">litedoc</a> 生成\",\"copyright\":\"Copyright (C) 2020-2024 LiteyukiStudio. All Rights Reserved\"},\"outline\":{\"label\":\"页面内容\",\"level\":[2,6]},\"langMenuLabel\":\"语言\",\"returnToTopLabel\":\"返回顶部\",\"sidebarMenuLabel\":\"菜单\",\"darkModeSwitchLabel\":\"主题\",\"lightModeSwitchTitle\":\"轻色模式\",\"darkModeSwitchTitle\":\"深色模式\"}},\"en\":{\"label\":\"English\",\"lang\":\"en-US\",\"title\":\"LiteyukiBot\",\"description\":\"A high-performance, easy-to-use chatbot framework and application\",\"themeConfig\":{\"nav\":[{\"text\":\"Deploy\",\"link\":\"/en/deploy/install\"},{\"text\":\"Usage\",\"link\":\"/en/usage/basic\"},{\"text\":\"Extension\",\"link\":\"/en/store/resource\"},{\"text\":\"Develop\",\"link\":\"/en/dev/guide\"}],\"docFooter\":{\"prev\":\"Prev Page\",\"next\":\"Next Page\"},\"editLink\":{\"pattern\":\"_vp-fn_({ filePath }) => {\\n const regex = /^[^\\\\/]+\\\\/dev\\\\/api/;\\n console.log(filePath);\\n if (regex.test(filePath)) {\\n filePath = filePath.replace(regex, \\\"\\\").replace(\\\"index.md\\\", \\\"__init__.py\\\").replace(\\\".md\\\", \\\".py\\\");\\n if (filePath.split(\\\"/\\\").pop().split(\\\".\\\")[0] === filePath.split(\\\"/\\\").slice(-2, -1)[0]) {\\n filePath = filePath.split(\\\"/\\\").slice(0, -1).join(\\\"/\\\") + \\\"/__init__.py\\\";\\n }\\n return `https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/liteyuki${filePath}`;\\n } else {\\n return `https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/docs/${filePath}`;\\n }\\n }\",\"text\":\"Edit this page on GitHub\"},\"footer\":{\"message\":\"Documentation built with <a href=\\\"https://vitepress.dev/\\\">VitePress</a> | API references generated by <a href=\\\"https://github.com/LiteyukiStudio/litedoc\\\">litedoc</a>\",\"copyright\":\"Copyright (C) 2020-2024 LiteyukiStudio. All Rights Reserved\"},\"outline\":{\"label\":\"Page Content\",\"level\":[2,6]},\"langMenuLabel\":\"Language\",\"returnToTopLabel\":\"Back to top\",\"sidebarMenuLabel\":\"Menu\",\"darkModeSwitchLabel\":\"Theme\",\"lightModeSwitchTitle\":\"Light Mode\",\"darkModeSwitchTitle\":\"Dark Mode\"}}},\"scrollOffset\":134,\"cleanUrls\":false}"));</script>
|
||
|
||
</body>
|
||
</html> |