chore: add miscellaneous stuff

(cherry picked from commit f7f87d9)

chore: add notes in readme

(cherry picked from commit 114b1f2)

.github/FUNDING.yml

@@ -0,0 +1,4 @@
+github: LiteLDev
+open_collective: liteloaderbds
+custom:
+  - https://afdian.net/@liteldev

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,45 @@
+name: Bug Report
+description: Create a report to help us improve
+title: "[Bug]: "
+labels: ["bug"]
+body:
+  - type: textarea
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: To Reproduce
+      description: Steps to reproduce the behavior.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Screenshots
+      description: If applicable, add screenshots to help explain your problem.
+
+  - type: input
+    attributes:
+      label: Platform
+      description: The platform you are using. (e.g. Windows 10, macOS 10.15, Ubuntu 20.04)
+
+  - type: input
+    attributes:
+      label: Version
+      description: The version of the application you are using. (e.g. 1.0.0)
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,28 @@
+name: Feature request
+description: Suggest an idea for this project
+title: "[Feature]: "
+labels: ["enhancement"]
+body:
+  - type: textarea
+    attributes:
+      label: Is your feature request related to a problem? Please describe.
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+## What does this PR do?
+
+
+
+## Which issues does this PR resolve?
+
+
+
+## Checklist before merging
+
+Thank you for your contribution to the repository. 
+Before submitting this PR, please make sure:
+
+- [ ] Your code builds clean without any errors or warnings
+- [ ] Your code follows the code style of this repository (see the wiki)
+- [ ] You have tested all functions
+- [ ] You have not used code without license
+- [ ] You have added statement for third-party code

.gitignore

@@ -1,4 +1,4 @@
-# Visual Studio related
+# Visual Studio related
 /.vs
 /CMakeSettings.json
 /out
@@ -18,3 +18,6 @@
 /build
 /CMakeLists.txt
 /vsxmake2022
+
+# MkDocs
+/site/

README.md

