Skip to content

Commit

Permalink
docs: add chinese readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Clazex committed Oct 13, 2021
1 parent 1726f8e commit 9b93ad6
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 17 deletions.
1 change: 1 addition & 0 deletions GodSeekerPlus.sln
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
.gitignore = .gitignore
CHANGELOG.md = CHANGELOG.md
README.md = README.md
README.zh.md = README.zh.md
EndProjectSection
EndProject
Global
Expand Down
22 changes: 5 additions & 17 deletions GodSeekerPlus/GodSeekerPlus.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -43,27 +43,15 @@
</Reference>
</ItemGroup>

<Target
Name="CopyMod"
AfterTargets="PostBuildEvent">
<Copy
SourceFiles="$(TargetPath);$(TargetDir)$(TargetName).pdb;$(SolutionDir)/README.md;$(SolutionDir)/LICENSE"
DestinationFolder="$(HollowKnightRefs)/Mods/$(TargetName)"
SkipUnchangedFiles="true" />
<Target Name="CopyMod" AfterTargets="PostBuildEvent">
<Copy SourceFiles="$(TargetPath);$(TargetDir)$(TargetName).pdb;$(SolutionDir)/README.md;$(SolutionDir)/README.zh.md;$(SolutionDir)/LICENSE" DestinationFolder="$(HollowKnightRefs)/Mods/$(TargetName)" SkipUnchangedFiles="true" />
</Target>

<Target
Name="CreateReleaseZip"
AfterTargets="PostBuildEvent"
Condition="'$(Configuration)' == 'Release'">
<Target Name="CreateReleaseZip" AfterTargets="PostBuildEvent" Condition="'$(Configuration)' == 'Release'">
<RemoveDir Directories="$(ProjectDir)/dist" />
<MakeDir Directories="$(ProjectDir)/dist/tmp" />
<Copy
SourceFiles="$(TargetPath);$(TargetDir)$(TargetName).pdb;$(SolutionDir)/README.md;$(SolutionDir)/LICENSE"
DestinationFolder="$(ProjectDir)/dist/tmp" />
<ZipDirectory
DestinationFile="$(ProjectDir)/dist/$(TargetName)-v$(Version).zip"
SourceDirectory="$(ProjectDir)/dist/tmp" />
<Copy SourceFiles="$(TargetPath);$(TargetDir)$(TargetName).pdb;$(SolutionDir)/README.md;$(SolutionDir)/README.zh.md;$(SolutionDir)/LICENSE" DestinationFolder="$(ProjectDir)/dist/tmp" />
<ZipDirectory DestinationFile="$(ProjectDir)/dist/$(TargetName)-v$(Version).zip" SourceDirectory="$(ProjectDir)/dist/tmp" />
<RemoveDir Directories="$(ProjectDir)/dist/tmp" />
</Target>
</Project>
27 changes: 27 additions & 0 deletions README.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# [寻神者+](https://github.com/Clazex/HollowKnight.GodSeekerPlus)

一个提升神居体验的《空洞骑士》模组

适用于 `空洞骑士` 1.5。
**需要 `Vasi`**

## 功能

- **无忧旋律修复**:移除在装备非正常途径获得的无忧旋律时错误生成的格林之子。效果是永久的。
- **快速梦门传送**:当在神居 Boss 战房间中时,移除梦之门传送充能时间。这将总传送时间从 2.25 秒减少到 0.25 秒。
- **快速超级冲刺**:提升在诸神堂中的超级冲刺速度。
- **帧率限制**:在游戏内的每帧添加卡顿。

## 配置

- `carefreeMelodyFix` (`Boolean`):是否启用 `无忧旋律修复` 功能。默认为 `true`
- `fastDreamWarp` (`Boolean`):是否启用 `快速梦门传送` 功能。默认为 `true`
- `fastSuperDash` (`Boolean`):是否启用 `快速超级冲刺` 功能。默认为 `true`
- `fastSuperDashSpeedMultiplier` (`Float`):快速超冲速度倍率。范围从 `1``2`,默认为 `1.5`
- `frameRateLimit` (`Boolean`):是否启用 `帧率限制` 功能。默认为 `false`
- `frameRateLimitMultiplier` (`Integer`):帧率限制卡顿时间倍率。最终卡顿时间是 10ms 乘以这个值。注意将其设置为 `0` 并不意味着零卡顿。范围从 `0``10`,默认为 `5`

## 贡献

1. 克隆存储库
2. 将环境变量 `HollowKnightRefs` 设置为游戏文件中的 `Managed` 文件夹

0 comments on commit 9b93ad6

Please sign in to comment.