diff --git a/.vitepress/config.mts b/.vitepress/config.mts index b87f024..c58a804 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -36,7 +36,10 @@ export default defineConfig({ ], }, { text: 'WebUI', link: '/docs/dev_guide/WebUI' }, + { text: '获取和安装预打补丁的游戏安装包', link: 'docs/dev_guide/patch_client' }, + { text: '游戏资源服务器配置', link: 'docs/dev_guide/assets_docs' }, { text: '环境变量和命令行参数', link: '/docs/dev_guide/variable-argument' }, + ] } ] diff --git a/docs/dev_guide/WebUI.md b/docs/dev_guide/WebUI.md index e80bab4..1a81f1c 100644 --- a/docs/dev_guide/WebUI.md +++ b/docs/dev_guide/WebUI.md @@ -1,3 +1,6 @@ +--- +outline: deep +--- # WebUI 本节对服务器的WebUI进行介绍。 @@ -29,6 +32,8 @@ docker run -d \ ## WebUI的使用 +WebUI的使用可以参照[WebUI使用说明](../user_guide/user_webui#WebUI-operation) + ### 端口号 WebUI的默认端口号为`8080`。 @@ -51,57 +56,56 @@ docker run \ -p 8000:8000 \ -v ./data:/data \ -v ./asset:/asset \ - zhushenwudi/lovelive-sif2:1.0.1 + zhushenwudi/lovelive-sif2 ``` -### 主界面 +### 导入数据 +如需禁用导入数据，请在服务器启动时添加如下参数: -WebUI的界面如下图所示： +- Windows在命令行启动时使用`--disable-imports`，如下所示： +``` +ew.exe --port 8080 --path ./data/ --disable-imports +``` +- Linux在命令行启动时使用`--disable-imports`，如下所示： +``` +ew --port 8080 --path ./data/ --disable-imports +``` -![WebUI主界面](../image/webui_mainwindows.png) +- 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 +``` -### 个人账户登录及其设置 - -在主页面输入SIF2 ID和数据迁移密钥即可登录到个人账户设置页面。界面如下图所示： - -![用户账户设置](../image/webui_login_setting.png) - -其中包括导出用户数据，登出，设置登录奖励列表和设置服务器时间。 - -#### 导出用户数据 -点击导出用户数据，会下载四个文件，这四个文件保存着用户数据，可以在导入用户数据时使用。 - -#### 登出 -点击登出按钮，即可返回登录界面 - -#### 设置登录奖励列表 -你可以增加登录奖励或删除登录奖励。 - -登录奖励的id的列表请自行查阅。 - -#### 设置服务器时间 -该服务器时间只适用于当前登录账户，你可以更改服务器时间以更改当前卡池和当前活动。 - -服务器时间的输入可以使用`YYYY/MM/DD`形式，假如你想将时间修改为2023年11月1日，则输入`2023/11/01`即可。 - -:::tip 参考 -1. 可以使用命令行参数`--disable-exports`或环境变量`DISABLE_EXPORTS`禁止服务器导出数据。 -2. SIF2 ID和数据迁移密钥的获取请参考[XX](https://example.com)。 -::: -### 导入用户数据 -导入用户数据为在新的服务器上导入其他服务器的数据。界面如下图所示： - -![导入用户数据](../image/webui_import_user_data.png) - -选择服务器导出的四个文件和输入对应的数据迁移密钥，点击提交后即可将其他服务器的数据导入到新的服务器。 - -::: tip 参考 -1. 可以使用命令行参数`--disable-imports`或环境变量`DISABLE_IMPORTS`禁止服务器导入数据。 -2. 数据迁移密钥的获取可以参考[XX](https://example.com)。 -::: +- 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 +``` ### 帮助页面 帮助页面如下图所示: @@ -114,5 +118,5 @@ WebUI的界面如下图所示： 1. 使用命令行参数`--global-android `、`--japan-android `、`--global-ios `、`--japan-ios `或环境变量`ANDROID_GLOABL`、`ANDROID_JAPAN`、`IOS_GLOBAL`、`IOS_JAPAN`设置帮助界面中的应用下载地址。 2. 使用命令行参数`--assets-url `或环境变量`ASSET_URL`设置帮助页面中显示的“Assets URL”。 ![帮助页面注意事项](../image/webui_help_info.png) -3. 如何获取预打补丁的apk安装包和ios安装包，请参考[XX](https://example.com) +3. 如何获取预打补丁的apk安装包和ios安装包，请参考[获取和安装预打补丁的游戏安装包](./patch_client#patch) ::: \ No newline at end of file diff --git a/docs/dev_guide/assets_docs.md b/docs/dev_guide/assets_docs.md index 5d2a7df..1d95a23 100644 --- a/docs/dev_guide/assets_docs.md +++ b/docs/dev_guide/assets_docs.md @@ -1 +1,117 @@ -# 游戏资源服务器配置 \ No newline at end of file +--- +outline: deep +--- +# 游戏资源服务器配置 {#asset} +本节为如何配置环境服务器。 + +## 开启资源服务器 + +### Windows和Linux +使用命令行参数`--enable-asset-server`开启资源服务器，使用`--asset-port `指定资源服务器端口（默认为8000），使用`--asset-path `指定游戏资源位置（默认为`./asset/`）。 + +一个启动游戏资源服务器的典型命令为： +- Windows +``` +ew.exe --enable-asset-server --port 8080 --path ./data/ --asset-port 8000 --asset-path ./asset/ --max_time 1736076211 +``` +- Linux +``` +./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-jp-assets](../image/28.png) + +- 国际服 + +国际服的游戏资源可以在[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`。分别对应英文、韩文和中文游戏资源。 + +![lovelive-sif2-gl-assets](../image/29.png) + + +### 游戏资源放置位置 + +游戏资源根目录由`--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) +::: + + + + diff --git a/docs/dev_guide/installation/docker.md b/docs/dev_guide/installation/docker.md index 457a17f..5457c80 100644 --- a/docs/dev_guide/installation/docker.md +++ b/docs/dev_guide/installation/docker.md @@ -1,15 +1,18 @@ +--- +outline: deep +--- # Docker Docker镜像中继承了ew服务器，因此无需额外安装ew服务器。 ::: tip 注意 Docker 是一个开源的平台，用于开发、交付和运行应用程序。在使用Docker部署时，以假定使用者已经掌握如何运维一台服务器，同时对容器化的概念和Docker的基础操作有一定了解。否则，请使用其他更加简单的部署方式。 ::: :::tip 注意 -本节并未提及如何配置游戏资源服务器，如需配置资源服务器请参考[XX](https://example.com)。 +本节并未提及如何配置游戏资源服务器，如需配置资源服务器请参考[游戏资源服务器配置](../assets_docs#asset)。 ::: ## 获取镜像 ``` -docker pull zhushenwudi/lovelive-sif2:1.0.1 +docker pull zhushenwudi/lovelive-sif2 ``` ## 运行ew服务器 @@ -27,7 +30,7 @@ docker run -d \ -p 8000:8000 \ -v ./data:/data \ -v ./asset:/asset \ - zhushenwudi/lovelive-sif2:1.0.1 + zhushenwudi/lovelive-sif2 ``` 查看状态： @@ -36,5 +39,5 @@ docker container stats sif2 ``` ::: tip 参考 -docker的环境变量请参考[环境变量和命令行参数](../variable-argument.md) +docker的环境变量请参考[环境变量和命令行参数](../variable-argument#variable) ::: \ No newline at end of file diff --git a/docs/dev_guide/installation/linux.md b/docs/dev_guide/installation/linux.md index 62aaf13..f0b7863 100644 --- a/docs/dev_guide/installation/linux.md +++ b/docs/dev_guide/installation/linux.md @@ -1,8 +1,11 @@ +--- +outline: deep +--- # Linux 本节介绍如何在Linux上安装ew。 :::tip 注意 -本节并未提及如何配置游戏资源服务器，如需配置资源服务器请参考[XX](https://example.com)。 +本节并未提及如何配置游戏资源服务器，如需配置资源服务器请参考[游戏资源服务器配置](../assets_docs#asset)。 ::: ## 方式一：使用二进制程序 @@ -16,7 +19,7 @@ ./ew --port 8080 --path ./data/ --max_time 1736076211 ``` ::: tip 注意 -具体的命令行参数可以在[环境变量和命令行参数](../variable-argument.md)或者使用 +具体的命令行参数可以在[环境变量和命令行参数](../variable-argument#variable)或者使用 ``` ./ew --help ``` @@ -26,7 +29,7 @@ ## 方式二：从源代码编译 ### 下载源代码 -从[XX](https://example.com)下载或git克隆源代码。 +从[ew](https://git.zhushenwudi.top/zhushenwudi/ew)下载或git克隆源代码。 ### 编译源代码 #### 构建说明 @@ -66,7 +69,7 @@ cargo build --release ./ew --port 8080 --path ./data/ --max_time 1736076211 ``` ::: tip 注意 -具体的命令行参数可以在[环境变量和命令行参数](../variable-argument.md)或者使用 +具体的命令行参数可以在[环境变量和命令行参数](../variable-argument#variable)或者使用 ``` ./ew --help ``` diff --git a/docs/dev_guide/installation/windows.md b/docs/dev_guide/installation/windows.md index 9ed86d3..5cdffc7 100644 --- a/docs/dev_guide/installation/windows.md +++ b/docs/dev_guide/installation/windows.md @@ -1,8 +1,11 @@ +--- +outline: deep +--- # Windows 本节介绍如何在Windows上安装ew。 :::tip 注意 -本节并未提及如何配置游戏资源服务器，如需配置资源服务器请参考[XX](https://example.com)。 +本节并未提及如何配置游戏资源服务器，如需配置资源服务器请参考[游戏资源服务器配置](../assets_docs#asset)。 ::: ## 方式一：使用二进制程序 @@ -16,7 +19,7 @@ ew.exe --port 8080 --path ./data/ --max_time 1736076211 ``` ::: tip 注意 -具体的命令行参数可以在[环境变量和命令行参数](https://example.com)或者使用 +具体的命令行参数可以在[环境变量和命令行参数](../variable-argument#variable)或者使用 ``` ew.exe --help ``` @@ -26,7 +29,7 @@ ew.exe --help ## 方式二：从源代码编译 ### 下载源代码 -从[XX](https://example.com)下载或git克隆源代码。 +从[ew](https://git.zhushenwudi.top/zhushenwudi/ew)下载或git克隆源代码。 ### 编译源代码 #### 构建说明 @@ -58,7 +61,7 @@ cargo build --release ew.exe --port 8080 --path ./data/ --max_time 1736076211 ``` ::: tip 注意 -具体的命令行参数可以在[环境变量和命令行参数](../variable-argument.md)或者使用 +具体的命令行参数可以在[环境变量和命令行参数](../variable-argument#variable)或者使用 ``` ew.exe --help ``` diff --git a/docs/dev_guide/introduction.md b/docs/dev_guide/introduction.md index 17f2dd1..8799179 100644 --- a/docs/dev_guide/introduction.md +++ b/docs/dev_guide/introduction.md @@ -3,14 +3,3 @@ 你可以通过本节对该用户文档的内容进行快速浏览。 -## 起步 - -本章对服务器的下载和安装进行介绍。 - -### 下载和安装 - -该节介绍了如何在Windows、Linux以及Docker中安装和运行ew服务器。 - -## 使用说明 - -这一章对服务器和客户端的详细使用进行了介绍，大部分遇到的问题都可以在本章中获得解答。 \ No newline at end of file diff --git a/docs/dev_guide/patch_client.md b/docs/dev_guide/patch_client.md index 4368509..9715bb5 100644 --- a/docs/dev_guide/patch_client.md +++ b/docs/dev_guide/patch_client.md @@ -1,4 +1,7 @@ -# 获取和安装预打补丁的游戏安装包 +--- +outline: deep +--- +# 获取和安装预打补丁的游戏安装包 {#patch} ## iOS 得益于Discord的Triangle，你只需下载对应的ipa文件即可。然后将该ipa文件侧载安装手机上即可。 @@ -11,8 +14,22 @@ ### 获取原版游戏安装包(可选) 你需要先获取原版的游戏安装包，你可以从下面的链接中获取原版的游戏安装包。 -- [国际服](https://example.com) -- [日服](https://example.com) +- [国际服](https://arasfon.ru/direct/lovelive/sif2/server-patcher/base-apks/sif2_gl_base_hlow.apk) +- [日服](https://arasfon.ru/direct/lovelive/sif2/server-patcher/base-apks/sif2_jp_base_hlow.apk) ### 给原版安装包打补丁 +1. 打开[LLSIF2 Server Patcher](https://arasfon.ru/sif2/patcher/)。 +2. 打开使用自定义apk，将apk拖入上传框中。（可选） +3. 将服务器URL输入到API URL中。 +4. 将资源服务器URL输入到Assets URL中，一个可选的资源服务器为https://sif2.sif.moe 。 +5. 选择游戏版本。 +6. 更改头部格式（Header format）为Lowercase。 +7. 点击修补（Patch）。 +8. 下载修补好的安装包文件。 + +![patch](../image/27.png) + +### 给修补好的安装包文件签名 + +使用[uber-apk-signer](https://github.com/patrickfav/uber-apk-signer?tab=readme-ov-file)给安装包签名。具体操作可参考uber-apk-signer项目说明。 \ No newline at end of file diff --git a/docs/dev_guide/variable-argument.md b/docs/dev_guide/variable-argument.md index ab31a50..8cb6a99 100644 --- a/docs/dev_guide/variable-argument.md +++ b/docs/dev_guide/variable-argument.md @@ -1,4 +1,7 @@ -# 环境变量和命令行参数 +--- +outline: deep +--- +# 环境变量和命令行参数 {#variable} ## 介绍 diff --git a/docs/image/27.png b/docs/image/27.png new file mode 100644 index 0000000..d78f09b Binary files /dev/null and b/docs/image/27.png differ diff --git a/docs/image/28.png b/docs/image/28.png new file mode 100644 index 0000000..2f06a5e Binary files /dev/null and b/docs/image/28.png differ diff --git a/docs/image/29.png b/docs/image/29.png new file mode 100644 index 0000000..84d40f8 Binary files /dev/null and b/docs/image/29.png differ diff --git a/docs/image/webui_import_user_data.png b/docs/image/webui_import_user_data.png deleted file mode 100644 index 8001fb9..0000000 Binary files a/docs/image/webui_import_user_data.png and /dev/null differ diff --git a/docs/image/webui_login_setting.png b/docs/image/webui_login_setting.png deleted file mode 100644 index 5447052..0000000 Binary files a/docs/image/webui_login_setting.png and /dev/null differ diff --git a/docs/image/webui_mainwindows.png b/docs/image/webui_mainwindows.png deleted file mode 100644 index 191494a..0000000 Binary files a/docs/image/webui_mainwindows.png and /dev/null differ diff --git a/docs/user_guide/ios_side.md b/docs/user_guide/ios_side.md deleted file mode 100644 index 057e056..0000000 --- a/docs/user_guide/ios_side.md +++ /dev/null @@ -1 +0,0 @@ -# iOS侧载教程