diff --git a/.github/ISSUE_TEMPLATE/BugReport_en.yaml b/.github/ISSUE_TEMPLATE/BugReport_en.yaml index acff4e0..c7888f6 100644 --- a/.github/ISSUE_TEMPLATE/BugReport_en.yaml +++ b/.github/ISSUE_TEMPLATE/BugReport_en.yaml @@ -1,48 +1,65 @@ -name: Bug Report -description: File a bug report -title: "[Bug]:" -labels: [Bug] -assignees: - - Slok7565 +name: "🐛 Report a Bug" +title: "[Bug] " +description: Submit an issue report to help us improve. +labels: ["bug"] body: - type: checkboxes attributes: - label: Prerequisites - description: Thank you for taking the time to fill out this issue report! Before you begin, you will need to confirm the following. + label: Checklist options: - - label: I am using the latest version of FinalSuspect. + - label: I am using the latest version of Final Suspect. required: true - - label: This is an issue with the FinalSuspect project itself. + - label: Final Suspect is incompatible with any other mods, and I confirm that I have not installed any other mods alongside Final Suspect. required: true - - type: markdown + - label: I have searched the [Issue list](https://github.com/Slok7565/FinalSuspect/issues) for related issues and still cannot resolve my problem, or this issue has never been reported before. + required: true + - label: I have read and agree to this project's [Contributor Code of Conduct](https://github.com/Slok7565/FinalSuspect/blob/FinalSus/CODE_OF_CONDUCT.md). + required: true + + - type: textarea attributes: - value: "## Details" + label: Problem Description + description: What happened? + placeholder: Clearly and specifically describe what happened or what problem you encountered. + validations: + required: true + - type: textarea attributes: - label: "What happened?" - description: "For ease of management, please do not report multiple unrelated issues under the same issue." + label: How to Reproduce? + description: Steps to reproduce the issue. + placeholder: | + For example: + 1. Open ... + 2. Click ... + 3. Issue reproduced validations: required: true - - type: dropdown + + - type: input attributes: - label: What is the frequency of recurrence for this issue? - options: - - The issue can be consistently reproduced. - - The issue is reproducible, but the probability is not 100%. - - The probability of this issue recurring depends on the user's device. - - I don't know. + label: Final Suspect Version + description: The version of Final Suspect in which the issue occurred. Please do not use meaningless values such as `latest`. validations: required: true + - type: textarea attributes: - label: "Reproduce Steps" - description: "If it can be consistently reproduced, please provide detailed steps.
Even if it cannot be consistently reproduced, please still provide the steps of how you discovered it." - - type: textarea + label: Error Logs + description: Debug-level logs related to the issue. Issues without valid logs will be closed. Thank you for your understanding. + render: text + validations: + required: true + + - type: upload attributes: - label: "Relevant log output" - description: "Open the game settings to export logs, then copy the exported FinalSuspect logs and paste them here." - render: shell - - type: textarea + label: Additional Information + description: | + Other supporting materials related to the issue, such as a reproduction video or the complete log file. Please upload images in the Problem Description section.
+ If your logs are too long to paste directly into the field above, you may paste only the key log entries there and upload the complete log file here. + validations: + accept: ".txt,.log,.mp4,.mov,.webm,.zip,.gz" + + - type: markdown attributes: - label: "Additional information" - description: "If you have other information to note, you can fill it in here." + value: "Finally, thank you for taking the time to report this issue!" diff --git a/.github/ISSUE_TEMPLATE/BugReport_zh.yaml b/.github/ISSUE_TEMPLATE/BugReport_zh.yaml index d98a96e..7b884b5 100644 --- a/.github/ISSUE_TEMPLATE/BugReport_zh.yaml +++ b/.github/ISSUE_TEMPLATE/BugReport_zh.yaml @@ -1,48 +1,65 @@ -name: Bug 反馈 -description: 提交 Bug 反馈 -title: "[Bug]:" -labels: [Bug] -assignees: - - Slok7565 +name: "🐛 报告 Bug" +title: "[Bug] " +description: 提交问题报告以帮助我们改进。 +labels: ["bug"] body: - type: checkboxes attributes: - label: 前置条件 - description: 感谢你花时间填写此错误报告！在开始之前，您需要确认以下内容。 + label: 检查清单 options: - - label: 您使用的是最新版本的FinalSuspect。 + - label: 我使用的是最新版本的 Final Suspect。 required: true - - label: 这是FinalSusepct本身存在的问题。 + - label: Final Suspect 不兼容其它任何模组，我确认我没有在安装 Final Suspect 的同时安装了其它任何模组。 required: true - - type: markdown + - label: 我已在 [Issue 列表](https://github.com/Slok7565/FinalSuspect/issues)中搜索过相关问题仍无法解决，或该问题从未被报告过。 + required: true + - label: 我已阅读并同意本项目的[贡献者行为准则](https://github.com/Slok7565/FinalSuspect/blob/FinalSus/CODE_OF_CONDUCT.md)。 + required: true + + - type: textarea attributes: - value: "## 详细信息" + label: 问题描述 + description: 发生了什么？ + placeholder: 清晰且具体的描述发生了什么，或遇到了什么问题。 + validations: + required: true + - type: textarea attributes: - label: "发生了什么？" - description: "为了方便我们管理，请不要在同一个issue报告多个问题。" + label: 如何复现？ + description: 复现该问题的步骤。 + placeholder: | + 例如: + 1. 打开 ... + 2. 点击 ... + 3. 问题复现 validations: required: true - - type: dropdown + + - type: input attributes: - label: 该问题的复现频率是? - options: - - 该问题可以稳定复现。 - - 该问题可以复现，但概率并非100%。 - - 问题复现概率的取决于用户设备或环境。 - - 我不知道。 + label: Final Suspect 版本 + description: 发生问题的 Final Suspect 版本。请勿使用诸如 `latest` 之类的无意义值。 validations: required: true + - type: textarea attributes: - label: "该问题的复现步骤是?" - description: "如果可以稳定复现，请提供详细的步骤。
即使无法稳定复现，也请提供你是如何发现的步骤。" - - type: textarea + label: 错误日志 + description: 与问题相关的 Debug 级别的日志。没有有效日志的 Issue 将被关闭，谢谢理解。 + render: text + validations: + required: true + + - type: upload attributes: - label: "相关日志输出" - description: "打开游戏设置导出日志，将导出FinalSuspect日志复制并将其粘贴至此处。\n你也可以通过该[网站](https://finalsuspect.pages.dev/FinalSuspect/Guide/OutputLog)查看如何导出日志。" - render: shell - - type: textarea + label: 辅助信息 + description: | + 与问题相关的其他辅助信息，例如复现视频、完整日志文件。图片请在问题描述中上传。
+ 如果您要提供的日志过长以至不适合直接填写到上一栏，您可以选择只在上一栏贴关键日志，将完整的日志文件上传到这里。 + validations: + accept: ".txt,.log,.mp4,.mov,.webm,.zip,.gz" + + - type: markdown attributes: - label: "附加信息" - description: "如果你还有其他需要提供的信息，可以在这里填写。" + value: "最后，感谢您抽出时间报告问题！" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/FeatureRequest_en.yaml b/.github/ISSUE_TEMPLATE/FeatureRequest_en.yaml index 1bad9ee..c209700 100644 --- a/.github/ISSUE_TEMPLATE/FeatureRequest_en.yaml +++ b/.github/ISSUE_TEMPLATE/FeatureRequest_en.yaml @@ -1,31 +1,29 @@ -name: Feature Request -description: File a feature request -title: "[Feat]:" -labels: [Considered] -assignees: - - Slok7565 +name: "🎉 Feature Suggestion" +title: "[Feature] " +description: Submit a new feature idea or suggestion to us. +labels: ["Considered"] body: - type: checkboxes - id: preface attributes: - label: Prerequisites - description: Hello! Thank you for submitting a new feature suggestion for FinalSuspect. Before we begin, we highly recommend reading through the [Open Source Guides](https://opensource.guide/), which will greatly improve our mutual efficiency. + label: Checklist options: - - label: I am using the latest version of FinalSuspect. + - label: I have searched the [Issue list](https://github.com/Slok7565/FinalSuspect/issues) for related features and confirmed that this feature idea has never been proposed before. required: true - - type: markdown - id: details - attributes: - value: "## Details" + - label: I have read and agree to this project's [Contributor Code of Conduct](https://github.com/Slok7565/FinalSuspect/blob/FinalSus/CODE_OF_CONDUCT.md). + required: true + - type: textarea - id: description attributes: - label: "Describe this feature" - description: "For ease of management, please do not submit multiple unrelated features under the same issue." + label: Feature Description + placeholder: Describe in detail the feature you would like to see added. validations: required: true + - type: textarea - id: additional-information attributes: - label: "Additional information" - description: "If you have other information to note, you can fill it in here." + label: Use Case + placeholder: Describe the use case for the feature you are suggesting. + + - type: markdown + attributes: + value: "Thank you for submitting your valuable idea to us!" diff --git a/.github/ISSUE_TEMPLATE/FeatureRequest_zh.yaml b/.github/ISSUE_TEMPLATE/FeatureRequest_zh.yaml index 51f8f62..9c3c178 100644 --- a/.github/ISSUE_TEMPLATE/FeatureRequest_zh.yaml +++ b/.github/ISSUE_TEMPLATE/FeatureRequest_zh.yaml @@ -1,31 +1,29 @@ -name: 新功能建议 -description: 提交新功能或原功能优化建议 -title: "[Feat]:" -labels: [Considered] -assignees: - - Slok7565 +name: "🎉 功能建议" +title: "[Feature] " +description: 向我们提交一个新的功能想法或建议。 +labels: ["Considered"] body: - type: checkboxes - id: preface attributes: - label: 前置条件 - description: 你好!感谢你为FinalSuspect提交新功能建议。在开始之前，请先确认以下内容。 + label: 检查清单 options: - - label: 您使用的是最新版本的FinalSuspect。 + - label: 我已在 [Issue 列表](https://github.com/Slok7565/FinalSuspect/issues)中搜索过相关功能，确认该功能想法从未被提出过。 required: true - - type: markdown - id: details - attributes: - value: "## 详细信息" + - label: 我已阅读并同意本项目的[贡献者行为准则](https://github.com/Slok7565/FinalSuspect/blob/FinalSus/CODE_OF_CONDUCT.md)。 + required: true + - type: textarea - id: description attributes: - label: "描述一下此特性" - description: "为了方便我们管理，请不要在同一个issue下提交多个功能。" + label: 功能描述 + placeholder: 详细描述您希望添加的功能。 validations: required: true + - type: textarea - id: additional-information attributes: - label: "附加信息" - description: "如果你还有其他需要提供的信息，可以在这里填写。" + label: 使用场景 + placeholder: 描述您建议的功能的使用场景。 + + - type: markdown + attributes: + value: "感谢您向我们提交您宝贵的想法！" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 96204aa..511fc9a 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - - name: 加入Q群 - url: https://qm.qq.com/q/ZA7Lnjz3SC - about: 加入我们的官方QQ群以便向开发者提问。 + - name: 加入 Q 群 + url: https://qm.qq.com/q/Oj8qOoscik + about: 加入我们的官方 QQ 群以便向开发者提问。 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 3bff290..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,33 +0,0 @@ -## 贡献指南 - -### 前置条件 - -您的工作环境上需要安装下列内容: -- .NET 6 -- Git - -### 提交贡献 - -将FinalSuspect克隆至本地: -> 在执行命令之前,请先Fork本仓库。 -```bash -git clone git@github.com:<你的GitHub用户名>/FinalSuspect.git -``` - -使用此命令提交并推送: -```bash -git add --all -git commit -m "您的提交信息" -git push origin FinalSus -``` -> [!Warning] -> `--all`参数将添加所有更改过的文件。\ -> 这可能会方便开发者一次性提交很多文件,但也可能提交不必要的文件(如构建缓存,IDE项目设置文件)。\ -> 请在提交时忽略他们或在后续删除。 - -#### 本地构建FinalSuspect - -```bash -dotnet nuget add source https://nuget.bepinex.dev/v3/index.json --name "BepInEx" -dotnet build -``` diff --git a/README.md b/README.md index 44544ad..ed25d3d 100644 --- a/README.md +++ b/README.md @@ -12,27 +12,20 @@ -> [!NOTE] -> This mod is not affiliated with Among Us or Innersloth LLC, and the content contained therein is not endorsed or otherwise sponsored by Innersloth LLC.\ -> Portions of the materials contained herein are property of Innersloth LLC. \ +> [!Note] +> This mod is not affiliated with Among Us or Innersloth LLC, and the content it contains is not endorsed or otherwise sponsored by Innersloth LLC.\ +> Portions of the materials contained herein are property of Innersloth LLC.\ > © Innersloth LLC. ## About -FinalSuspect is an original optimization plugin designed for Among Us.\ -The plugin introduces 20+ optimizations to the original game, enhancing the overall experience. +Final Suspect is a premium companion mod for vanilla Among Us, dedicated to delivering a smoother and richer gaming experience for players. As a deep extension of the vanilla core mechanics, we adhere to the development philosophy of "preserving the classic, optimizing the experience". Through 20+ feature iterations, we comprehensively cover core scenarios such as controls, visual presentation, and social interaction.\ +To learn more, please refer to our [official website](https://finalsuspect.pages.dev). ## Contributors
- Contributors List + Contributors List
- ---- - -Want to contribute to FinalSuspect? Check out the [CONTRIBUTING](CONTRIBUTING.md). - -## Star History -![Star History Chart](https://api.star-history.com/svg?repos=XtremeWave/FinalSuspect&type=Date) diff --git a/README_zh.md b/README_zh.md index f53f0b7..6f345a4 100644 --- a/README_zh.md +++ b/README_zh.md @@ -12,16 +12,15 @@ -> [!note] +> [!Note] > 本模组不隶属于 Among Us 或 Innersloth LLC，其包含的内容也未得到 Innersloth LLC 的认可或以其他方式赞助。\ -> 此处包含的部分材料是Innersloth LLC的财产。\ +> 此处包含的部分材料是 Innersloth LLC 的财产。\ > © Innersloth LLC. ## 关于 -FinalSuspect是一个适用于Among Us的原版优化插件。\ -插件为原版带来了20+项优化以及许多功能,使得原版也能获得更好的体验。\ -有关该插件的详细使用文档(安装,更新以及完整的配置说明),请参阅[网站文档](https://finalsuspect.zh-cn.edgeone.cool/)。 +Final Suspect 是 Among Us 原版的优质辅助模组，致力于为玩家带来更流畅、更丰富的游戏体验。作为原版核心机制的深度扩展，我们坚持「保留经典，优化体验」的开发理念，通过 20+ 项功能迭代，全面覆盖操作手感、视觉表现、社交互动等核心场景。\ +要了解更多，请参阅我们的[官方网站](https://finalsuspect.pages.dev)。 ## 贡献者 @@ -29,11 +28,4 @@ FinalSuspect是一个适用于Among Us的原版优化插件。\ Contributors List - - ---- - -要为FinalSuspect做贡献?请参阅[贡献指南](CONTRIBUTING.md)。 - -## 星标历史 -![Star History Chart](https://api.star-history.com/svg?repos=Slok7565/FinalSuspect&type=Date) + \ No newline at end of file