add multi language

This commit is contained in:
zhushenwudi 2025-01-22 17:42:18 +08:00
parent 85d68e358f
commit 6c93eb93c5
34 changed files with 2214 additions and 98 deletions

View File

@ -1,54 +0,0 @@
import { defineConfig } from 'vitepress'
// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "Sif 2",
description: "A Sif2 Server and Client Documents",
ignoreDeadLinks: true,
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: '用户指南', link: '/docs/user_guide/client_docs' },
{ text: '服务器指南', link: '/docs/dev_guide/introduction' }
],
sidebar: {
'/docs/user_guide/': [
{
text: '游戏用户指南',
items: [
{
text: '安装',
items: [
{ text: 'IOS', link: '/docs/user_guide/installation/ios' },
{ text: 'Android', link: '/docs/user_guide/installation/android' },
],
},
{ text: '游戏内使用说明', link: '/docs/user_guide/client_docs' },
{ text: 'WebUI使用说明', link: '/docs/user_guide/user_webui' },
{ text: '游戏相关信息', link: '/docs/user_guide/game_info' },
]
}
],
'/docs/dev_guide/': [
{
text: '服务器指南',
items: [
{ text: '介绍', link: '/docs/dev_guide/introduction' },
{
text: '安装',
items: [
{ text: 'Windows', link: '/docs/dev_guide/installation/windows' },
{ text: 'Linux', link: '/docs/dev_guide/installation/linux' },
{ text: 'docker', link: '/docs/dev_guide/installation/docker' },
],
},
{ text: 'WebUI', link: '/docs/dev_guide/WebUI' },
{ text: '游戏资源服务器配置', link: '/docs/dev_guide/assets_docs' },
{ text: '环境变量和命令行参数', link: '/docs/dev_guide/variable-argument' },
]
}
]
},
}
})

51
.vitepress/config/en.ts Normal file
View File

@ -0,0 +1,51 @@
import {defineConfig} from "vitepress";
export const en = defineConfig({
lang: 'en-US',
themeConfig: {
nav: [
{text: 'User guide', link: '/docs/en/user_guide/client_docs'},
{text: 'Server guide', link: '/docs/en/dev_guide/introduction'}
],
sidebar: {
'/docs/en/user_guide/': [
{
text: 'Game user guide',
items: [
{
text: 'Installation',
items: [
{text: 'IOS', link: '/docs/en/user_guide/installation/ios'},
{text: 'Android', link: '/docs/en/user_guide/installation/android'},
],
},
{text: '游戏内使用说明', link: '/docs/en/user_guide/client_docs'},
{text: 'WebUI使用说明', link: '/docs/en/user_guide/user_webui'},
{text: '游戏相关信息', link: '/docs/en/user_guide/game_info'},
]
}
],
'/docs/en/dev_guide/': [
{
text: '服务器指南',
items: [
{text: '介绍', link: '/docs/en/dev_guide/introduction'},
{
text: '安装',
items: [
{text: 'Windows', link: '/docs/en/dev_guide/installation/windows'},
{text: 'Linux', link: '/docs/en/dev_guide/installation/linux'},
{text: 'docker', link: '/docs/en/dev_guide/installation/docker'},
],
},
{text: 'WebUI', link: '/docs/en/dev_guide/WebUI'},
{text: '游戏资源服务器配置', link: '/docs/en/dev_guide/assets_docs'},
{text: '环境变量和命令行参数', link: '/docs/en/dev_guide/variable-argument'},
]
}
]
},
}
});

View File

@ -0,0 +1,12 @@
import {defineConfig} from 'vitepress'
import {en} from './en'
import {zh} from './zh'
import {shared} from "./shared";
export default defineConfig({
...shared,
locales: {
root: {label: "简体中文", ...zh},
en: {label: 'English', link: '/docs/en/', ...en}
}
})

View File

