优化项目结构,优化构建脚本,优化README.MD
All checks were successful
continuous-integration/drone/push Build is passing
All checks were successful
continuous-integration/drone/push Build is passing
This commit is contained in:
56
README.MD
56
README.MD
@ -2,26 +2,31 @@
|
||||
|
||||
老色批世界树 —— 一个高性能麻将、奥苏力不-印寨克托接口的实现。使用fastify来把处理速度加速到老色批的速度(
|
||||
|
||||
具体有多快呢?登录处理从数据包发出到接收到服务端响应仅需要 __***6ms***__(根据机器不同可能会有浮动,以实际情况为准)!
|
||||
|
||||
[](https://996.icu)
|
||||
[](https://github.com/996icu/996.ICU/blob/master/LICENSE)
|
||||
[](https://ci.186526.xyz/Lama3L9R/lsp-yggdrasil)
|
||||
|
||||
---
|
||||
|
||||
TODO:
|
||||
## 开发计划:
|
||||
|
||||
- [ ] Basic API
|
||||
#### Beta 1.0:
|
||||
- [ ] 基础世界树 API
|
||||
+ [x] /authserver
|
||||
+ [ ] /sessionserver
|
||||
+ [ ] /api
|
||||
- [ ] Advanced API
|
||||
- [ ] Skin uploading & security checks for texture
|
||||
+ [ ] Texture RSAsigning
|
||||
- [ ] S3 Storage backend
|
||||
- [ ] Server status
|
||||
- [ ] Authlib meta
|
||||
- [ ] Telegram Bot
|
||||
- [ ] Unit test
|
||||
- [ ] 进阶 API
|
||||
- [ ] 皮肤上传和安全检查
|
||||
+ [ ] 皮肤数据的RSA签名
|
||||
- [ ] 兼容S3后端
|
||||
- [ ] 服务器状态接口
|
||||
- [ ] authlib-injector 元数据接口
|
||||
|
||||
#### Release 1.0
|
||||
- [ ] TGbot前端
|
||||
- [ ] 单元测试
|
||||
+ [ ] API
|
||||
- [ ] /authserver
|
||||
- [ ] /sessionserver
|
||||
@ -29,16 +34,29 @@ TODO:
|
||||
- [ ] Advanced API
|
||||
+ [ ] Utils
|
||||
|
||||
## WIP
|
||||
#### 未来的版本:
|
||||
|
||||
推荐 Node.js 版本:`16.15.0 LTS (Latest LTS)`
|
||||
- [ ] 完整 web 管理
|
||||
|
||||
*因为魔法,在 Node14 也能跑*
|
||||
---
|
||||
|
||||
构建方法
|
||||
```
|
||||
$ yarn install && node ./build.js
|
||||
```
|
||||
## 使用方法
|
||||
|
||||
**记得手动复制`config.js`!放在和主程序一个目录就行,构建完了看`./production`**
|
||||
**因为我设置了项目为`module`,构建出来的是`cjs`因此不能直接在项目目录下跑,扔到别的地方跑**
|
||||
1. 安装Node.js、yarn、并下载源代码
|
||||
+ 推荐 Node.js 版本:`16.15.0 LTS (Latest LTS)`,最低兼容 `14 LTS`
|
||||
+ 使用 `$ npm install -g yarn` 来安装yarn
|
||||
+ 使用 `$ git clone https://git.186526.xyz/Lama3L9R/lsp-yggdrasil.git` 下载源代码
|
||||
2. 使用 `$ yarn install` 安装依赖库
|
||||
3. 配置 `src/config.js`
|
||||
4. 使用 `$ node build.js` 创建运行时构建
|
||||
5. 使用 `$ node path/to/lsp-yggdrasil.full.cjs` 起飞
|
||||
|
||||
## 常见问题
|
||||
|
||||
- Q:支持 `https` 嘛?
|
||||
- A:不支持,请使用反代来使用`https`,或者您也可以修改 `index.js` 中初始化代码。
|
||||
|
||||
## 内置的 yarn 指令
|
||||
|
||||
+ `dev` —— 启动开发环境服务器
|
||||
+ `test` —— 单元测试
|
Reference in New Issue
Block a user