Merge pull request #27 from YongAn404/master

自动化

.github/workflows/docs.yml

@@ -0,0 +1,53 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Build and Publish Docfx Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["master"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  publish-docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: windows-latest
+    steps:
+    - name: Dotnet Checkout
+      uses: actions/checkout@v4
+
+    - name: Dotnet Setup
+      uses: actions/setup-dotnet@v4
+
+    - name: Setup NuGet
+      uses: NuGet/setup-nuget@v2
+
+    - name: Restore NuGet packages
+      run: nuget restore HelpSense.sln
+
+    - run: dotnet tool update -g docfx
+    - run: docfx docs/docfx.json
+
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        # Upload entire repository
+        path: 'docs/_site'
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

HelpSense/ConfigSystem/Config.cs

@@ -2,7 +2,6 @@
 using PlayerRoles;
 using System.Collections.Generic;
 using HelpSense.Helper;
-using Org.BouncyCastle.Asn1.Mozilla;
 using PluginAPI.Helpers;
 using System.IO;
 using System;

HelpSense/packages.config

@@ -1,18 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="Lib.Harmony" version="2.2.2" targetFramework="net48" />
-  <package id="Microsoft.CodeAnalysis.Analyzers" version="2.9.8" targetFramework="net48" developmentDependency="true" />
-  <package id="Microsoft.CodeAnalysis.Common" version="3.3.1" targetFramework="net48" />
-  <package id="Microsoft.CodeAnalysis.CSharp" version="3.3.1" targetFramework="net48" />
-  <package id="Northwood.PluginAPI" version="12.0.0" targetFramework="net48" />
-  <package id="Northwood.PluginAPI.Analyzers" version="12.0.0" targetFramework="net48" />
-  <package id="System.Buffers" version="4.4.0" targetFramework="net48" />
-  <package id="System.Collections.Immutable" version="1.5.0" targetFramework="net48" />
-  <package id="System.Memory" version="4.5.3" targetFramework="net48" />
-  <package id="System.Numerics.Vectors" version="4.4.0" targetFramework="net48" />
-  <package id="System.Reflection.Metadata" version="1.6.0" targetFramework="net48" />
-  <package id="System.Runtime.CompilerServices.Unsafe" version="4.5.2" targetFramework="net48" />
-  <package id="System.Text.Encoding.CodePages" version="4.5.1" targetFramework="net48" />
-  <package id="System.Threading.Tasks.Extensions" version="4.5.3" targetFramework="net48" />
-  <package id="YamlDotNet" version="11.0.1" targetFramework="net48" />
+  <package id="Lib.Harmony" version="2.3.3" targetFramework="net48" />
+  <package id="LiteDB" version="5.0.21" targetFramework="net48" />
+  <package id="Microsoft.CodeAnalysis.Analyzers" version="3.11.0" targetFramework="net48" developmentDependency="true" />
+  <package id="System.Buffers" version="4.5.1" targetFramework="net48" />
+  <package id="YamlDotNet" version="11.2.1" targetFramework="net48" />
 </packages>

docs/articles/index.md

@@ -0,0 +1,5 @@
+---
+title: Home
+---
+
+# null

docs/docfx.json

@@ -0,0 +1,45 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "**/*.csproj"
+          ],
+          "exclude": [
+            "**/bin/**",
+            "**/obj/**"
+          ],
+          "src": "../"
+        }
+      ],
+      "dest": "api",
+      "namespaceLayout": "nested",
+      "enumSortOrder": "declaringOrder"
+    }
+  ],
+  "build": {
+    "globalMetadata": {
+      "_appTitle": "HelpSense",
+      "_enableSearch": true,
+      "_lang": "zh-CN",
+      "_gitContribute": {
+        "repo": "https://github.com/XLittleLeft/HelpSense",
+        "branch": "master"
+      }
+    },
+    "template": [ "default", "modern" ],
+    "content": [
+      {
+        "files": [
+          "articles/*.md",
+          "api/**.yml",
+          "api/index.md",
+          "toc.yml",
+          "*.md"
+        ]
+      }
+    ],
+    "dest": "_site"
+  }
+}

docs/index.md

@@ -0,0 +1,52 @@
+---
+title: Home
+---
+
+<h1>HelpSense</h1>
+<i>一个集各种功能为一身的实用插件，只需一个插件就能解决你的烦恼！</i>
+
+**NwAPI**
+<br><br>
+
+## HelpSense是什么类型的插件？
+**HelpSense** 是一个集各种实用功能的免费插件，用超稳定的 **NwAPI** 编写。\
+您可以通过安装该插件获得原版游戏没有的许多新功能。
+
+## 功能
+**HelpSense** 有许多功能，例如：
+- 聊天系统（.bc .c）
+- 服务器扫地机（清除无用尸体和无用物品减轻服务器负担）
+- 多变保安队（开局保安概率变为精英或叛变，else普通保安队但是会有一个队长）
+- 感应卡（妈妈再也不用担心我玩电炮的时候被关权限房了）
+- 回合刷新票数、时间、点半、核弹显示（快刷了的说！）
+- 回合开始前你可以待在地图的任何地方（不用面对枯燥的等待界面了的说！）
+- .ac私聊管理（有人违规？有人开挂？.ac告诉管理制裁他!）
+- 自定义服务器广播（想让玩家加群？自定义广播可以解决你的烦恼！）
+- 无限子弹（玩家总是抱怨子弹不够用？无限子弹解决你的烦恼！SCP：我上早八！）
+- 机动特遣队Kappa-10 “Skynet”-天网（079打不过？对不起，天网特遣队自带鬼灯甚至会加快电报启动时间）
+- 回合结束内斗（普通的回合结束太无趣？结束回合变成可以自定义的角色互相残杀！）
+- 观察者显示（你总感觉有人在阴间看着你？这个功能能让你知道有谁在看你）
+- 自救指令（不小心卡bug掉入虚空？.ZiJiu救你一命）
+- 练枪大厅（开局还是太过无聊？在练枪大厅试试枪吧）
+- 玩家信息查询（想知道你在服务器总共玩了多长时间，或者杀了多少人？.info试试？）
+- 非礼勿视特遣队（每次玩九尾都不小心看到96，成为非礼勿视特遣队可以看个够！）
+- SCP血量系统（SCP太弱了？加亿点血量吧）
+- 地表大改造（原版地表不好看？待我来改造一番）
+- DD开局给卡（DD太废物了？连个东西都没有，我来助你！）
+- SCP-703（这个插件角色很酷的说，居然能无中生有）
+- SCP-029（DD升级版真的是太酷了）
+- SCP-1056（看着像医疗包一用就成小孩）
+- SCP-1068（看着像鬼灯，一用就核弹“炸”了，但是没有完全炸）
+- 混沌领导者（我们混沌大军需要一个领导者，他因该有最好的装备）
+- SCP-191（79被收容了，结束了？不！并没有，子弹高抗性SCP突破收容了）
+- SCP-073（需要我帮忙？我同意，我的减伤不是开玩笑的，还有反伤）
+- SCP-347（我就在你的身边哦~）
+- SCP-1093（一个人顶着一盏灯？好难受，他好像没有头）
+
+
+## 安装插件
+ 下载 **Release下的最新压缩包** 全部解压到`\PluginAPI\plugins\glabol` .
+
+## 联系方式
+### X小左
+  **QQ:** 3298837494

docs/toc.yml

@@ -0,0 +1,6 @@
+- name: Articles
+  href: articles/index.html
+- name: API Documentation
+  href: api/HelpSense.html
+- name: GitHub
+  href: https://github.com/XLittleLeft/HelpSense