@ -0,0 +1,22 @@
import {defineConfig} from 'vitepress'
export const shared = defineConfig({
title: "Sif 2",
description: "A Sif2 Server and Client Documents",
ignoreDeadLinks: true,
themeConfig: {
logo: '/logo.png',
socialLinks: [
{icon: 'github', link: 'https://git.zhushenwudi.top/zhushenwudi/ew'}
]
},
markdown: {
image: {
// 默认禁用;设置为 true 可为所有图片启用懒加载。
lazyLoading: true
}
},
rewrites: {
'docs/zh/:rest*': ':rest*'
}
});

64
.vitepress/config/zh.ts Normal file
View File

@ -0,0 +1,64 @@
import {defineConfig} from "vitepress";
export const zh = defineConfig({
lang: 'zh-Hans',
themeConfig: {
nav: [
{text: '用户指南', link: '/docs/zh/user_guide/client_docs'},
{text: '服务器指南', link: '/docs/zh/dev_guide/introduction'}
],
sidebar: {
'/docs/zh/user_guide/': [
{
text: '游戏用户指南',
items: [
{
text: '安装',
items: [
{text: 'IOS', link: '/docs/zh/user_guide/installation/ios'},
{text: 'Android', link: '/docs/zh/user_guide/installation/android'},
],
},
{text: '游戏内使用说明', link: '/docs/zh/user_guide/client_docs'},
{text: 'WebUI使用说明', link: '/docs/zh/user_guide/user_webui'},
{text: '游戏相关信息', link: '/docs/zh/user_guide/game_info'},
]
}
],
'/docs/zh/dev_guide/': [
{
text: '服务器指南',
items: [
{text: '介绍', link: '/docs/zh/dev_guide/introduction'},
{
text: '安装',
items: [
{text: 'Windows', link: '/docs/zh/dev_guide/installation/windows'},
{text: 'Linux', link: '/docs/zh/dev_guide/installation/linux'},
{text: 'docker', link: '/docs/zh/dev_guide/installation/docker'},
],
},
{text: 'WebUI', link: '/docs/zh/dev_guide/WebUI'},
{text: '游戏资源服务器配置', link: '/docs/zh/dev_guide/assets_docs'},
{text: '环境变量和命令行参数', link: '/docs/zh/dev_guide/variable-argument'},
]
}
]
},
docFooter: {
prev: '上一页',
next: '下一页'
},
langMenuLabel: '多语言',
returnToTopLabel: '回到顶部',
sidebarMenuLabel: '菜单',
darkModeSwitchLabel: '主题',
lightModeSwitchTitle: '切换到浅色模式',
darkModeSwitchTitle: '切换到深色模式',
skipToContentLabel: '跳转到内容'
}
});

View File