@@ -0,0 +1,94 @@
+# LiteLoaderBDS
+
+![English](https://img.shields.io/badge/English-inactive?style=for-the-badge) [![中文](https://img.shields.io/badge/简体中文-informational?style=for-the-badge)](README.zh.md)
+
+> [!IMPORTANT]
+> LiteLoaderBDS 3 is under development! For production use, go to <https://github.com/LiteLDev/LiteLoaderBDSv2>.
+
+An epoch-making cross-language plugin loader for Minecraft Bedrock Dedicated Server (BDS)
+
+LiteLoaderBDS is an unofficial plugin loader that offers essential API support for the Bedrock Dedicated Server (BDS). It boasts an extensive API, a plethora of utility interfaces, a robust event system, and comprehensive basic interface support.
+
+LiteLoader presents an expansive API, a powerful event system, and an abundance of encapsulated development infrastructure interfaces, laying a sturdy groundwork for enhancing the Bedrock Edition BDS with additional gameplay features and functionalities. Through plugins, extending BDS functionality becomes effortless, with a user-friendly development process and adaptable approach.
+
+Developers can effortlessly write plugins in languages such as C++, JavaScript, Lua, Python, C#, and others. This seamless integration enables them to effortlessly expand and personalize BDS functionality, facilitating an intuitive learning experience and unparalleled flexibility.
+
+For more information, please refer to [the documentation](https://docs.litebds.com).
+
+## Security
+
+LiteLoaderBDS (hereinafter referred to as "this software") is developed and 
+provided by LiteLDev (hereinafter referred to as "the developer"). This software is designed 
+to help users manage and install various software packages, but is not responsible for any 
+content, quality, functionality, security or legality of any software package. Users should 
+use this software at their own discretion and assume all related risks.
+
+The developer does not guarantee the stability, reliability, accuracy or completeness of this 
+software. The developer is not liable for any defects, errors, viruses or other harmful components 
+that may exist in this software. The developer is not liable for any direct or indirect damages 
+(including but not limited to data loss, device damage, profit loss etc.) caused by the use of 
+this software.
+
+The developer reserves the right to modify, update or terminate this software and its related 
+services at any time without prior notice to users. Users should back up important data and check 
+regularly for updates of this software.
+
+Users should comply with relevant laws and regulations when using this software, respect the 
+intellectual property rights and privacy rights of others, and not use this software for any 
+illegal or infringing activities. If users violate the above provisions and cause any damage 
+to any third party or are claimed by any third party, the developer does not bear any 
+responsibility.
+
+If you have any questions or comments about this disclaimer, please contact the developer.
+
+## Install
+
+This project uses [Lip](https://github.com/LipPkg/Lip). Go check them out if you don't have them locally installed.
+
+First, create a new directory for your Minecraft server and enter it:
+
+```sh
+$ mkdir myserver
+$ cd myserver
+```
+
+Then, install LiteLoaderBDS using Lip:
+
+```sh
+$ lip install github.com/tooth-hub/liteloaderbds
+```
+
+For more information, please refer to [the documentation](https://docs.litebds.com).
+
+### Updating
+
+Considering data security, we do not provide an update method. If you would like to update LiteLoaderBDS, please install the new version somewhere else and copy the files shown below to your server directory:
+
+- `worlds/`
+- `server.properties`
+
+## Usage
+
+To start the server, simply run `bedrock_server.exe`: 
+
+```sh
+$ ./bedrock_server.exe
+```
+
+For more information, please refer to [the documentation](https://docs.litebds.com).
+
+## Contributing
+
+Feel free to dive in! [Open an issue](https://github.com/LiteLDev/LiteLoaderBDS/issues/new/choose) or submit PRs.
+
+LiteLoaderBDS follows the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/) Code of Conduct.
+
+## Contributors
+
+This project exists thanks to all the people who contribute.
+
+![Contributors](https://contrib.rocks/image?repo=LiteLDev/LiteLoaderBDS)
+
+## License
+
+[LGPL-3.0-only](LICENSE) © 2021-2023 LiteLDev

README.zh.md

@@ -0,0 +1,72 @@
+# LiteLoaderBDS
+
+[![English](https://img.shields.io/badge/English-informational?style=for-the-badge)](README.md) ![中文](https://img.shields.io/badge/简体中文-inactive?style=for-the-badge)
+
+> [!IMPORTANT]
+> LiteLoaderBDS 3尚在开发！对于生产环境，请访问<https://github.com/LiteLDev/LiteLoaderBDSv2>。
+
+一个开创性的跨语言插件加载器，适用于Minecraft基岩版专用服务器（BDS）
+
+LiteLoaderBDS是一个非官方的插件加载器，为基岩版专用服务器（BDS）提供必要的API支持。它拥有广泛的API、大量的实用接口、强大的事件系统和全面的基本接口支持。
+
+LiteLoader提供了一个广阔的API、强大的事件系统和丰富的封装式开发基础接口，为增强基岩版BDS的游戏功能和功能提供了坚实的基础。通过插件，扩展BDS的功能变得轻松，具有用户友好的开发过程和灵活的方法。
+
+开发者可以轻松地使用C++、JavaScript、Lua、Python、C#等语言编写插件。这种无缝集成使他们能够轻松扩展和个性化BDS的功能，促进直观的学习体验和无与伦比的灵活性。
+
+更多信息，请参考[文档](https://docs.litebds.com)。
+
+## 安全性
+
+LiteLoaderBDS（以下简称“本软件”）由LiteLDev（以下简称“开发者”）开发和提供。本软件旨在帮助用户管理和安装各种软件包，但不对任何软件包的内容、质量、功能、安全性或合法性负责。用户应自行决定使用本软件，并承担相关风险。
+
+开发者不保证本软件的稳定性、可靠性、准确性或完整性。开发者不对本软件中可能存在的任何缺陷、错误、病毒或其他有害组件负责。开发者不对因使用本软件而导致的任何直接或间接损害（包括但不限于数据丢失、设备损坏、利润损失等）承担责任。
+
+开发者保留随时修改、更新或终止本软件及其相关服务的权利，无需事先通知用户。用户应备份重要数据并定期检查本软件的更新。
+
+用户在使用本软件时应遵守相关法律法规，尊重他人的知识产权和隐私权，不得将本软件用于任何非法或侵权活动。如果用户违反上述规定并对任何第三方造成任何损害或被任何第三方提出索赔，开发者不承担任何责任。
+
+如果您对本免责声明有任何疑问或意见，请与开发者联系。
+
+## 安装
+
+此项目使用[Lip](https://github.com/LipPkg/Lip)。如果您尚未在本地安装，请查看它们。
+
+首先，创建一个新的目录用于您的Minecraft服务器并进入该目录：
+
+```sh
+$ mkdir myserver
+$ cd myserver
+```
+
+然后，使用Lip安装LiteLoaderBDS：
+
+```sh
+$ lip install github.com/tooth-hub/liteloaderbds
+```
+
+更多信息，请参考[文档](https://docs.litebds.com)。
+
+### 更新
+
+考虑到数据安全性，我们不提供更新方法。如果您想要更新LiteLoaderBDS，请在其他地方安装新版本，并将下面显示的文件复制到服务器目录中：
+
+- `worlds/`
+- `server.properties`
+
+## 使用方法
+
+要启动服务器，只需运行`bedrock_server.exe`：
+
+```sh
+$ ./bedrock_server.exe
+```
+
+更多信息，请参考[文档](https://docs.litebds.com)。
+
+## 贡献
+
+欢迎参与！[提交问题](https://github.com/LiteLDev/LiteLoaderBDS/issues/new/choose)或提交PR贡献者
+
+感谢所有为该项目作出贡献的人。
+
+![Contributors]()许可证[LGPL-3.0-only](LICENSE) © 2021-2023 LiteLDev

docs/faq.md

@@ -0,0 +1 @@
+# Frequent Asked Questions

docs/faq.zh.md

@@ -0,0 +1 @@
+# 常见问题

docs/index.md

@@ -0,0 +1,3 @@
+# LiteLoaderBDS
+
+TODO: Write a project description

docs/index.zh.md

@@ -0,0 +1,3 @@
+# LiteLoaderBDS
+
+TODO: Write a project description

docs/install_windows.md

@@ -0,0 +1,69 @@
+# Install on Windows
+
+## Prerequisites
+
+To install LiteLoaderBDS 3, you need one of the following Windows versions:
+
+- Windows 10
+- Windows 11
+- Windows Server 2019
+- Windows Server 2022
+
+To run Bedrock Dedicated Server for Minecraft, you need to install the following software:
+
+- [Visual C++ Redistributable for Visual Studio 2015, 2017, 2019, and 2022](https://aka.ms/vs/17/release/vc_redist.x64.exe)
+
+Since LiteLoaderBDS 3 is not compatible with the previous LiteLoaderBDS 2, you need to uninstall LiteLoaderBDS 2 before installing LiteLoaderBDS 3.
+
+## Installation Methods
+
+You can install LiteLoaderBDS 3 in different ways, depending on your needs:
+
+- You can [install via Lip](#install-via-lip), for ease of installation and upgrade tasks. This is the recommended approach.
+
+- You can [install via LipUI](#install-via-lipui), which is a graphical user interface for Lip. This is useful if you are not familiar with the command line.
+
+- You can download the modules and [install them manually](#install-manually) and manage upgrades completely manually. This is useful in situations such as installing LiteLoaderBDS 3 on air-gapped systems with no access to the internet.
+
+### Install via Lip
+
+If you have not installed Lip, you can install it following the instructions in [Lip installation guide](https://docs.lippkg.com/installation.html).
+
+After installing Lip, you can install LiteLoaderBDS 3 by running the following command:
+
+```powershell
+lip install github.com/tooth-hub/liteloaderbds
+```
+
+To install a specific version of LiteLoaderBDS 3, you can run the following command:
+
+```powershell
+lip install github.com/tooth-hub/[email protected]
+```
+
+During the installation, you might be asked to confirm some prompts. You can press `y` to confirm the prompts. To skip the prompts, you can add the `-y` option to the command.
+
+```powershell
+lip install -y github.com/tooth-hub/liteloaderbds
+```
+
+You have now successfully installed LiteLoaderBDS 3.
+
+To upgrade LiteLoaderBDS 3, you can run the following command:
+
+```powershell
+lip install --upgrade github.com/tooth-hub/liteloaderbds
+```
+
+!!! danger
+    Upgrading LiteLoaderBDS 3 may result in data loss. Please make sure you have a backup of your data before upgrading.
+
+### Install via LipUI
+
+Before installation, you should obtain a copy of LipUI. See the guides [here](https://docs.lippkg.com/lipui_quickstart.html).
+
+Then you can start LipUI, select a proper workspace, and install LiteLoaderBDS 3 from Tooth Index.
+
+### Install Manually
+
+You can download the modules from there corresponding GitHub releases pages and install them following their own installation guides.

docs/install_windows.zh.md

@@ -0,0 +1 @@
+# 安装

docs/usage.md

@@ -0,0 +1 @@
+# Usage

docs/usage.zh.md

@@ -0,0 +1 @@
+# 使用方法