Merge pull request #35 from YYHEggEgg/development

v1.0.1 Stable Merge

Author: YYHEggEgg

.github/ISSUE_TEMPLATE/1_server_issue.md

@@ -33,8 +33,8 @@ Note: Asking in English can make your problem more widely known by the community
 - [ ] I have browsed various Issue templates and confirmed that the current template is suitable for my problem
 - [ ] I confirm that the issue I raised is related to the Protoshift server itself (and not dependent on other factors)
 - [ ] I have run the building process properly
-- [ ] I have attached necessary log records in the issue (you can also send them to `mihomo-technology@outlook.com`, making it disclosed after removing sensitive information). I also attached the necessary content of `latest.errtrace.log` (if an exception occurs).
-- [ ] I confirm that I have not included `latest.packet.log` in the main body of the issue, or it has removed `GetPlayerTokenReq(Rsp)`, `PlayerLoginReq(Rsp)` (to avoid leaking private information).
+- [ ] I have attached necessary log records in the issue (you can also send them to `mihomo-technology@outlook.com`, making it disclosed after removing sensitive information). I also attached the necessary content of `latest.errtrace.log` (if an exception occurs)
+- [ ] I confirm that the logs I have included in the body of the issue are not leaking my private information
 - [ ] I confirm that the phenomenon is unrelated to the defects of my server (the real game server)
 - [ ] **I am not running the server on any version of macOS, nor am I running the game client on iOS**
 
@@ -63,7 +63,7 @@ Note: Asking in English can make your problem more widely known by the community
 - [ ] 我已浏览过多种 Issue 模板并确认当前模板适合我的问题
 - [ ] 我确认提出的 issue 与 Protoshift 服务器本身有关（而不取决于其他因素）
 - [ ] 我正确运行了生成
-- [ ] 我已在 issue 中附带必要的日志记录（也可发送至 `mihomo-technology@outlook.com`，去除敏感信息后的部分将被公开）。我还附带了 `latest.errtrace.log` 的必要内容（如果有发生异常）。
-- [ ] 我确认没有将 `latest.packet.log` 包含在 issue 主体中，或其去除了 `GetPlayerTokenReq(Rsp)`, `PlayerLoginReq(Rsp)`（以避免泄露隐私信息）。
+- [ ] 我已在 issue 中附带必要的日志记录（也可发送至 `mihomo-technology@outlook.com`，去除敏感信息后的部分将被公开）。我还附带了 `latest.errtrace.log` 的必要内容（如果有发生异常）
+- [ ] 我确认在 issue 主体中附带的日志没有泄露隐私信息
 - [ ] 我确认现象与我的服务器（真正的游戏服务器）的本身缺陷无关
 - [ ] **我并非在 macOS 的任何版本上运行服务器，也并非在 iOS 上运行游戏客户端**

.github/ISSUE_TEMPLATE/2_windy_issue.md

@@ -32,7 +32,7 @@ Note: Asking in English can make your problem more widely known by the community
 - [ ] I have browsed various Issue templates and confirmed that the current template is suitable for my problem
 - [ ] I confirm that the issue I raised is related to Windy (and not dependent on other factors)
 - [ ] I have attached necessary log records in the issue (you can also send them to `mihomo-technology@outlook.com`, making it disclosed after removing sensitive information). I also attached the necessary content of `latest.errtrace.log` (if an exception occurs).