@ -110,13 +110,15 @@ docker run -d \
### 帮助页面
帮助页面如下图所示:
![帮助页面](../image/webui_help.jpeg)
![帮助页面](../../image/webui_help.jpeg)
帮助页面包括服务器的相关介绍和应用的下载和相关配置。
::: 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”。
![帮助页面注意事项](../image/webui_help_info.png)
3. 如何获取预打补丁的apk安装包和ios安装包请参考[获取和安装预打补丁的游戏安装包](patch_client.md#patch)
![帮助页面注意事项](../../image/webui_help_info.png)
3. 如何获取预打补丁的apk安装包和ios安装包请参考
- [Android安装教程](../user_guide/installation/android)
- [iOS安装教程](../user_guide/installation/ios)
:::

View File

@ -51,7 +51,7 @@ docker run -d \
iOS客户端的游戏资源为`ios-final.7z`
![lovelive-sif2-jp-assets](../image/28.png)
![lovelive-sif2-jp-assets](../../image/28.png)
- 国际服
@ -61,7 +61,7 @@ iOS客户端的游戏资源为`ios-final.7z`。
iOS客户端的游戏资源为`EN-iOS.7z``KR-iOS.7z``ZH-iOS.7z`。分别对应英文、韩文和中文游戏资源。
![lovelive-sif2-gl-assets](../image/29.png)
![lovelive-sif2-gl-assets](../../image/29.png)
### 游戏资源放置位置

18
docs/en/index.md Normal file
View File

@ -0,0 +1,18 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: home
hero:
name: "Love Live! School idol festival 2\nMIRACLE LIVE!"
text: "User guide and server guide"
tagline:
actions:
- theme: brand
text: User guide
link: /docs/en/user_guide/client_docs
- theme: alt
text: Server guide
link: /docs/en/dev_guide/introduction

View File

@ -8,15 +8,15 @@ outline: deep
1. 打开手机设置下滑找到APP。
<div style="text-align: center;">
<img src="../image/10.png" style="height: 600px;" alt="设置"/>
<img src="../../image/10.png" style="height: 600px;" alt="设置"/>
</div>
2. 进入APP下滑找到スクフェス
<div style="text-align: center;">
<img src="../image/11.png" style="height: 600px;" alt="APP">
<img src="../../image/11.png" style="height: 600px;" alt="APP">
</div>
3. 进入スクフェス下滑找到Server URL和Assets URL。
<div style="text-align: center;">
<img src="../image/12.png" style="height: 600px;" alt="スクフェス2">
<img src="../../image/12.png" style="height: 600px;" alt="スクフェス2">
</div>
4. 填入服务器网址和资源服务器网址。
@ -27,7 +27,7 @@ outline: deep
## 通用操作 {#general-use}
### 下载资源包时发生异常 {#assets-error}
![资源异常](../image/assets_error.png)
![资源异常](../../image/assets_error.png)
因为Assets URL是国外CDN中国大陆地区的访问链接不是很好
- 有条件的话,可以通过科学上网的方式
- 使用[本地搭建资源服务器](../dev_guide/assets_docs.md)的方式
@ -37,23 +37,23 @@ outline: deep
### 查看Sif2 ID {#sif2-id}
1. 在游戏主界面,点击右上角的菜单。
![主界面](../image/1.png)
![主界面](../../image/1.png)
2. 点击 **プロフィール**
![菜单界面](../image/2.png)
![菜单界面](../../image/2.png)
3. 页面下方的即为Sif2 ID。
![profile](../image/3.png)
![profile](../../image/3.png)
### 设置数据迁移密钥 {#key}
1. 在游戏主界面,点击右上角的菜单。
![主界面](../image/1.png)
![主界面](../../image/1.png)
2. 点击 **データ引き継ぎ**
![菜单](../image/4.png)
![菜单](../../image/4.png)
3. 点击 **データ引き継ぎ**
![データ引き継ぎ](../image/5.png)
![データ引き継ぎ](../../image/5.png)
4. 上面的 **引き継ぎID** 为数据迁移ID下面的 **パスワード** 即为需要设置的数据迁移密钥。
![引き継ぎID](../image/6.png)
![引き継ぎID](../../image/6.png)
5. 点击 **次へ** 确定。
### 迁移数据 {#migration}
@ -62,13 +62,13 @@ outline: deep
1. 确保不同设备使用的服务器为同一服务器。
2. 打开游戏,点击右上角的菜单。
![待机界面](../image/13.png)
![待机界面](../../image/13.png)
3. 点击 **データ引き継ぎ**
![菜单](../image/14.png)
![菜单](../../image/14.png)
4. 点击 **データ引き継ぎ**
![データ引き継ぎ](../image/15.png)
![データ引き継ぎ](../../image/15.png)
5. 在上面的 **引き継ぎID** 输入数据迁移ID在下面的 **パスワード** 输入数据迁移密钥。
![引き継ぎID](../image/16.png)
![引き継ぎID](../../image/16.png)
6. 点击 **次へ** 确定。
#### 跨服迁移数据 {#different-server}
@ -80,22 +80,22 @@ outline: deep
以下操作会使游戏数据初始化,会使游戏账号丢失。请谨慎操作。
:::
1. 打开游戏,点击右上角的菜单。
![待机界面](../image/13.png)
![待机界面](../../image/13.png)
2. 点击 **ゲームデータ削除**
![菜单](../image/25.png)
![菜单](../../image/25.png)
3. 点击 **OK**
![ゲームデータ削除](../image/26.png)
![ゲームデータ削除](../../image/26.png)
### 获得Loveca、金币等道具的方式 {#gift}
1. 在游戏主界面,点击右上角的菜单。
![主界面](../image/1.png)
![主界面](../../image/1.png)
2. 点击 **シリアルコード**
![菜单](../image/7.png)
![菜单](../../image/7.png)
3. 点击 **シリアルコード入力**
![シリアルコード](../image/8.png)
![シリアルコード](../../image/8.png)
4. 输入兑换码点击OK即可兑换。
![シリアルコード入力](../image/9.png)
![シリアルコード入力](../../image/9.png)
::: tip 注意
兑换码格式为兑换码种类+数量,例如:

View File

@ -23,4 +23,9 @@ outline: deep
游戏活动的开始和结束时间可以参考[LLwiki](https://llwiki.org/zh/LoveLive!%E5%AD%A6%E5%9B%AD%E5%81%B6%E5%83%8F%E7%A5%AD2_MIRACLE_LIVE!%E6%B4%BB%E5%8A%A8%E5%88%97%E8%A1%A8)。
## 生日招募一览
生日招募的开始时间和结束时间可以参考[ラブライブスクールアイドルフェスティバル2 MIRACLE LIVE攻略Wiki](https://gamerch.com/lovelivesif2/808233#outline__%E8%AA%95%E7%94%9F%E6%97%A5%E5%8B%A7%E8%AA%98%E4%B8%80%E8%A6%A7)该时间为东京时间GMT+9
生日招募的开始时间和结束时间可以参考[ラブライブスクールアイドルフェスティバル2 MIRACLE LIVE攻略Wiki](https://gamerch.com/lovelivesif2/808233#outline__%E8%AA%95%E7%94%9F%E6%97%A5%E5%8B%A7%E8%AA%98%E4%B8%80%E8%A6%A7)该时间为东京时间GMT+9
## 其他查卡器网站
- [wazzia](https://sif2.wazzia.com)
- [idol.st](https://idol.st)
- [LLwiki](https://llwiki.org/zh/LoveLive!%E5%AD%A6%E5%9B%AD%E5%81%B6%E5%83%8F%E7%A5%AD2_MIRACLE_LIVE!%E5%8D%A1%E7%89%8C%E5%88%97%E8%A1%A8)

View File

@ -28,20 +28,20 @@ outline: deep
Server URL的获取请咨询服主
:::
![patch](../../image/27.png)
![patch](../../../image/27.png)
### 给修补好的安装包文件签名
使用[uber-apk-signer](https://github.com/patrickfav/uber-apk-signer/releases/download/v1.3.0/uber-apk-signer-1.3.0.jar)给安装包签名。
1. 安装[JDK8+](https://adoptium.net/temurin/releases/)
![JDK](../../image/32.png)
![JDK](../../../image/32.png)
```shell
java -jar uber-apk-signer-1.3.0.jar --apks sif2_patched.apk
```
:::tip 注意
jar和apk路径位置请根据自己的情况修改
:::
![打包](../../image/33.png)
![打包](../../../image/33.png)
### 传入手机安装
基本操作,不展开说明

View File

@ -19,7 +19,7 @@ outline: deep
:::
### 安装包下载
得益于Discord的Triangle你只需下载对应的ipa文件即可。然后将该ipa文件侧载安装手机上即可。
得益于Discord的Triangle你只需下载对应的ipa文件然后将该ipa文件侧载安装手机上即可。
- [国际服](https://arasfon.ru/direct/lovelive/sif2/patched-clients/ios/sif2_gl.ipa)
- [日服](https://arasfon.ru/direct/lovelive/sif2/patched-clients/ios/sif2_jp.ipa)
:::tip 注意
@ -29,9 +29,9 @@ outline: deep
### 使用SideloadlyIOS17+使用——7天需电脑重新签名 推荐
[下载地址](https://sideloadly.io/)
1. 按照电脑平台选择下载链接。
![Sideloadly URL](../../image/30.png)
![Sideloadly URL](../../../image/30.png)
2. 打开Sideloadly
![安装](../../image/31.png)
![安装](../../../image/31.png)
- Step1拖入准备好的ipa文件。
- Step2使用USB连接苹果设备。
- Step3输入你的苹果ID。

View File

@ -11,20 +11,20 @@ outline: deep
### 主界面 {#main-interface }
WebUI的界面如下图所示
![WebUI](../image/17.png)
![WebUI](../../image/17.png)
其中包括个人账户登录和导入用户数据和查看帮助等相关信息。
### 个人账户登录 {#account-login}
在主页面输入[SIF2 ID](./client_docs.md#sif2-id)和[数据迁移密钥](./client_docs.md#key)即可登录到个人账户设置页面。界面如下图所示:
![WebUI_user](../image/18.png)
![WebUI_user](../../image/18.png)
### 更改登录奖励 {#login-bonus}
在WebUI个人设置界面的 **当前登录奖励列表** 中添加登录奖励的id即可登录奖励id的信息请自行查阅。
![登录奖励](../image/19.png)
![登录奖励](../../image/19.png)
### 更改游戏服务器时间 {#server-time}
在WebUI个人设置界面的 **服务器时间** 中输入时间,即可更改服务器时间,跳转到指定活动或卡池。
![服务器时间](../image/20.png)
![服务器时间](../../image/20.png)
服务器时间的格式为yyyy/MM/dd HH:mm:ss。
例如输入2023/12/01 22:30:30表示服务器时间更改为2023年12月1日23时30分30秒。
@ -41,11 +41,11 @@ WebUI的界面如下图所示
1. 确保服务器开启了 **WebUI**、**导出用户数据** 和 **导入用户数据**
2. 在导出服务器上进入个人账户设置界面。
3. 在导出服务器上的个人账户设置界面点击右上角的 **导出用户数据**
![导出用户数据](../image/21.png)
![导出用户数据](../../image/21.png)
4. 你会获得四个文件,这四个文件即为用户数据文件。
![用户数据文件](../image/22.png)
![用户数据文件](../../image/22.png)
5. 在导入服务器的WebUI主页面点击 **导入用户数据**
![导入用户数据](../image/23.png)
![导入用户数据](../../image/23.png)
6. 选择导出的四个文件,输入数据迁移密钥,点击提交,即可导入用户数据。
![导入数据](../image/24.png)
![导入数据](../../image/24.png)
1. 在游戏中进行数据迁移,方法为[同一服务器不同设备迁移数据](./client_docs#same-server)。

124
docs/zh/dev_guide/WebUI.md Normal file
View 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
```
### 帮助页面
帮助页面如下图所示:
![帮助页面](../../image/webui_help.jpeg)
帮助页面包括服务器的相关介绍和应用的下载和相关配置。
::: 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”。
![帮助页面注意事项](../../image/webui_help_info.png)
3. 如何获取预打补丁的apk安装包和ios安装包请参考
- [Android安装教程](../user_guide/installation/android)
- [iOS安装教程](../user_guide/installation/ios)
:::

View 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-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_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)
:::

View 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)
:::

View 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
```
查看。
:::

View 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
```
查看。
:::

View File

@ -0,0 +1,5 @@
# 介绍
本用户文档对如何搭建和使用 **Love Live! 学园偶像祭2 MIRACLE LIVE!** 的服务器,以及对如何使用其客户端进行说明。
你可以通过本节对该用户文档的内容进行快速浏览。

View 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
```

View File

@ -9,10 +9,10 @@ hero:
actions:
- theme: brand
text: 用户指南
link: /docs/user_guide/client_docs
link: /docs/zh/user_guide/client_docs
- theme: alt
text: 服务器指南
link: /docs/dev_guide/introduction
link: /docs/zh/dev_guide/introduction

View File

@ -0,0 +1,114 @@
---
outline: deep
---
# 游戏内使用说明 {#game-use}
## iOS准备工作 {#ios-prep}
安装应用后需要进行一定的设置才可以进入游戏。
1. 打开手机设置下滑找到APP。
<div style="text-align: center;">
<img src="../../image/10.png" style="height: 600px;" alt="设置"/>
</div>
2. 进入APP下滑找到スクフェス
<div style="text-align: center;">
<img src="../../image/11.png" style="height: 600px;" alt="APP">
</div>
3. 进入スクフェス下滑找到Server URL和Assets URL。
<div style="text-align: center;">
<img src="../../image/12.png" style="height: 600px;" alt="スクフェス2">
</div>
4. 填入服务器网址和资源服务器网址。
::: danger 警告
图片中的Server URL仅作为示例使用时请咨询你的服主具体怎么填写
:::
## 通用操作 {#general-use}
### 下载资源包时发生异常 {#assets-error}
![资源异常](../../image/assets_error.png)
因为Assets URL是国外CDN中国大陆地区的访问链接不是很好
- 有条件的话,可以通过科学上网的方式
- 使用[本地搭建资源服务器](../dev_guide/assets_docs.md)的方式
::: danger 警告
方法2中由于游戏内资源是动态加载的所以切歌等一系列操作如果在非本地环境下仍然会出现此问题
:::
### 查看Sif2 ID {#sif2-id}
1. 在游戏主界面,点击右上角的菜单。
![主界面](../../image/1.png)
2. 点击 **プロフィール**
![菜单界面](../../image/2.png)
3. 页面下方的即为Sif2 ID。
![profile](../../image/3.png)
### 设置数据迁移密钥 {#key}
1. 在游戏主界面,点击右上角的菜单。
![主界面](../../image/1.png)
2. 点击 **データ引き継ぎ**
![菜单](../../image/4.png)
3. 点击 **データ引き継ぎ**
![データ引き継ぎ](../../image/5.png)
4. 上面的 **引き継ぎID** 为数据迁移ID下面的 **パスワード** 即为需要设置的数据迁移密钥。
![引き継ぎID](../../image/6.png)
5. 点击 **次へ** 确定。
### 迁移数据 {#migration}
#### 同一服务器不同设备迁移数据 {#same-server}
1. 确保不同设备使用的服务器为同一服务器。
2. 打开游戏,点击右上角的菜单。
![待机界面](../../image/13.png)
3. 点击 **データ引き継ぎ**
![菜单](../../image/14.png)
4. 点击 **データ引き継ぎ**
![データ引き継ぎ](../../image/15.png)
5. 在上面的 **引き継ぎID** 输入数据迁移ID在下面的 **パスワード** 输入数据迁移密钥。
![引き継ぎID](../../image/16.png)
6. 点击 **次へ** 确定。
#### 跨服迁移数据 {#different-server}
跨服迁移数据需要原服务器开启导出用户数据,目标服务器开启导入用户数据。具体操作如下:
[跨服迁移数据](./user_webui#different-server)
### 游戏数据清除
::: danger 警告
以下操作会使游戏数据初始化,会使游戏账号丢失。请谨慎操作。
:::
1. 打开游戏,点击右上角的菜单。
![待机界面](../../image/13.png)
2. 点击 **ゲームデータ削除**
![菜单](../../image/25.png)
3. 点击 **OK**
![ゲームデータ削除](../../image/26.png)
### 获得Loveca、金币等道具的方式 {#gift}
1. 在游戏主界面,点击右上角的菜单。
![主界面](../../image/1.png)
2. 点击 **シリアルコード**
![菜单](../../image/7.png)
3. 点击 **シリアルコード入力**
![シリアルコード](../../image/8.png)
4. 输入兑换码点击OK即可兑换。
![シリアルコード入力](../../image/9.png)
::: tip 注意
兑换码格式为兑换码种类+数量,例如:
coins5000表示兑换5000金币。
:::
::: danger 注意
输入任何兑换码后,兑换完成显示的图标均为金币图标。
:::
#### 兑换码详情 {#gift-info}
- coins金币。
- gemsLoveca。
- training课程笔记和技能书
- UR活动UR。
- PT招募pt。

View File

@ -0,0 +1,31 @@
---
outline: deep
---
# 游戏相关信息
本页面提供了游戏的相关信息,以供参考。
## 游戏开服时间和停服时间
- 日服:
**开服时间** 2023年4月15日
**停服时间** 2024年3月31日
- 国际服:
**开服时间** 2024年2月1日
**停服时间** 2024年5月31日
## 游戏活动列表
游戏活动的开始和结束时间可以参考[LLwiki](https://llwiki.org/zh/LoveLive!%E5%AD%A6%E5%9B%AD%E5%81%B6%E5%83%8F%E7%A5%AD2_MIRACLE_LIVE!%E6%B4%BB%E5%8A%A8%E5%88%97%E8%A1%A8)。
## 生日招募一览
生日招募的开始时间和结束时间可以参考[ラブライブスクールアイドルフェスティバル2 MIRACLE LIVE攻略Wiki](https://gamerch.com/lovelivesif2/808233#outline__%E8%AA%95%E7%94%9F%E6%97%A5%E5%8B%A7%E8%AA%98%E4%B8%80%E8%A6%A7)该时间为东京时间GMT+9
## 其他查卡器网站
- [wazzia](https://sif2.wazzia.com)
- [idol.st](https://idol.st)
- [LLwiki](https://llwiki.org/zh/LoveLive!%E5%AD%A6%E5%9B%AD%E5%81%B6%E5%83%8F%E7%A5%AD2_MIRACLE_LIVE!%E5%8D%A1%E7%89%8C%E5%88%97%E8%A1%A8)

View File

@ -0,0 +1,47 @@
---
outline: deep
---
# Android
本节介绍如何在Android上安装sif2。
:::tip 注意
服主为方便国内群侑游玩已建立了私服可免去后续所有操作需要加QQ群671605906。
:::
### 获取原版游戏安装包(可选)
你需要先获取原版的游戏安装包,你可以从下面的链接中获取原版的游戏安装包。
- [国际服](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. 将Server URL输入到API URL中。
4. 将资源服务器URL输入到Assets URL中一个可选的资源服务器为https://sif2.sif.moe 。
5. 选择游戏版本。
6. 更改头部格式Header format为Lowercase。
7. 点击修补Patch
8. 下载修补好的安装包文件。
:::tip 注意
Server URL的获取请咨询服主
:::
![patch](../../../image/27.png)
### 给修补好的安装包文件签名
使用[uber-apk-signer](https://github.com/patrickfav/uber-apk-signer/releases/download/v1.3.0/uber-apk-signer-1.3.0.jar)给安装包签名。
1. 安装[JDK8+](https://adoptium.net/temurin/releases/)
![JDK](../../../image/32.png)
```shell
java -jar uber-apk-signer-1.3.0.jar --apks sif2_patched.apk
```
:::tip 注意
jar和apk路径位置请根据自己的情况修改
:::
![打包](../../../image/33.png)
### 传入手机安装
基本操作,不展开说明

View File

@ -0,0 +1,49 @@
---
outline: deep
---
# iOS
本节介绍如何在iOS上安装sif2。
:::danger 警告
目前已知仅iPhone11数字型号无法打开游戏内设置窗口导致体验不佳请使用此设备的玩家慎重考虑
:::
:::tip 注意
使用自己的id自签每7天需要重新签名安装。
当提示APP不可用时切忌删除APP一旦误删则数据丢失产生的后果由用户自己承担。
服主为方便国内群侑游玩已建立了私服需要加QQ群671605906。
服主提供开发者超级签服务每个设备10rmb可一年内免复签操作需要加QQ群765206475。
:::
### 安装包下载
得益于Discord的Triangle你只需下载对应的ipa文件然后将该ipa文件侧载安装手机上即可。
- [国际服](https://arasfon.ru/direct/lovelive/sif2/patched-clients/ios/sif2_gl.ipa)
- [日服](https://arasfon.ru/direct/lovelive/sif2/patched-clients/ios/sif2_jp.ipa)
:::tip 注意
下面的安装以日服为例
:::
### 使用SideloadlyIOS17+使用——7天需电脑重新签名 推荐
[下载地址](https://sideloadly.io/)
1. 按照电脑平台选择下载链接。
![Sideloadly URL](../../../image/30.png)
2. 打开Sideloadly
![安装](../../../image/31.png)
- Step1拖入准备好的ipa文件。
- Step2使用USB连接苹果设备。
- Step3输入你的苹果ID。
- Step4打开高级选项可选
- Step5如果设备中存在官服Sif2 APP这里需要填写一个与官服包名相异的字符串这里推荐使用。
```markdown
com.bushiroad.lovelive.sif2
```
- Step6点击Start执行安装。
### 使用巨魔商店IOS17-使用) 推荐
待补充
### 使用SideStoreIOS17+使用——7天手机自动续签
目前SideStore部分手机不可用bug较多暂不对应教程可自行研究。

View File

@ -0,0 +1,51 @@
---
outline: deep
---
# WebUI使用说明 {#WebUI-operation}
## 进入WebUI {#enter-WebUI}
1. 确保服务器已开启WebUI是否开启可询问服主
2. 使用服主提供的服务器网址即可进入WebUI。
## WebUI使用 {#WebUI-use}
### 主界面 {#main-interface }
WebUI的界面如下图所示
![WebUI](../../image/17.png)
其中包括个人账户登录和导入用户数据和查看帮助等相关信息。
### 个人账户登录 {#account-login}
在主页面输入[SIF2 ID](./client_docs.md#sif2-id)和[数据迁移密钥](./client_docs.md#key)即可登录到个人账户设置页面。界面如下图所示:
![WebUI_user](../../image/18.png)
### 更改登录奖励 {#login-bonus}
在WebUI个人设置界面的 **当前登录奖励列表** 中添加登录奖励的id即可登录奖励id的信息请自行查阅。
![登录奖励](../../image/19.png)
### 更改游戏服务器时间 {#server-time}
在WebUI个人设置界面的 **服务器时间** 中输入时间,即可更改服务器时间,跳转到指定活动或卡池。
![服务器时间](../../image/20.png)
服务器时间的格式为yyyy/MM/dd HH:mm:ss。
例如输入2023/12/01 22:30:30表示服务器时间更改为2023年12月1日23时30分30秒。
::: tip 注意
服务器时间可以只输入到日期这时默认为该日期0时0分0秒。
时间的输入请使用24小时制。
活动及卡池信息请自行在wiki查找。
:::
### 跨服迁移数据 {#different-server}
1. 确保服务器开启了 **WebUI**、**导出用户数据** 和 **导入用户数据**
2. 在导出服务器上进入个人账户设置界面。
3. 在导出服务器上的个人账户设置界面点击右上角的 **导出用户数据**
![导出用户数据](../../image/21.png)
4. 你会获得四个文件,这四个文件即为用户数据文件。
![用户数据文件](../../image/22.png)
5. 在导入服务器的WebUI主页面点击 **导入用户数据**
![导入用户数据](../../image/23.png)
6. 选择导出的四个文件,输入数据迁移密钥,点击提交,即可导入用户数据。
![导入数据](../../image/24.png)
1. 在游戏中进行数据迁移,方法为[同一服务器不同设备迁移数据](./client_docs#same-server)。

View File

@ -1,4 +1,5 @@
{
"type": "module",
"scripts": {
"docs:dev": "vitepress dev",
"docs:build": "vitepress build",

BIN
public/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

1167
yarn.lock Normal file

File diff suppressed because it is too large Load Diff