Skip to content

Commit f5f0bed

Browse files
committed
docs: add client installation guide
1 parent 93270e2 commit f5f0bed

File tree

4 files changed

+57
-44
lines changed

4 files changed

+57
-44
lines changed

README.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,7 @@ A plugin engine for running LLSE plugins on LeviLamina
55

66
## Installation
77

8-
### Attention
9-
10-
Before installing the Python engine, you need to
11-
install [Python 3.12.10](https://www.python.org/downloads/release/python-31210/) first.
12-
To install a specific engine, you can use the following command:
13-
```shell
14-
lip install github.com/LiteLDev/LegacyScriptEngine#lua
15-
lip install github.com/LiteLDev/LegacyScriptEngine#quickjs
16-
lip install github.com/LiteLDev/LegacyScriptEngine#nodejs
17-
lip install github.com/LiteLDev/LegacyScriptEngine#python
18-
```
19-
For version older than 0.10.0, you can use the following command:
20-
```shell
21-
lip install git.levimc.org/LiteLDev/legacy-script-engine-lua@version
22-
lip install git.levimc.org/LiteLDev/legacy-script-engine-quickjs@version
23-
lip install git.levimc.org/LiteLDev/legacy-script-engine-nodejs@version
24-
lip install git.levimc.org/LiteLDev/legacy-script-engine-python@version
25-
```
26-
Version numbers can be found in [releases](https://github.com/LiteLDev/LegacyScriptEngine/releases).
8+
Please refer to https://lse.levimc.org/
279

2810
## Usage
2911

README.zh.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,7 @@
55

66
## 安装
77

8-
### 注意
9-
10-
在安装Python引擎之前,你需要先安装[Python 3.12.10](https://www.python.org/downloads/release/python-31210/)
11-
要安装特定的引擎,您可以使用以下命令:
12-
```shell
13-
lip install github.com/LiteLDev/LegacyScriptEngine#lua
14-
lip install github.com/LiteLDev/LegacyScriptEngine#quickjs
15-
lip install github.com/LiteLDev/LegacyScriptEngine#nodejs
16-
lip install github.com/LiteLDev/LegacyScriptEngine#python
17-
```
18-
对于0.10.0之前的版本,可以使用以下命令:
19-
```shell
20-
lip install git.levimc.org/LiteLDev/legacy-script-engine-lua@版本
21-
lip install git.levimc.org/LiteLDev/legacy-script-engine-quickjs@版本
22-
lip install git.levimc.org/LiteLDev/legacy-script-engine-nodejs@版本
23-
lip install git.levimc.org/LiteLDev/legacy-script-engine-python@版本
24-
```
25-
可以在[releases](https://github.com/LiteLDev/LegacyScriptEngine/releases)中找到版本号。
8+
请参考 https://lse.levimc.org/zh/
269

2710
## 使用
2811

docs/index.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
# LegacyScriptEngine
22

3-
English | [简体中文](README.zh.md)
43
A plugin engine for running LLSE plugins on LeviLamina
54

65
## Installation
76

8-
### Attention
7+
### Server
8+
9+
!!! warning
10+
Before installing the Python engine, you need to install Python first. Here is a list of LSE versions and their required Python versions.
11+
12+
| LSE Version | Python Version |
13+
|-----------------|----------------|
14+
| >=0.16.2 | 3.12.10 |
15+
| >=0.9.0 <0.16.2 | 3.12.8 |
16+
| <0.9.0 | 3.10.11 |
917

10-
Before installing the Python engine, you need to
11-
install [Python 3.12.10](https://www.python.org/downloads/release/python-31210/) first.
1218
To install a specific engine, you can use the following command:
1319
```shell
1420
lip install github.com/LiteLDev/LegacyScriptEngine#lua
@@ -25,6 +31,24 @@ lip install git.levimc.org/LiteLDev/legacy-script-engine-python@version
2531
```
2632
Version numbers can be found in [releases](https://github.com/LiteLDev/LegacyScriptEngine/releases).
2733

34+
### Client
35+
36+
To install a specific engine, you can use the following command:
37+
```shell
38+
lip install github.com/LiteLDev/LegacyScriptEngine#client_lua
39+
lip install github.com/LiteLDev/LegacyScriptEngine#client_quickjs
40+
lip install github.com/LiteLDev/LegacyScriptEngine#client_nodejs
41+
lip install github.com/LiteLDev/LegacyScriptEngine#client_python
42+
```
43+
To install a specific version, you can add`@version` at the end of installation command, such as:
44+
```shell
45+
lip install github.com/LiteLDev/LegacyScriptEngine#client_lua@0.17.0-rc.2
46+
lip install github.com/LiteLDev/LegacyScriptEngine#client_quickjs@0.17.0-rc.2
47+
lip install github.com/LiteLDev/LegacyScriptEngine#client_nodejs@0.17.0-rc.2
48+
lip install github.com/LiteLDev/LegacyScriptEngine#client_python@0.17.0-rc.2
49+
```
50+
51+
2852
## Usage
2953

3054
To access plugin development API hints and scaffolding toolkits, visit the [legacy-script-engine-api](https://github.com/LiteLDev/legacy-script-engine-api) repository.

docs/index.zh.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
# LegacyScriptEngine
22

3-
[English](README.md) | 简体中文
43
一个用于在 LeviLamina 上运行 LLSE 插件的插件引擎
54

65
## 安装
76

8-
### 注意
7+
!!! warning
8+
在安装Python引擎之前,你需要先安装Python。下面是一份LSE版本和需要的Python版本的列表。
9+
10+
| LSE 版本 | Python 版本 |
11+
|-----------------|-----------|
12+
| >=0.16.2 | 3.12.10 |
13+
| >=0.9.0 <0.16.2 | 3.12.8 |
14+
| <0.9.0 | 3.10.11 |
15+
16+
### 服务端
917

10-
在安装Python引擎之前,你需要先安装[Python 3.12.10](https://www.python.org/downloads/release/python-31210/)
1118
要安装特定的引擎,您可以使用以下命令:
1219
```shell
1320
lip install github.com/LiteLDev/LegacyScriptEngine#lua
@@ -24,6 +31,23 @@ lip install git.levimc.org/LiteLDev/legacy-script-engine-python@版本
2431
```
2532
可以在[releases](https://github.com/LiteLDev/LegacyScriptEngine/releases)中找到版本号。
2633

34+
### 客户端
35+
36+
要安装特定的引擎,您可以使用以下命令:
37+
```shell
38+
lip install github.com/LiteLDev/LegacyScriptEngine#client_lua
39+
lip install github.com/LiteLDev/LegacyScriptEngine#client_quickjs
40+
lip install github.com/LiteLDev/LegacyScriptEngine#client_nodejs
41+
lip install github.com/LiteLDev/LegacyScriptEngine#client_python
42+
```
43+
要安装特定版本,需要在命令最后加上`@版本号`,例如:
44+
```shell
45+
lip install github.com/LiteLDev/LegacyScriptEngine#client_lua@0.17.0-rc.2
46+
lip install github.com/LiteLDev/LegacyScriptEngine#client_quickjs@0.17.0-rc.2
47+
lip install github.com/LiteLDev/LegacyScriptEngine#client_nodejs@0.17.0-rc.2
48+
lip install github.com/LiteLDev/LegacyScriptEngine#client_python@0.17.0-rc.2
49+
```
50+
2751
## 使用
2852

2953
如需获取插件开发 API 提示库和脚手架工具,请访问 [legacy-script-engine-api](https://github.com/LiteLDev/legacy-script-engine-api) 仓库

0 commit comments

Comments
 (0)