-- [ ] I used [the luac compiler provided in the repository](https://github.com/YYHEggEgg/csharp-Protoshift/tree/main/csharp-Protoshift/resources/luac_bins) or a compiler that can be proven to be compatible with the anime     game
+- [ ] I used [the luac compiler provided in the repository](https://github.com/YYHEggEgg/csharp-Protoshift/tree/main/csharp-Protoshift/resources/luac_bins) or another compiler that can be proven to be compatible with the anime game
 - [ ] I confirm that the lua script itself complies with `Lua 5.3.5` syntax, and does not include operations that `xlua` may prohibit, such as reading files (required by import modules)
 - [ ] **I am not running the server on any version of macOS, nor am I running the game client on iOS**
 
@@ -64,6 +64,6 @@ Note: Asking in English can make your problem more widely known by the community
 - [ ] 我已浏览过多种 Issue 模板并确认当前模板适合我的问题
 - [ ] 我确认提出的 issue 与 Windy 有关（而不取决于其他因素）
 - [ ] 我已在 issue 中附带必要的日志记录（也可发送至 `mihomo-technology@outlook.com`，去除敏感信息后的部分将被公开）。我还附带了 `latest.errtrace.log` 的必要内容（如果有发生异常）。
-- [ ] 我使用 [存储库中打包提供的 luac 编译器](https://github.com/YYHEggEgg/csharp-Protoshift/tree/main/csharp-Protoshift/resources/luac_bins) 或可证明与某二游相兼容的编译器
+- [ ] 我使用 [存储库中打包提供的 luac 编译器](https://github.com/YYHEggEgg/csharp-Protoshift/tree/main/csharp-Protoshift/resources/luac_bins) 或可证明与某二游相兼容的其他编译器
 - [ ] 我确认 lua 脚本本身符合 `Lua 5.3.5` 的语法，并且不包含读取文件（如 import 模块）等 `xlua` 可能禁止的操作
 - [ ] **我并非在 macOS 的任何版本上运行服务器，也并非在 iOS 上运行游戏客户端**

.github/ISSUE_TEMPLATE/4_skill_issue.md

@@ -38,7 +38,7 @@ Note: Asking in English can make your problem more widely known by the community
 - [ ] I have browsed various Issue templates and confirmed that the current template is suitable for my problem
 - [ ] I am using the Protobuf provided by the official build and ran the generation correctly
 - [ ] I have attached necessary log records in the issue (you can also send them to `mihomo-technology@outlook.com`, making it disclosed after removing sensitive information). I also attached the necessary content of `latest.errtrace.log` (if an exception occurs in the log).
-- [ ] I confirm that I have not included `latest.packet.log` in the main body of the issue, or it has removed `GetPlayerTokenReq(Rsp)`, `PlayerLoginReq(Rsp)` (to avoid leaking private information).
+- [ ] I confirm that the logs I have included in the body of the issue are not leaking my private information
 - [ ] I confirm that the phenomenon is unrelated to the defects of my server (the real game server)
 - [ ] I confirm that the phenomenon can be removed from any external factors (such as Windy, cheats, specific GM commands, or custom server data), or I have publicly disclosed these external deployment methods in the main body of the issue
 - [ ] **I am not running the server on any version of macOS, nor am I running the game client on iOS**
@@ -72,8 +72,8 @@ Note: Asking in English can make your problem more widely known by the community
 - [ ] 我已在 issue 区寻找过相关的问题但未得到解决
 - [ ] 我已浏览过多种 Issue 模板并确认当前模板适合我的问题
 - [ ] 我正使用官方 build 提供的 Protobuf 并且正确运行了生成
-- [ ] 我已在 issue 中附带必要的日志记录也可发送至 `mihomo-technology@outlook.com`，去除敏感信息后的部分将被公开）。我还附带了 `latest.errtrace.log` 的必要内容（如果日志中有发生异常）。
-- [ ] 我确认没有将 `latest.packet.log` 包含在 issue 主体中，或其去除了 `GetPlayerTokenReq(Rsp)`, `PlayerLoginReq(Rsp)`（以避免泄露隐私信息）。
+- [ ] 我已在 issue 中附带必要的日志记录（也可发送至 `mihomo-technology@outlook.com`，去除敏感信息后的部分将被公开）。我还附带了 `latest.errtrace.log` 的必要内容（如果日志中有发生异常）。
+- [ ] 我确认在 issue 主体中附带的日志没有泄露隐私信息
 - [ ] 我确认现象与我的服务器（真正的游戏服务器）的本身缺陷无关
 - [ ] 我确认现象可以在去除任何外置因素（如 Windy、外挂、特定 GM 命令、或定制版服务器等），或我已在 issue 主体中公开这些外置与部署方法
 - [ ] **我并非在 macOS 的任何版本上运行服务器，也并非在 iOS 上运行游戏客户端**

.github/ISSUE_TEMPLATE/5_optimition_request.md

@@ -21,9 +21,7 @@ Note: Asking in English can make your problem more widely known by the community
 ## Requested Optimization Scheme
 
 - [ ] I have a feasible plan for optimizing the maintainability of the existing code
-- [ ] I want to make Protoshift or HandlerGenerator support new features to make it easier to use
-- [ ] I believe that the Protoshift server needs and can perform JIT compilation of all Handlers at startup
-- [ ] I want to contribute to text localization solutions
+- [ ] I want to make Protoshift or HandlerGenerator (builder) support new features to make it easier to use
 - [ ] I want Windy to automatically run with more complex logic
 - [ ] I intend to promote smarter UDP packet (KCP handshake packet) forwarding, rate control and other network optimization schemes
 - [ ] I believe that ProtoHotPatch can introduce more complex process control (such as directly introducing external processing code at runtime) or relax restrictions (the existing restriction is that only Protos with unrecognized fields can perform ProtoHotPatch)
@@ -35,7 +33,6 @@ Note: Asking in English can make your problem more widely known by the community
 
 - [ ] I have browsed various Issue templates and confirmed that the current template is suitable for my problem
 - [ ] I confirm that the requirement is an improvement rather than a bug fix
-- [ ] I confirm that it will not reduce the availability of the Protoshift server
 - [ ] I confirm that the phenomenon can be removed from any external factors (such as Windy, cheats, specific GM commands, or custom server data), or I have publicly disclosed these external and deployment methods in the main body of the issue
 - [ ] If the text proposes a specific implementation, I confirm that it can be used cross-platform
 
@@ -52,9 +49,7 @@ Note: Asking in English can make your problem more widely known by the community
 ## 请求的优化方案
 
 - [ ] 我有对于现有代码可维护性优化的可行方案
-- [ ] 我想使 Protoshift 或 HandlerGenerator 支持新功能以使其更易于使用
-- [ ] 我认为 Protoshift 服务器有必要并且可以做到在启动时执行全部 Handler 的 JIT 编译
-- [ ] 我想贡献文本本地化方案
+- [ ] 我想使 Protoshift 或 HandlerGenerator（构建程序）支持新功能以使其更易于使用
 - [ ] 我想要 Windy 自动化运行带有更复杂的逻辑
 - [ ] 我意图推行更智能的 UDP 包（KCP 握手包）转发、速率控制等网络优化方案
 - [ ] 我认为 ProtoHotPatch 可以引入更复杂的流程控制（例如直接运行时引入外部处理代码）或放宽限制（现有限制为只有具有未识别字段的 Proto 才可进行 ProtoHotPatch）
@@ -66,6 +61,5 @@ Note: Asking in English can make your problem more widely known by the community
 
 - [ ] 我已浏览过多种 Issue 模板并确认当前模板适合我的问题
 - [ ] 我确认需求的是一个改进而不是一种针对 bug 的修复
-- [ ] 我确认其不会降低 Protoshift 服务器的可用性
 - [ ] 我确认现象可以在去除任何外置因素（如 Windy、外挂、特定 GM 命令、或定制版服务器等），或我已在 issue 主体中公开这些外置与部署方法
 - [ ] 如果正文提出了具体实现，我确认其可以跨平台使用

.github/ISSUE_TEMPLATE/6_other_issues.md

@@ -27,9 +27,9 @@ Note: Asking in English can make your problem more widely known by the community
 
 - [ ] I have searched for related issues in the issue area but have not resolved them
 - [ ] I have browsed various Issue templates and confirmed that the current template is suitable for my problem
-- [ ] I am using the Protobuf provided by the official build and ran the generation correctly
+- [ ] I am using the default Protobuf source and ran the build correctly
 - [ ] I have attached necessary log records in the issue (you can also send them to `mihomo-technology@outlook.com`, making it disclosed after removing sensitive information). I also attached the necessary content of `latest.errtrace.log` (if an exception occurs in the log).
-- [ ] I confirm that I have not included `latest.packet.log` in the main body of the issue, or it has removed `GetPlayerTokenReq(Rsp)`, `PlayerLoginReq(Rsp)` (to avoid leaking private information).
+- [ ] I confirm that the logs I have included in the body of the issue are not leaking my private information
 - [ ] I confirm that the phenomenon is unrelated to the defects of my server (the real game server)
 - [ ] I confirm that the phenomenon can be removed from any external factors (such as Windy, cheats, specific GM commands, or custom server data), or I have publicly disclosed these external and deployment methods in the main body of the issue
 - [ ] **I am not running the server on any version of macOS, nor am I running the game client on iOS**
@@ -55,9 +55,9 @@ Note: Asking in English can make your problem more widely known by the community
 
 - [ ] 我已在 issue 区寻找过相关的问题但未得到解决
 - [ ] 我已浏览过多种 Issue 模板并确认当前模板适合我的问题
-- [ ] 我正使用官方 build 提供的 Protobuf 并且正确运行了生成
+- [ ] 我正使用默认提供的 Protobuf 并且正确运行了构建
 - [ ] 我已在 issue 中附带必要的日志记录（也可发送至 `mihomo-technology@outlook.com`，去除敏感信息后的部分将被公开）。我还附带了 `latest.errtrace.log` 的必要内容（如果日志中有发生异常）。
-- [ ] 我确认没有将 `latest.packet.log` 包含在 issue 主体中，或其去除了 `GetPlayerTokenReq(Rsp)`, `PlayerLoginReq(Rsp)`（以避免泄露隐私信息）。
+- [ ] 我确认在 issue 主体中附带的日志没有泄露隐私信息
 - [ ] 我确认现象与我的服务器（真正的游戏服务器）的本身缺陷无关
 - [ ] 我确认现象可以在去除任何外置因素（如 Windy、外挂、特定 GM 命令、或定制版服务器等），或我已在 issue 主体中公开这些外置与部署方法
 - [ ] **我并非在 macOS 的任何版本上运行服务器，也并非在 iOS 上运行游戏客户端**

.github/ISSUE_TEMPLATE/config.yml

@@ -6,9 +6,9 @@ contact_links:
   - name: Fix Proto skill issue
     about: Create a pull request to the outer protos repo
     url: https://github.com/YYHEggEgg/mihomo-protos/pulls
-  - name: Basic FAQs
-    about: View the Wiki
-    url: https://github.com/YYHEggEgg/csharp-Protoshift/wiki
-  - name: Get Help and Using Practices
+  - name: Get basic FAQs and Using Practices
+    about: Visit our official blog
+    url: https://yyheggegg.github.io/mihomo-gio-blogs/
+  - name: Ask for help
     about: Join Discord to get more information
-    url: https://discord.gg/3XkT93zsNy
+    url: https://discord.gg/3XkT93zsNy

.gitignore

@@ -13,7 +13,8 @@
 /csharp-Protoshift/resources/protobuf
 /csharp-Protoshift/resources/windy_scripts
 /csharp-Protoshift/skillissue_fix_config.json
-/csharp-Protoshift/windy_config.json
+/csharp-Protoshift/XC.RSAUtil/bin
+/csharp-Protoshift/XC.RSAUtil/obj
 
 # Builder
 /HandlerGenerator/.vscode
@@ -50,11 +51,13 @@
 /ProtoshiftHandlers/Generated
 /ProtoshiftHandlers/ProtoDispatch
 
-# Other Projects
-/CSharp-Logger/bin
-/CSharp-Logger/obj
-/XC.RSAUtil/bin
-/XC.RSAUtil/obj
+# Other Deprecated Projects
+/CSharp-Logger
+/csharp-Protoshift-Replay
+/KcpCsharpTest
+/KcpTests
+/ProtoshiftBenchmark
+/XC.RSAUtil
 
 # Kcp Implement
 /KCP/Image
@@ -68,11 +71,10 @@
 /KCP/OpenSource.snk
 
 # Tests Projects
-# Replay Debugger
+## Replay Debugger
 /Tests/csharp-Protoshift-Replay/bin
 /Tests/csharp-Protoshift-Replay/obj
 /Tests/csharp-Protoshift-Replay/logs
-
 ## KCP Tests
 /Tests/KcpCsharpTest
 /Tests/KcpTestClient
@@ -85,7 +87,6 @@
 /Tests/KcpTests/SharedLib/obj
 /Tests/KcpTests/SharedLib/logs
 /Tests/KcpTestServer
-
 ## Benchmark
 /Tests/ProtoshiftBenchmark/bin
 /Tests/ProtoshiftBenchmark/BenchmarkDotNet.Artifacts

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/wiki"]
+	path = docs/wiki
+	url = https://github.com/YYHEggEgg/csharp-Protoshift.wiki.git