add multi language
This commit is contained in:
124
docs/en/dev_guide/WebUI.md
Normal file
124
docs/en/dev_guide/WebUI.md
Normal file
@ -0,0 +1,124 @@
|
||||
---
|
||||
outline: deep
|
||||
---
|
||||
# WebUI
|
||||
|
||||
本节对服务器的WebUI进行介绍。
|
||||
|
||||
## 启用和禁用WebUI
|
||||
|
||||
如需禁用WebUI，请在服务器启动时添加如下参数:
|
||||
|
||||
- Windows在命令行启动时使用`--hidden`，如下所示：
|
||||
```
|
||||
ew.exe --port 8080 --path ./data/ --hidden
|
||||
```
|
||||
- Linux在命令行启动时使用`--hidden`，如下所示：
|
||||
```
|
||||
ew --port 8080 --path ./data/ --hidden
|
||||
```
|
||||
|
||||
- Docker在启动时将`HIDDEN`环境变量设置为`true`，如下所示：
|
||||
```
|
||||
docker run -d \
|
||||
--name sif2 \
|
||||
-p 8080:8080 \
|
||||
-p 8000:8000 \
|
||||
-e HIDDEN=true \
|
||||
-v ./data:/data \
|
||||
-v ./asset:/asset \
|
||||
zhushenwudi/lovelive-sif2:1.0.1
|
||||
```
|
||||
|
||||
## WebUI的使用
|
||||
|
||||
WebUI的使用可以参照[WebUI使用说明](../user_guide/user_webui#WebUI-operation)
|
||||
|
||||
### 端口号
|
||||
WebUI的默认端口号为`8080`。
|
||||
|
||||
如需更改其端口号，请在服务器启动时使用如下参数。
|
||||
|
||||
- Windows在命令行启动时使用`--port <PORT>`，如将端口号改为`12345`，如下所示：
|
||||
```
|
||||
ew.exe --port 12345 --path ./data/
|
||||
```
|
||||
- Linux在命令行启动时使用`--port <PORT>`，如将端口号改为`12345`，如下所示：
|
||||
```
|
||||
ew --port 12345 --path ./data/
|
||||
```
|
||||
|
||||
- Docker在启动时将端口映射修改为所需端口号，如将端口号改为`12345`，如下所示：
|
||||
```
|
||||
docker run \
|
||||
--name sif2 \
|
||||
-p 12345:8080 \
|
||||
-p 8000:8000 \
|
||||
-v ./data:/data \
|
||||
-v ./asset:/asset \
|
||||
zhushenwudi/lovelive-sif2
|
||||
```
|
||||
|
||||
### 导入数据
|
||||
如需禁用导入数据，请在服务器启动时添加如下参数:
|
||||
|
||||
- Windows在命令行启动时使用`--disable-imports`，如下所示：
|
||||
```
|
||||
ew.exe --port 8080 --path ./data/ --disable-imports
|
||||
```
|
||||
- Linux在命令行启动时使用`--disable-imports`，如下所示：
|
||||
```
|
||||
ew --port 8080 --path ./data/ --disable-imports
|
||||
```
|
||||
|
||||
- Docker在启动时将`DISABLE_IMPORTS`环境变量设置为`true`，如下所示：
|
||||
```
|
||||
docker run -d \
|
||||
--name sif2 \
|
||||
-p 8080:8080 \
|
||||
-p 8000:8000 \
|
||||
-e DISABLE_IMPORTS=true \
|
||||
-v ./data:/data \
|
||||
-v ./asset:/asset \
|
||||
zhushenwudi/lovelive-sif2
|
||||
```
|
||||
|
||||
### 导出数据
|
||||
如需禁用导出数据，请在服务器启动时添加如下参数:
|
||||
|
||||
- Windows在命令行启动时使用`--disable-exports`，如下所示：
|
||||
```
|
||||
ew.exe --port 8080 --path ./data/ --disable-exports
|
||||
```
|
||||
- Linux在命令行启动时使用`--disable-exports`，如下所示：
|
||||
```
|
||||
ew --port 8080 --path ./data/ --disable-exports
|
||||
```
|
||||
|
||||
- Docker在启动时将`DISABLE_EXPORTS`环境变量设置为`true`，如下所示：
|
||||
```
|
||||
docker run -d \
|
||||
--name sif2 \
|
||||
-p 8080:8080 \
|
||||
-p 8000:8000 \
|
||||
-e DISABLE_EXPORTS=true \
|
||||
-v ./data:/data \
|
||||
-v ./asset:/asset \
|
||||
zhushenwudi/lovelive-sif2
|
||||
```
|
||||
|
||||
### 帮助页面
|
||||
帮助页面如下图所示:
|
||||
|
||||
|
||||
|
||||
帮助页面包括服务器的相关介绍和应用的下载和相关配置。
|
||||
|
||||
::: tip 参考
|
||||
1. 使用命令行参数`--global-android <GLOBAL_ANDROID>`、`--japan-android <JAPAN_ANDROID>`、`--global-ios <GLOBAL_IOS>`、`--japan-ios <JAPAN_IOS>`或环境变量`ANDROID_GLOABL`、`ANDROID_JAPAN`、`IOS_GLOBAL`、`IOS_JAPAN`设置帮助界面中的应用下载地址。
|
||||
2. 使用命令行参数`--assets-url <ASSETS_URL>`或环境变量`ASSET_URL`设置帮助页面中显示的“Assets URL”。
|
||||
|
||||
3. 如何获取预打补丁的apk安装包和ios安装包，请参考
|
||||
- [Android安装教程](../user_guide/installation/android)
|
||||
- [iOS安装教程](../user_guide/installation/ios)
|
||||
:::
|
||||
123
docs/en/dev_guide/assets_docs.md
Normal file
123
docs/en/dev_guide/assets_docs.md
Normal file
@ -0,0 +1,123 @@
|
||||
---
|
||||
outline: deep
|
||||
---
|
||||
# 游戏资源服务器配置 {#asset}
|
||||
本节为如何配置环境服务器。
|
||||
|
||||
## 开启资源服务器
|
||||
|
||||
### Windows和Linux
|
||||
使用命令行参数`--enable-asset-server`开启资源服务器，使用`--asset-port <ASSET_PORT>`指定资源服务器端口（默认为8000），使用`--asset-path <ASSET_PATH>`指定游戏资源位置（默认为`./asset/`）。
|
||||
|
||||
一个启动游戏资源服务器的典型命令为：
|
||||
- Windows
|
||||
::: warning 注意
|
||||
需要先下载[ew](./installation/windows.md)二进制文件
|
||||
:::
|
||||
```
|
||||
ew.exe --enable-asset-server --port 8080 --path ./data/ --asset-port 8000 --asset-path ./asset/ --max_time 1736076211
|
||||
```
|
||||
- Linux
|
||||
::: warning 注意
|
||||
需要先下载[ew](./installation/linux.md)二进制文件
|
||||
:::
|
||||
```
|
||||
./ew --enable-asset-server --port 8080 --path ./data/ --asset-port 8000 --asset-path ./asset/ --max_time 1736076211
|
||||
```
|
||||
|
||||
### Docker
|
||||
使用环境变量`ENABLE_ASSET_SERVER`开启资源服务器，并设置资源服务器端口映射，和游戏资源存储位置。
|
||||
|
||||
一个启动游戏资源服务器的典型命令为：
|
||||
```
|
||||
docker run -d \
|
||||
--name sif2 \
|
||||
-p 8080:8080 \
|
||||
-p 8000:8000 \
|
||||
-v ./data:/data \
|
||||
-v ./asset:/asset \
|
||||
-e ENABLE_ASSET_SERVER=true \
|
||||
zhushenwudi/lovelive-sif2
|
||||
```
|
||||
|
||||
## 使用资源服务器
|
||||
|
||||
### 下载游戏资源
|
||||
- 日服
|
||||
|
||||
日服的游戏资源可以在[lovelive-sif2-jp-assets](https://archive.org/download/lovelive-sif2-jp-assets)下载。
|
||||
|
||||
安卓客户端的游戏资源为`android-final.7z`。
|
||||
|
||||
iOS客户端的游戏资源为`ios-final.7z`。
|
||||
|
||||
|
||||
|
||||
- 国际服
|
||||
|
||||
国际服的游戏资源可以在[lovelive-sif2-gl-assets](https://archive.org/download/lovelive-sif2-gl-assets)下载。
|
||||
|
||||
安卓客户端的游戏资源为`EN-Android.7z`、`KR-Android.7z`和`ZH-Android.7z`。分别对应英文、韩文和中文游戏资源。
|
||||
|
||||
iOS客户端的游戏资源为`EN-iOS.7z`、`KR-iOS.7z`和`ZH-iOS.7z`。分别对应英文、韩文和中文游戏资源。
|
||||
|
||||
|
||||
|
||||
|
||||
### 游戏资源放置位置
|
||||
|
||||
游戏资源根目录由`--asset-path <ASSET_PATH>`指定，默认为`./asset/`。以下说明的根目录均为`./asset/`。
|
||||
|
||||
将游戏资源压缩包解压。按照下列方式进行放置。
|
||||
|
||||
- 日服
|
||||
```
|
||||
asset/
|
||||
├── maintenance/
|
||||
│ ├── maintenance.json
|
||||
├── {iOS,Android}/
|
||||
│ ├── 00a065ad8d01f2ecfd5530fc4d8df7e9
|
||||
│ ├── 00adc3ff560d26aaeb237a09d93a7f15
|
||||
│ ├── 00b7cb7d74ebf78d9876bf6a13617368
|
||||
│ ├── ...
|
||||
```
|
||||
|
||||
- 国际服
|
||||
```
|
||||
asset/
|
||||
├── maintenance/
|
||||
│ ├── maintenance.json
|
||||
├── {iOS,Android}/
|
||||
│ ├── {EN, KR, ZH}
|
||||
│ │ ├── 000c6b576d2f4ab80f90f1eba5858971
|
||||
│ │ ├── 00c32b6c388145f46694a95dc1a00167
|
||||
│ │ ├── 00c47e80ba847813d63d81aaea1b72aa
|
||||
│ │ ├── ...
|
||||
```
|
||||
|
||||
::: tip 注意
|
||||
`maintenance.json`文件内容为
|
||||
```json
|
||||
{
|
||||
"opened_at": "2024-02-05 02:00:00",
|
||||
"closed_at": "2024-02-05 04:00:00",
|
||||
"message": "Love Live! SIF2 MIRACLE LIVE! will undergo maintenance on (UTC+0) February 5, 02:00~04:00, you won't be able to log into the game. Please make sure to complete any ongoing activities before the update to avoid interruptions that may result in incomplete actions or unclaimed rewards",
|
||||
"server": 1,
|
||||
"gamelib": 0
|
||||
}
|
||||
```
|
||||
:::
|
||||
|
||||
::: tip 信息
|
||||
这里给出了日服游戏资源的百度云下载地址：
|
||||
|
||||
[安卓](https://pan.baidu.com/s/1ktVSFlwCjH2vtx6VlnZzPg?pwd=LLMP)
|
||||
|
||||
[iOS](https://pan.baidu.com/s/1-eHPCerXytL28FT2y-sF_Q?pwd=LLMP)
|
||||
|
||||
[安卓和iOS](https://pan.baidu.com/s/1QdJmV_ZbHAvY3oWdZ-cY5g?pwd=LLMP)
|
||||
:::
|
||||
|
||||
|
||||
|
||||
|
||||
43
docs/en/dev_guide/installation/docker.md
Normal file
43
docs/en/dev_guide/installation/docker.md
Normal file
@ -0,0 +1,43 @@
|
||||
---
|
||||
outline: deep
|
||||
---
|
||||
# Docker
|
||||
Docker镜像中继承了ew服务器，因此无需额外安装ew服务器。
|
||||
::: tip 注意
|
||||
Docker 是一个开源的平台，用于开发、交付和运行应用程序。在使用Docker部署时，以假定使用者已经掌握如何运维一台服务器，同时对容器化的概念和Docker的基础操作有一定了解。否则，请使用其他更加简单的部署方式。
|
||||
:::
|
||||
:::tip 注意
|
||||
本节并未提及如何配置游戏资源服务器，如需配置资源服务器请参考[游戏资源服务器配置](../assets_docs#asset)。
|
||||
:::
|
||||
|
||||
## 获取镜像
|
||||
```
|
||||
docker pull zhushenwudi/lovelive-sif2
|
||||
```
|
||||
|
||||
## 运行ew服务器
|
||||
|
||||
::: tip 注意
|
||||
1. ew服务器的游戏端口默认为`8080`，资源服务器端口默认为`8000`。
|
||||
2. ew服务器的数据存储位置默认为`/data`，本地路径默认为`./data`。
|
||||
3. ew服务器的游戏资源存储位置默认为`/asset`，本地路径默认为`./asset`。
|
||||
:::
|
||||
使用docker运行ew服务器，以下是一个典型的示例：
|
||||
```
|
||||
docker run -d \
|
||||
--name sif2 \
|
||||
-p 8080:8080 \
|
||||
-p 8000:8000 \
|
||||
-v ./data:/data \
|
||||
-v ./asset:/asset \
|
||||
zhushenwudi/lovelive-sif2
|
||||
```
|
||||
|
||||
查看状态：
|
||||
```
|
||||
docker container stats sif2
|
||||
```
|
||||
|
||||
::: tip 参考
|
||||
docker的环境变量请参考[环境变量和命令行参数](../variable-argument#variable)
|
||||
:::
|
||||
77
docs/en/dev_guide/installation/linux.md
Normal file
77
docs/en/dev_guide/installation/linux.md
Normal file
@ -0,0 +1,77 @@
|
||||
---
|
||||
outline: deep
|
||||
---
|
||||
# Linux
|
||||
本节介绍如何在Linux上安装ew。
|
||||
|
||||
:::tip 注意
|
||||
本节并未提及如何配置游戏资源服务器，如需配置资源服务器请参考[游戏资源服务器配置](../assets_docs#asset)。
|
||||
:::
|
||||
|
||||
## 方式一：使用二进制程序
|
||||
|
||||
### 下载二进制程序
|
||||
从[ew](https://pan.baidu.com/s/1z00zlPtrFtRmwLLoZjvc4w?pwd=yi7r)下载适用于Linux的二进制文件`ew`。
|
||||
|
||||
### 运行ew
|
||||
在当前目录下使用命令行，以下是一个典型的运行示例：
|
||||
```
|
||||
./ew --port 8080 --path ./data/ --max_time 1736076211
|
||||
```
|
||||
::: tip 注意
|
||||
具体的命令行参数可以在[环境变量和命令行参数](../variable-argument#variable)或者使用
|
||||
```
|
||||
./ew --help
|
||||
```
|
||||
查看。
|
||||
:::
|
||||
|
||||
## 方式二：从源代码编译
|
||||
|
||||
### 下载源代码
|
||||
从[ew](https://git.zhushenwudi.top/zhushenwudi/ew)下载或git克隆源代码。
|
||||
|
||||
### 编译源代码
|
||||
#### 构建说明
|
||||
1. 安装以下依赖
|
||||
- [Perl](https://www.perl.org/)
|
||||
- [Rust](https://www.rust-lang.org/)
|
||||
- [Node.js](https://nodejs.org/)
|
||||
- libssl-dev
|
||||
|
||||
:::tip 注意
|
||||
在Ubuntu发行版中安装 **Perl** 和 **libssl-dev** 可以使用以下命令安装:
|
||||
```
|
||||
apt install -y perl libssl-dev
|
||||
```
|
||||
其他的Linux发行版请参照其包管理说明或者自行编译安装。
|
||||
:::
|
||||
1. 构建WebUI
|
||||
```
|
||||
cd webui
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
1. 构建ew服务器
|
||||
- Debug模式
|
||||
```
|
||||
cargo build
|
||||
```
|
||||
- Release模式
|
||||
```
|
||||
cargo build --release
|
||||
```
|
||||
构建完成的二进制文件`ew`在源代码根目录下的`target/debug`或`target/release`中。可以将其移动到你想存储的位置。
|
||||
### 运行ew
|
||||
在当前目录下使用命令行，以下是一个典型的运行示例：
|
||||
```
|
||||
./ew --port 8080 --path ./data/ --max_time 1736076211
|
||||
```
|
||||
::: tip 注意
|
||||
具体的命令行参数可以在[环境变量和命令行参数](../variable-argument#variable)或者使用
|
||||
```
|
||||
./ew --help
|
||||
```
|
||||
查看。
|
||||
:::
|
||||
69
docs/en/dev_guide/installation/windows.md
Normal file
69
docs/en/dev_guide/installation/windows.md
Normal file
@ -0,0 +1,69 @@
|
||||
---
|
||||
outline: deep
|
||||
---
|
||||
# Windows
|
||||
本节介绍如何在Windows上安装ew。
|
||||
|
||||
:::tip 注意
|
||||
本节并未提及如何配置游戏资源服务器，如需配置资源服务器请参考[游戏资源服务器配置](../assets_docs#asset)。
|
||||
:::
|
||||
|
||||
## 方式一：使用二进制程序
|
||||
|
||||
### 下载二进制程序
|
||||
从[ew](https://pan.baidu.com/s/1z00zlPtrFtRmwLLoZjvc4w?pwd=yi7r)下载适用于Windows的二进制文件`ew.exe`。
|
||||
|
||||
### 运行ew
|
||||
在当前目录下打开CMD或者PowerShell，以下是一个典型的运行示例：
|
||||
```
|
||||
ew.exe --port 8080 --path ./data/ --max_time 1736076211
|
||||
```
|
||||
::: tip 注意
|
||||
具体的命令行参数可以在[环境变量和命令行参数](../variable-argument#variable)或者使用
|
||||
```
|
||||
ew.exe --help
|
||||
```
|
||||
查看。
|
||||
:::
|
||||
|
||||
## 方式二：从源代码编译
|
||||
|
||||
### 下载源代码
|
||||
从[ew](https://git.zhushenwudi.top/zhushenwudi/ew)下载或git克隆源代码。
|
||||
|
||||
### 编译源代码
|
||||
#### 构建说明
|
||||
1. 安装以下依赖
|
||||
- [Perl (StrawberryPerl)](https://strawberryperl.com/)
|
||||
- [Rust](https://www.rust-lang.org/)
|
||||
- [Node.js](https://nodejs.org/)
|
||||
|
||||
1. 构建WebUI
|
||||
```
|
||||
cd webui
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
1. 构建ew服务器
|
||||
- Debug模式
|
||||
```
|
||||
cargo build
|
||||
```
|
||||
- Release模式
|
||||
```
|
||||
cargo build --release
|
||||
```
|
||||
构建完成的二进制文件`ew.exe`在源代码根目录下的`target/debug`或`target/release`中。可以将其移动到你想存储的位置。
|
||||
### 运行ew
|
||||
在当前目录下打开CMD或者PowerShell，以下是一个典型的运行示例：
|
||||
```
|
||||
ew.exe --port 8080 --path ./data/ --max_time 1736076211
|
||||
```
|
||||
::: tip 注意
|
||||
具体的命令行参数可以在[环境变量和命令行参数](../variable-argument#variable)或者使用
|
||||
```
|
||||
ew.exe --help
|
||||
```
|
||||
查看。
|
||||
:::
|
||||
5
docs/en/dev_guide/introduction.md
Normal file
5
docs/en/dev_guide/introduction.md
Normal file
@ -0,0 +1,5 @@
|
||||
# 介绍
|
||||
本用户文档对如何搭建和使用 **Love Live! 学园偶像祭2 MIRACLE LIVE!** 的服务器，以及对如何使用其客户端进行说明。
|
||||
|
||||
你可以通过本节对该用户文档的内容进行快速浏览。
|
||||
|
||||
95
docs/en/dev_guide/variable-argument.md
Normal file
95
docs/en/dev_guide/variable-argument.md
Normal file
@ -0,0 +1,95 @@
|
||||
---
|
||||
outline: deep
|
||||
---
|
||||
# 环境变量和命令行参数 {#variable}
|
||||
|
||||
## 介绍
|
||||
|
||||
### Docker环境变量
|
||||
|
||||
`HTTPS`：是否开启https（默认: false）。
|
||||
|
||||
`ENABLE_ASSET_SERVER`：是否开启资源服务器。
|
||||
|
||||
`NPPS4_ADDRESS`：Sif NPPS4服务器地址（默认: “127.0.0.1:51376”）。
|
||||
|
||||
`MAXTIME`：服务器默认时间（默认: 1736076211），（该时间最大不可超过官方停服时间）。
|
||||
|
||||
`HIDDEN`：隐藏WeiUI（默认: false）。
|
||||
|
||||
`DISABLE_IMPORTS`：禁止导入账户（默认：false）。
|
||||
|
||||
`DISABLE_EXPORTS`：禁止导出账户（默认：false）。
|
||||
|
||||
`ANDROID_JAPAN`：帮助页面显示链接到该服务器的日服android应用下载地址。
|
||||
|
||||
`ANDROID_GLOABL`：帮助页面显示链接到该服务器的国际服android应用下载地址。
|
||||
|
||||
`IOS_JAPAN`：帮助页面显示链接到该服务器的的日服ios应用下载地址。
|
||||
|
||||
`IOS_GLOBAL`：帮助页面显示链接到该服务器的国际服ios应用下载地址。
|
||||
|
||||
`ASSET_URL`：帮助页面显示的游戏资源下载地址。
|
||||
|
||||
### 命令行参数
|
||||
::: tip 注意
|
||||
本节所列的变量有可能已经过时，可以通过`ew --help`查看所支持的参数，环境变量与之对应。
|
||||
:::
|
||||
|
||||
`--port <PORT>`: 服务器监听端口(默认: 8080)
|
||||
|
||||
`--asset-port <ASSET_PORT>`: 资源服务器监听端口(默认: 8000)
|
||||
|
||||
`--path <PATH>`: 数据库存放位置(默认: "./data/")
|
||||
|
||||
`--asset-path <ASSET_PATH>`: 游戏资源存放位置(默认: "./asset/")
|
||||
|
||||
`--enable-asset-server`: 开启资源服务器。
|
||||
|
||||
`--https`: 开启https。
|
||||
|
||||
`--npps4 <NPPS4>`: Sif NPPS4服务器地址，用于sif的账户连接(默认:"127.0.0.1:51376")
|
||||
|
||||
`--global-android <GLOBAL_ANDROID>`: 帮助页面显示链接到该服务器的国际服android应用下载地址。
|
||||
|
||||
`--japan-android <JAPAN_ANDROID>`: 帮助页面显示链接到该服务器的日服android应用下载地址。
|
||||
|
||||
`--global-ios <GLOBAL_IOS>`: 帮助页面显示链接到该服务器的国际服ios应用下载地址。
|
||||
|
||||
`--japan-ios <JAPAN_IOS>`: 帮助页面显示链接到该服务器的的日服ios应用下载地址。
|
||||
|
||||
`--assets-url <ASSETS_URL>`: 帮助页面显示的游戏资源下载地址。
|
||||
|
||||
`--max-time <MAX_TIME>`: 服务器默认的初始时间，以时间戳形式返回。（该时间最大不可超过官方停服时间）
|
||||
|
||||
`--hidden`: 隐藏Web界面。
|
||||
|
||||
`--purge`: 在启动服务器时，清理死亡账户。（死亡账户为账户中无任何卡片）
|
||||
|
||||
`--disable-imports`: 禁止账户导入功能。
|
||||
|
||||
`--disable-exports`: 禁止账户导出功能。
|
||||
|
||||
`--en-ios-asset-hash <EN_IOS_ASSET_HASH>`: 国际服ios客户端资源的hash。
|
||||
|
||||
`--jp-ios-asset-hash <JP_IOS_ASSET_HASH>`: 日服ios客户端资源的hash。
|
||||
|
||||
`--en-android-asset-hash <EN_ANDROID_ASSET_HASH>`: 国际服android客户端资源的hash。
|
||||
|
||||
`--jp-android-asset-hash <JP_ANDROID_ASSET_HASH>`: 日服android客户端资源的hash。
|
||||
|
||||
|
||||
## 如何设置
|
||||
|
||||
### Docker
|
||||
使用`-e`指定环境变量，下例为设置服务器默认时间为1736076200:
|
||||
```
|
||||
docker run -d \
|
||||
--name sif2 \
|
||||
-p 8080:8080 \
|
||||
-p 8000:8000 \
|
||||
-e MAXTIME=1736076200 \
|
||||
-v ./data:/data \
|
||||
-v ./asset:/asset \
|
||||
zhushenwudi/lovelive-sif2:1.0.1
|
||||
```
|
||||
Reference in New Issue
Block a user