liteldev / liteloaderbds-documentation

LiteLoaderBDSv2 documentation

LiteLoaderBDS Documentation

This is the documentation for LiteLoaderBDS.

If you would like to preview the latest official version, please visit LiteLoaderBDS Documentation or LiteLoaderBDS文档

Contribution

If you would like write some pages, please create or modify them in both /en/ and /zh-Hans/.

If you are contributing to the C++-related documentation, please go to the repository for C++ documentation.

You should modify the texts in different languages AT THE SAME TIME. Please firstly fork this repository and then create a pull request!

If you are opening a pull request, please make sure that you are merging into branch develop rather than main!

liteloaderbds-documentation's Issues

如果有国内的镜像网站就好了！

目前lles开发的时候很难使用浏览器访问docs直接访问到文档，开了加速器进的很慢，些许时候会出现等半天也进不去的情况。迫切想要一个镜像网站了。

• Cent Chrome 版本 4.3.9.248（正式版本） （32 位） (Portable) (Chromium 86.0.4240.198)
• 移动网络
• Watt Toolkit（原Steam++）

pl.gameMode玩家的游戏模式（0 - 3）LL文档有误？

您的建议是否与现存的某个问题相关?请描述问题?

基岩版中只有0生存，1创造，2冒险，好像没有3吧，观察者也必须是输入英文的全称才可以：/gamemode spectator

您认为还缺少什么?如何解决您的问题?

No response

Add the detail of how to use the Json to set `CustomForm`

Is your feature request related to a problem? Please describe.
In here you said “it is difficult to use” but never give the information of how to use it.

Describe the solution you'd like
Give the information of how to write the parameter json in API: player.sendCustomForm(json: string, callback: (player: Player, data: Array<any> | null) => void ): number | null;

文档系统完善工作

入门文档

• 示例插件代码及简单分析
• 加栏目：插件的发布，写插件之前的准备
• 约定介绍：回调函数等专业名词
• LL配置文件介绍

LiteLoader C++文档

• doxygen工具链完善
• MCAPI注释保留
• i18n

LLSE文档

• 考虑根据补全库数据自动生成文档
• LLSE语言特殊功能介绍（baselib, CJS）
• LLSE文档补充API多语言使用示例

维护文档

• 完成维护文档
• i18n维护和适配方法
• LLMoney适配文档
• 模块功能介绍

其他文档补充需求

• 捐赠者名单

（非加载器问题）文档网站出现无法滑动的问题

异常模块

LiteLoader (本体)

操作系统

Windows Server 2022

LiteLoader 版本

无

BDS 版本

无

发生了什么?

已测过：手机、电脑。刚加载的时候能滑动，加载完就访问不了

复现此问题的步骤

1.打开https://docs.litebds.com/zh-Hans/#/README滑动鼠标滚轮

有关的日志/输出

无

插件列表

无

Rearrange the pages to meet i18n

The page structure of different languages ought to be identical to make it easy to implement i18n features.

Bug: 网站挂了

Describe the bug
由于无法正常访问jsdeliver获取页面资源而无法正常加载

To Reproduce
在一部分国内网络环境下访问文档站

Screenshots

Desktop :

• OS Win10
• Browser Microsoft Edge
• Version 114.0.1823.51 (正式版本) (64 位)

如果有可能 想想办法 不方便就算了

Blueprint/RFC: Add git commit message convention.

Linked blueprint or RFC

refer: https://www.conventionalcommits.org/zh-hans/v1.0.0/

文档挂了

https://docs.litebds.com/zh-Hans/#/LLSEPluginDevelopment/

侧边栏失效了，切换不了页面

中文搜索问题 pl.setGameMode 描述错误

Describe the bug
A clear and concise description of what the bug is.
中文文档
 脚本插件开发-玩家对象的pl. SetGameMode mode: Integer参数中文描述错误
2应该为冒险模式 错误的描述成极限模式而英文文档没有这个描述错误

中文文档，搜索功能搜索不到pl.SetGameMode 这类新加的接口 而英文文档可以（尝试过清除缓存

Screenshots

Smartphone (please complete the following information):

• Device: [iPhone11]
• OS: [iOS15.7.1]
• Browser [edge, safari]

Additional context
Add any other context about the problem here.

docsify 功能增强

如果有空可以考虑一下用actions实现服务端渲染，以及PWA（和离线应用）
https://angry-swanson-b4e47b.netlify.app/zh-cn/ssr

文档协议问题

像文档这类不算“源代码”的应该用CC-BY-SA这类协议更合适吧？
参考：https://creativecommons.org/licenses/

There should be more information in the documentation

Is your feature request related to a problem? Please describe.

These objects in the image exist in the scripting engine, and they are also important for scripting plugins in certain situations, but they are not mentioned in the documentation.

Describe the solution you'd like
Add some introduction to these objects

Describe alternatives you've considered
I am considering adding them to https://github.com/LiteLScript-Dev/HelperLib