Replace documenation with docfx (#165)

.github/workflows/publish-docs.yml

@@ -1,42 +1,46 @@
-name: Deploy to GitHub Pages
-
 on:
-  # Trigger the workflow every time you push to the `main` branch
-  # Using a different branch name? Replace `main` with your branch’s name
   push:
-    paths:
-      - 'docs/**'
-    branches: [ main ]
+    branches:
+      - main
 
-  # Allows you to run this workflow manually from the Actions tab on GitHub.
-  workflow_dispatch:
-
-# Allow this job to clone the repo and create a page deployment
 permissions:
   contents: read
   pages: write
   id-token: write
 
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout your repository using git
-        uses: actions/checkout@v3
-      - name: Install, build, and upload your site
-        uses: withastro/action@v1
-        with:
-          path: ./docs # The root location of your Astro project inside the repository. (optional)
-          node-version: 20 # The specific version of Node that should be used to build your site. Defaults to 18. (optional)
-          package-manager: pnpm@latest # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
 
-  deploy:
-    needs: build
-    runs-on: ubuntu-latest
+jobs:
+  publish-docs:
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+
     steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Dotnet Setup
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 8.x
+
+      - run: dotnet tool update -g docfx
+
+      - run: docfx docfx/docfx.json
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: "docfx/_site"
+
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v2

.gitignore

@@ -1,6 +1,6 @@
 .ccls-cache/
 .cmake/
-cmake-build-debug/
+cmake-build-debug*/
 .kdev4/
 .vscode/
 generated/
@@ -548,4 +548,9 @@ $RECYCLE.BIN/
 
 _NCrunch*
 
-.idea/
+.idea/
+
+# docfx
+docfx/_site/
+docfx/api/
+docfx/_exported_templates/

docfx/404.md

@@ -0,0 +1,7 @@
+---
+_layout: landing
+---
+
+# 404
+
+We recently changed our docs. Your page may exist at a different location.

docfx/docfx.json

@@ -0,0 +1,45 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "src": "../managed/CounterStrikeSharp.API",
+          "files": ["**/*.csproj"],
+          "exclude": ["**/bin/**", "**/obj/**"]
+        }
+      ],
+      "dest": "api",
+      "namespaceLayout": "nested"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": ["**/*.{md,yml}"],
+        "exclude": ["_site/**"]
+      }
+    ],
+    "resource": [
+      {
+        "files": ["images/**"]
+      }
+    ],
+    "output": "_site",
+    "template": ["default", "modern", "layouts/cssharp"],
+    "globalMetadata": {
+      "_appFaviconPath": "images/cssharp.svg",
+      "_appFooter": "<a href=\"https://docs.cssharp.dev\">docs.cssharp.dev</a>",
+      "_appLogoPath": "images/cssharp.svg",
+      "_appName": "CounterStrikeSharp",
+      "_appTitle": "CounterStrikeSharp",
+      "_disableNewTab": true,
+      "_enableNewTab": true,
+      "_enableSearch": true,
+      "pdf": false
+    },
+    "sitemap": {
+      "baseUrl": "https://docs.cssharp.dev",
+      "changefreq": "hourly"
+    }
+  }
+}

docfx/docs/admin-framework/admin-command-attributes.md

@@ -3,6 +3,10 @@ title: Admin Command Attributes
 description: A guide on using the Admin Command Attributes in plugins.
 ---
 
+# Admin Command Attributes
+
+A guide on using the Admin Command Attributes in plugins.
+
 ## Assigning permissions to a Command
 
 Assigning permissions to a Command is as easy as tagging the Command method (function callback) with either a `RequiresPermissions` or `RequiresPermissionsOr` attribute. The difference between the two attributes is that `RequiresPermissionsOr` needs only one permission to be present on the caller to be passed, while `RequiresPermissions` needs the caller to have all permissions listed. CounterStrikeSharp handles all of the permission checks behind the scenes for you.

docfx/docs/admin-framework/defining-admin-groups.md

@@ -3,6 +3,10 @@ title: Defining Admin Groups
 description: A guide on how to define admin groups for CounterStrikeSharp.
 ---
 
+# Defining Admin Groups
+
+A guide on how to define admin groups for CounterStrikeSharp.
+
 ## Adding Groups
 
 Groups can be created to group a series of permissions together under one tag. They are defined in `configs/admin_groups.json`. The important things you need to declare is the name of the group and the permissions they have.
@@ -34,9 +38,9 @@ You can add admins to groups using the `groups` array in `configs/admins.json`
 }
 ```
 
-:::note
-All group names MUST start with a hashtag # character, otherwise CounterStrikeSharp won't recognize the group.
-:::
+> [!NOTE]
+> All group names MUST start with a hashtag # character, otherwise CounterStrikeSharp won't recognize the group.
+
 
 Admins can be assigned to multiple groups and they will inherit their flags. You can manually assign groups to players in code with `AdminManager.AddPlayerToGroup` and `AdminManager.RemovePlayerFromGroup`.
 

docfx/docs/admin-framework/defining-admin-immunity.md

@@ -3,6 +3,10 @@ title: Defining Admin Immunity
 description: A guide on how to define immunity for admins for CounterStrikeSharp.
 ---
 
+# Defining Admin Immunity
+
+A guide on how to define immunity for admins for CounterStrikeSharp.
+
 ## Player Immunity
 
 Admins can be assigned an immunity value, similar to SourceMod. If an admin or player with a lower immunity value targets another admin or player with a larger immunity value, then the command will fail. You can define an immunity value by adding the `immunity` key to each admin in `configs/admins.json`.
@@ -31,6 +35,5 @@ You can even assign an immunity value to groups. If an admin has a lower immunit
 }
 ```
 
-:::note
-CounterStrikeSharp does not automatically handle immunity checking. It is up to individual plugins to handle immunity checks as they can implement different ways of targeting players. This can be done in code with `AdminManager.CanPlayerTarget`. You can also set a player's immunity in code with `AdminManager.SetPlayerImmunity`.
-:::
+> [!NOTE]
+> CounterStrikeSharp does not automatically handle immunity checking. It is up to individual plugins to handle immunity checks as they can implement different ways of targeting players. This can be done in code with `AdminManager.CanPlayerTarget`. You can also set a player's immunity in code with `AdminManager.SetPlayerImmunity`.

docfx/docs/admin-framework/defining-admins.md

@@ -3,6 +3,10 @@ title: Defining Admins
 description: A guide on how to define admins for CounterStrikeSharp.
 ---
 
+# Defining Admins
+
+A guide on how to define admins for CounterStrikeSharp.
+
 ## Admin Framework
 
 CounterStrikeSharp has a basic framework which allows plugin developers to assign permissions to commands. When CSS is initialized, a list of admins are loaded from `configs/admins.json`.
@@ -26,9 +30,8 @@ Adding an Admin is as simple as creating a new entry in the `configs/admins.json
 
 You can also manually assign permissions to players in code with `AdminManager.AddPlayerPermissions` and `AdminManager.RemovePlayerPermissions`. These changes are not saved to `configs/admins.json`.
 
-:::note
-All user permissions MUST start with an at-symbol @ character, otherwise CounterStrikeSharp will not recognize the permission.
-:::
+> [!NOTE]
+> All user permissions MUST start with an at-symbol @ character, otherwise CounterStrikeSharp will not recognize the permission.
 
 ### Standard Permissions
 
@@ -55,7 +58,5 @@ However there is a somewhat standardized list of flags that it is advised you us
 @css/root # Magically enables all flags and ignores immunity values.
 ```
 
-:::note
-CounterStrikeSharp does not implement traditional admin command such as `!slay`, `!kick`, and `!ban`. It is up to individual plugins to implement these commands.
-:::
-
+> [!NOTE]
+> CounterStrikeSharp does not implement traditional admin command such as `!slay`, `!kick`, and `!ban`. It is up to individual plugins to implement these commands.

docfx/docs/admin-framework/defining-command-overrides.md

@@ -3,6 +3,10 @@ title: Defining Command Overrides
 description: A guide on how to define command overrides for CounterStrikeSharp.
 ---
 
+# Defining Command Overrides
+
+A guide on how to define command overrides for CounterStrikeSharp.
+
 ## Defining Admin and Group specific overrides
 
 Command permissions can be overriden so specific admins or groups can execute the command, regardless of any permissions they may or may not have. You can define command overrides by adding the `command_overrides` key to each admin in `configs/admins.json` or group in `configs/admin_groups.json`. Command overrides can either be set to `true`, meaning the admin/group can execute the command, or `false`, meaning the admin/group cannot execute the command at all.

docfx/docs/admin-framework/toc.yml

@@ -0,0 +1,14 @@
+- name: Admin Command Attributes
+  href: admin-command-attributes.md
+
+- name: Defining Admins
+  href: defining-admins.md
+
+- name: Defining Command Overrides
+  href: defining-command-overrides.md
+
+- name: Defining Admin Groups
+  href: defining-admin-groups.md
+
+- name: Defining Admin Immunity
+  href: defining-admin-immunity.md

docfx/docs/features/console-commands.md

@@ -3,6 +3,10 @@ title: Console Commands
 description: How to add a new console command
 ---
 
+# Console Commands
+
+How to add a new console command
+
 ## Adding a Console Command
 
 ### Automatic registration

docfx/docs/features/console-variables.md

@@ -3,6 +3,10 @@ title: Console Variables
 description: How to read & write console variables (ConVars).
 ---
 
+# Console Variables
+
+How to read & write console variables (ConVars).
+
 ## Finding a ConVar
 
 Use the `ConVar.Find` static method to find a reference to an existing ConVar (or `null`).

docfx/docs/features/game-events.md

@@ -3,15 +3,18 @@ title: Game Events
 description: How to listen to Source 1 style game events.
 ---
 
+# Game Events
+
+How to listen to Source 1 style game events.
+
 ## Adding an Event Listener
 
 ### Automatic registration
 
 CounterStrikeSharp will automatically register event listeners marked with a `GameEventHandler` attribute on the `BasePlugin` class. These listeners are automatically registered/deregistered for you on hot reload.
 
-:::note
-The first parameter type must be a subclass of the `GameEvent` class. The names are automatically generated from the [game event list](https://cs2.poggu.me/dumped-data/game-events).
-:::
+> [!NOTE]
+> The first parameter type must be a subclass of the `GameEvent` class. The names are automatically generated from the [game event list](https://cs2.poggu.me/dumped-data/game-events).
 
 ```csharp
 [GameEventHandler]

docfx/docs/features/global-listeners.md

@@ -3,6 +3,10 @@ title: Global Listeners
 description: How to subscribe to CounterStrikeSharp global listeners.
 ---
 
+# Global Listeners
+
+How to subscribe to CounterStrikeSharp global listeners.
+
 ## Adding a Listener
 
 Global listeners come in a variety of shapes so there is no automatic registration for these, they must be registered in the `OnLoad` of your plugin (or anywhere you have access to the plugin instance). You can find the full list of event listeners in the `Listeners` class as seen below.

docfx/docs/features/toc.yml

@@ -0,0 +1,11 @@
+- name: Console Commands
+  href: console-commands.md
+
+- name: Console Variables
+  href: console-variables.md
+
+- name: Game Events
+  href: game-events.md
+
+- name: Global Listeners
+  href: global-listeners.md

docfx/docs/guides/dependency-injection.md

@@ -1,10 +1,12 @@
 ---
 title: Dependency Injection
 description: How to make use of dependency injection in CounterStrikeSharp
-sidebar:
-  order: 1
 ---
 
+# Dependency Injection
+
+How to make use of dependency injection in CounterStrikeSharp
+
 `CounterStrikeSharp` uses a standard <a href="https://learn.microsoft.com/en-us/aspnet/core/fundamentals/dependency-injection?view=aspnetcore-8.0" target="_blank">`IServiceCollection`</a> to allow for dependency injection in plugins.
 
 There are a handful of standard services that are predefined for you (`ILogger` for logging for instance), with more to come in the future. To add your own scoped & singleton services to the container, you can create a new class that implements the `IPluginServiceCollection<T>` interface for your plugin.

docfx/docs/guides/getting-started.md

@@ -1,26 +1,25 @@
 ---
 title: Getting Started
 description: How to get started installing & using CounterStrikeSharp.
-sidebar:
-  order: 0
 ---
 
-# Installation
+# Getting Started
 
-### Installing Metamod
+How to get started installing & using CounterStrikeSharp.
+
+## Installing Metamod
 
 `CounterStrikeSharp` uses `Metamod:Source` as its main way of communicating with the game server. To install it, you can follow the detailed instructions found <a href="https://cs2.poggu.me/metamod/installation/" target="_blank">here</a>.
 
-### Installing CounterStrikeSharp
+## Installing CounterStrikeSharp
 
 Download the latest release of CounterStrikeSharp from <a href="https://github.com/roflmuffin/CounterStrikeSharp/actions/workflows/cmake-single-platform.yml" target="_blank">GitHub actions build pages</a> (just choose the latest development snapshot). **You may need to be logged into GitHub to gain access to the downloads**.
 
-:::caution[.NET Runtime]
-If this is your first time installing, you will need to download the `with-runtime` version. This includes a copy of the .NET runtime, which is required to run the plugin.
-Depending on the os you might also either need to install `libicu` / `icu-libs` / `libicu-dev` using your package manager for .NET to run or setting `DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=true` in your servers environment variables. You can find more infos about that <a href="https://github.com/dotnet/runtime/blob/main/docs/design/features/globalization-invariant-mode.md#enabling-the-invariant-mode" target="_blank">here</a> 
-
-Subsequent upgrades will not require the runtime, unless a version bump of the .NET runtime is required (i.e. from 7.0.x to 8.0.x). We will inform you when this occurs.
-:::
+> [!CAUTION]
+> If this is your first time installing, you will need to download the `with-runtime` version. This includes a copy of the .NET runtime, which is required to run the plugin.
+> Depending on the os you might also either need to install `libicu` / `icu-libs` / `libicu-dev` using your package manager for .NET to run or setting `DOTNET_SYSTEM_GLOBALIZATION_INVARIANT=true` in your servers environment variables. You can find more infos about that <a href="https://github.com/dotnet/runtime/blob/main/docs/design/features/globalization-invariant-mode.md#enabling-the-invariant-mode" target="_blank">here</a> 
+> 
+> Subsequent upgrades will not require the runtime, unless a version bump of the .NET runtime is required (i.e. from 7.0.x to 8.0.x). We will inform you when this occurs.
 
 Extract the `addons` folder to the `/csgo/` directory of the dedicated server. The contents of your addons folder should contain both the `counterstrikesharp` folder and the `metamod` folder as seen below.
 
@@ -28,22 +27,22 @@ Extract the `addons` folder to the `/csgo/` directory of the dedicated server. T
 <server_path>/game/csgo/addons > tree -L 2
 addons
 ├── counterstrikesharp
-│   ├── api
-│   ├── bin
-│   ├── dotnet
-│   ├── plugins
+│   ├── api
+│   ├── bin
+│   ├── dotnet
+│   ├── plugins
 │   └── gamedata
 │
 ├── metamod
-│   ├── bin
-│   ├── counterstrikesharp.vdf
-│   ├── metaplugins.ini
-│   └── README.txt
+│   ├── bin
+│   ├── counterstrikesharp.vdf
+│   ├── metaplugins.ini
+│   └── README.txt
 ├── metamod.vdf
 └── metamod_x64.vdf
 ```
 
-### Start the Server
+## Start the Server
 
 Launch your CS2 dedicated server as normal. If everything is working correctly, you should see a message in the console that says `CSSharp: CounterStrikeSharp.API Loaded Successfully.`.
 
@@ -53,4 +52,4 @@ Running the command `meta list` in the console should show 1 plugin loaded 🎉
 meta list
 Listing 1 plugin:
   [01] CounterStrikeSharp (0.1.0) by Roflmuffin
-```
+```

docfx/docs/guides/hello-world-plugin.md

@@ -1,10 +1,12 @@
 ---
 title: Hello World Plugin
 description: How to write your first plugin for CounterStrikeSharp
-sidebar:
-  order: 0
 ---
 
+# Hello World Plugin
+
+How to write your first plugin for CounterStrikeSharp
+
 ## Creating a New Project
 
 First, ensure you have the relevant .NET 7.0 SDK for your platform installed on your machine. You can find the links to the latest downloads on the <a href="https://dotnet.microsoft.com/en-us/download/dotnet/7.0" target="_blank"> official Microsoft download page</a>.
@@ -36,12 +38,11 @@ Use your IDE (Visual Studio/Rider) to add a reference to the `CounterStrikeSharp
 </Project>
 ```
 
-:::tip
-Instead of manually adding a reference to `CounterStrikeSharp.Api.dll`, you can install the NuGet package `CounterStrikeSharp.Api` using the following:
-```shell
-dotnet add package CounterStrikeSharp.API
-```
-:::
+> [!TIP]
+> Instead of manually adding a reference to `CounterStrikeSharp.Api.dll`, you can > install the NuGet package `CounterStrikeSharp.Api` using the following:
+> ```shell
+> dotnet add package CounterStrikeSharp.API
+> ```
 
 ### Creating a Plugin File
 
@@ -78,20 +79,17 @@ Locate the `plugins` folder in your CS2 dedicated server (`/game/csgo/addons/cou
     └── HelloWorldPlugin.pdb
 ```
 
-:::caution
-If you have installed external nuget packages for your plugin, you may need to include their respective `.dll`s. For example, if you utilize the `Stateless` C# library, include `stateless.dll` in your `HelloWorld` plugin directory.
-:::
+> [!CAUTION]
+> If you have installed external nuget packages for your plugin, you may need to include their respective `.dll`s. For example, if you utilize the `Stateless` C# library, include `stateless.dll` in your `HelloWorld` plugin directory.
 
-:::note
-Note that some of these dependencies may change depending on the version of CounterStrikeSharp being used.
-:::
+> [!NOTE]
+> Note that some of these dependencies may change depending on the version of CounterStrikeSharp being used.
 
 ### Start the Server
 
 Now start your CS2 dedicated server. Just before the `CounterStrikeSharp.API Loaded Successfully.` message you should see your `Hello World!` console write that we called from the load function, neat!
 
-:::note[Hot Reloading!]
-By default, CounterStrikeSharp will automatically hot reload your plugin if you replace the .dll file in your plugin folder. When it does so, it will call the `Unload` and `Load` functions respectively, with the `hotReload` flag set to true.
-
-It is worth noting that the framework will automatically deregister any event handlers or listeners for you automatically, so you can safely reregister these on load without checking this flag. However you may want to do some specific actions on a hot reload, which you can do in your `Load()` call by checking the flag!
-:::
+> [!NOTE]
+> By default, CounterStrikeSharp will automatically hot reload your plugin if you replace the .dll file in your plugin folder. When it does so, it will call the `Unload` and `Load` functions respectively, with the `hotReload` flag set to true.
+> 
+> It is worth noting that the framework will automatically deregister any event handlers or listeners for you automatically, so you can safely reregister these on load without checking this flag. However you may want to do some specific actions on a hot reload, which you can do in your `Load()` call by checking the flag!

docfx/docs/guides/toc.yml

@@ -0,0 +1,8 @@
+- name: Getting Started
+  href: getting-started.md
+
+- name: Hello World Plugin
+  href: hello-world-plugin.md
+
+- name: Dependency Injection
+  href: dependency-injection.md

docfx/docs/reference/core-configuration.md

@@ -3,6 +3,10 @@ title: Core Configuration
 description: Summary for core configuration values
 ---
 
+# Core Configuration
+
+Summary for core configuration values
+
 ## PublicChatTrigger
 
 List of characters to use for public chat triggers.
@@ -21,9 +25,9 @@ Enabling this option will block plugins from using functionality that is known t
 This option only has any effect on CS2. Note that this does NOT guarantee that you cannot
 receive a ban.
 
-:::note
-Disable this option at your own risk.
-:::
+> [!NOTE]
+> Disable this option at your own risk.
+
 
 ## PluginHotReloadEnabled
 

docfx/docs/reference/referencing-players.md

@@ -3,6 +3,10 @@ title: Referencing Players
 description: Difference between player slots, indexes, userids, controllers & pawns.
 ---
 
+# Referencing Players
+
+Difference between player slots, indexes, userids, controllers & pawns.
+
 ## Controllers & Pawns
 
 All players in CS2 are split between a player controller & a player pawn. The player controller represents the player on the server, and the player pawn represents the players physical character in the game world. This means to edit a players health for example, you would need to edit their `PlayerPawn`'s health; but to check for a player's SteamID, you would check the `PlayerController`.
@@ -44,13 +48,12 @@ var player = Utilities.GetPlayerFromIndex(index);
 var player = Utilities.GetPlayerFromSlot(slot);
 ```
 
-:::note[Entity Safety]
-Wherever possible, you should check the validity of any handle you are accessing before assuming it is safe to use. 
-```csharp
-RegisterEventHandler<EventPlayerSpawn>((@event, info) =>
-{
-    if (!@event.Userid.IsValid) return 0; // Checks that the PlayerController is valid
-    if (!@event.Userid.PlayerPawn.IsValid) return 0; // Checks that the value of the CHandle is pointing to a valid PlayerPawn.
-}
-```
-:::
+> [!NOTE]
+> Wherever possible, you should check the validity of any handle you are accessing before assuming it is safe to use. 
+> ```csharp
+> RegisterEventHandler<EventPlayerSpawn>((@event, info) =>
+> {
+>     if (!@event.Userid.IsValid) return 0; // Checks that the PlayerController is valid
+>     if (!@event.Userid.PlayerPawn.IsValid) return 0; // Checks that the value of the CHandle is pointing to a valid PlayerPawn.
+> }
+> ```

docfx/docs/reference/toc.yml

@@ -0,0 +1,5 @@
+- name: Core Configuration
+  href: core-configuration.md
+
+- name: Referencing Players
+  href: referencing-players.md

docfx/docs/toc.yml

@@ -0,0 +1,16 @@
+items:
+  - name: Guides
+    href: guides/toc.yml
+    expanded: true
+
+  - name: Features
+    href: features/toc.yml
+    expanded: true
+
+  - name: Admin Framework
+    href: admin-framework/toc.yml
+    expanded: true
+
+  - name: Reference
+    href: reference/toc.yml
+    expanded: true

docfx/examples/HelloWorld.md

@@ -0,0 +1,5 @@
+[!INCLUDE [HelloWorld](../../examples/HelloWorld/README.md)]
+
+<a href="https://github.com/roflmuffin/CounterStrikeSharp/tree/main/examples/HelloWorld" class="btn btn-secondary">View project on Github <i class="bi bi-github"></i></a>
+
+[!code-csharp[](../../examples/HelloWorld/HelloWorldPlugin.cs)]

docfx/examples/WarcraftPlugin.md

@@ -0,0 +1,13 @@
+# Warcraft Plugin
+
+This Warcraft plugin is migrated from the previous VSP.NET project to give you an idea of the kind of power this scripting runtime is capable of.
+
+<a href="https://github.com/roflmuffin/CounterStrikeSharp/tree/main/examples/WarcraftPlugin" class="btn btn-secondary">View project on Github <i class="bi bi-github"></i></a>
+
+## Demonstrated
+- Hook events
+- Create commands
+- Use third party libraries
+  - SQLite
+- Entity manipulation
+

docfx/examples/WithCommands.md

@@ -0,0 +1,5 @@
+[!INCLUDE [WithCommands](../../examples/WithCommands/README.md)]
+
+<a href="https://github.com/roflmuffin/CounterStrikeSharp/tree/main/examples/WithCommands" class="btn btn-secondary">View project on Github <i class="bi bi-github"></i></a>
+
+[!code-csharp[](../../examples/WithCommands/WithCommandsPlugin.cs)]

docfx/examples/WithConfig.md

@@ -0,0 +1,5 @@
+[!INCLUDE [WithConfig](../../examples/WithConfig/README.md)]
+
+<a href="https://github.com/roflmuffin/CounterStrikeSharp/tree/main/examples/WithConfig" class="btn btn-secondary">View project on Github <i class="bi bi-github"></i></a>
+
+[!code-csharp[](../../examples/WithConfig/WithConfigPlugin.cs)]

docfx/examples/WithDatabase.md

@@ -0,0 +1,5 @@
+[!INCLUDE [Database](../../examples/WithDatabaseDapper/README.md)]
+
+<a href="https://github.com/roflmuffin/CounterStrikeSharp/tree/main/examples/WithDatabaseDapper" class="btn btn-secondary">View project on Github <i class="bi bi-github"></i></a>
+
+[!code-csharp[](../../examples/WithDatabaseDapper/WithDatabaseDapperPlugin.cs)]

docfx/examples/WithDependencyInjection.md

@@ -0,0 +1,5 @@
+[!INCLUDE [WithDependencyInjection](../../examples/WithDependencyInjection/README.md)]
+
+<a href="https://github.com/roflmuffin/CounterStrikeSharp/tree/main/examples/WithDependencyInjection" class="btn btn-secondary">View project on Github <i class="bi bi-github"></i></a>
+
+[!code-csharp[](../../examples/WithDependencyInjection/WithDependencyInjectionPlugin.cs)]

docfx/examples/WithGameEventHandlers.md

@@ -0,0 +1,5 @@
+[!INCLUDE [WithGameEventHandlers](../../examples/WithGameEventHandlers/README.md)]
+
+<a href="https://github.com/roflmuffin/CounterStrikeSharp/tree/main/examples/WithGameEventHandlers" class="btn btn-secondary">View project on Github <i class="bi bi-github"></i></a>
+
+[!code-csharp[](../../examples/WithGameEventHandlers/WithGameEventHandlersPlugin.cs)]

docfx/examples/toc.yml

@@ -0,0 +1,15 @@
+items:
+  - name: Hello World
+    href: HelloWorld.md
+  - name: Commands
+    href: WithCommands.md
+  - name: Config
+    href: WithConfig.md
+  - name: Dependency Injection
+    href: WithDependencyInjection.md
+  - name: Game Event Handlers
+    href: WithGameEventHandlers.md
+  - name: Database (Dapper)
+    href: WithDatabase.md
+  - name: Warcraft Plugin
+    href: WarcraftPlugin.md

docfx/images/cssharp.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" width="50" height="50" viewBox="0 0 13.229 13.229"><path d="M9.91 0 4.881.039c-.545.004-1.073.02-1.577.057A6.957 6.957 0 0 0 .403.934c-.233.124-.403.338-.403.6a.652.652 0 0 0 .98.563l.004-.002a5.434 5.434 0 0 1 2.098-.66c2.123-.227 3.599.534 4.595 1.428 1.095.982 2.108 2.982 1.74 5.175-.22 1.313-.826 2.42-1.77 3.28l-.002.002c-.171.156-.312.337-.312.568a.674.674 0 0 0 1.1.52c.027-.02.058-.049.073-.063a7.327 7.327 0 0 0 1.76-2.566l2.679-6.357c.126-.287.232-.583.265-.871.142-1.26-.531-1.985-1.383-2.32-.436-.172-1.05-.224-1.72-.23L9.91 0Zm.725.802c.476.02.94.363.88.99-.073.758-.83 1.287-1.16 1.785h1.16c.07.102.07.433 0 .535-.583-.057-1.233-.047-1.874-.045-.274-1.001 1.42-1.674 1.249-2.498-.081-.389-.636-.4-.536.179h-.669c-.012-.663.475-.966.95-.946Z" style="display:inline;opacity:1;fill:#ff6000;fill-opacity:1;stroke-width:.0470931" transform="translate(0 .334)"/><g style="display:inline"><path fill="#a179dc" d="M7.52 5.702a.743.743 0 0 0-.09-.374.715.715 0 0 0-.272-.264C6.16 4.489 5.163 3.916 4.167 3.34a.734.734 0 0 0-.796.008C2.974 3.583.987 4.72.395 5.064a.692.692 0 0 0-.363.638V9.17c0 .139.03.26.088.367.06.109.15.2.275.27.592.344 2.579 1.482 2.976 1.717a.735.735 0 0 0 .796.007c.996-.575 1.995-1.148 2.992-1.723a.713.713 0 0 0 .275-.271.747.747 0 0 0 .087-.367V5.702"/><path fill="#280068" d="M3.788 7.424.12 9.538c.06.109.15.2.275.27.592.344 2.579 1.482 2.976 1.717a.735.735 0 0 0 .796.007c.996-.575 1.995-1.148 2.992-1.723a.713.713 0 0 0 .275-.271L3.788 7.424"/><path fill="#390091" d="M7.52 5.702a.743.743 0 0 0-.09-.374L3.787 7.425l3.646 2.112a.748.748 0 0 0 .087-.367V5.702"/><path fill="#fff" d="M5.948 6.635v.395h.395v-.395h.197v.395h.395v.197H6.54v.395h.395v.198H6.54v.394h-.197V7.82h-.395v.394H5.75V7.82h-.395v-.198h.395v-.395h-.395V7.03h.395v-.395Zm.395.592h-.395v.395h.395z"/><path fill="#fff" d="M3.796 4.652c1.03 0 1.93.56 2.41 1.39l-.004-.007-1.212.698a1.385 1.385 0 0 0-1.178-.683h-.016a1.386 1.386 0 1 0 1.208 2.066l-.006.01 1.21.7a2.783 2.783 0 0 1-2.38 1.394h-.032a2.784 2.784 0 1 1 0-5.568z"/></g></svg>

docfx/index.md

@@ -0,0 +1,23 @@
+---
+_layout: landing
+uid: home
+title: CounterStrikeSharp
+_appTitle: ''
+description: Write Counter-Strike 2 server plugins in C#.
+---
+
+<div class="row justify-content-md-center">
+  <div class="col-12 col-lg-10 col-xl-8 col-xxl-6">
+    <div class="text-center">
+      <img src="images/cssharp.svg" height="128" width="128">
+      <h1 class="h1">CounterStrikeSharp</h1>
+      <span>CounterStrikeSharp is a simpler way to write CS2 server plugins.</span>
+      <div>
+        <a href="docs/guides/getting-started.md" class="btn btn-primary btn-lg fw-bold my-5">Get Started <i class="bi bi-arrow-right"></a>
+      </div>
+    </div>
+
+[!code-csharp[](../examples/HelloWorld/HelloWorldPlugin.cs)]
+
+  </div>
+</div>

docfx/layouts/cssharp/layout/_master.tmpl

@@ -0,0 +1,149 @@
+{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
+{{!include(/^public/.*/)}}
+{{!include(favicon.ico)}}
+{{!include(logo.svg)}}
+<!DOCTYPE html>
+<html {{#_lang}}lang="{{_lang}}"{{/_lang}}>
+  <head>
+    <meta charset="utf-8">
+    {{#redirect_url}}
+      <meta http-equiv="refresh" content="0;URL='{{redirect_url}}'">
+    {{/redirect_url}}
+    {{^redirect_url}}
+      <title>{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}</title>
+      <meta name="viewport" content="width=device-width, initial-scale=1.0">
+      <meta name="title" content="{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}}">
+      {{#_description}}<meta name="description" content="{{_description}}">{{/_description}}
+      <link rel="icon" href="{{_rel}}{{{_appFaviconPath}}}{{^_appFaviconPath}}favicon.ico{{/_appFaviconPath}}">
+      <link rel="stylesheet" href="{{_rel}}public/docfx.min.css">
+      <link rel="stylesheet" href="{{_rel}}public/main.css">
+      <meta name="docfx:navrel" content="{{_navRel}}">
+      <meta name="docfx:tocrel" content="{{_tocRel}}">
+      {{#_noindex}}<meta name="searchOption" content="noindex">{{/_noindex}}
+      {{#_enableSearch}}<meta name="docfx:rel" content="{{_rel}}">{{/_enableSearch}}
+      {{#_disableNewTab}}<meta name="docfx:disablenewtab" content="true">{{/_disableNewTab}}
+      {{#_disableTocFilter}}<meta name="docfx:disabletocfilter" content="true">{{/_disableTocFilter}}
+      {{#docurl}}<meta name="docfx:docurl" content="{{docurl}}">{{/docurl}}
+      <meta name="loc:inThisArticle" content="{{__global.inThisArticle}}">
+      <meta name="loc:searchResultsCount" content="{{__global.searchResultsCount}}">
+      <meta name="loc:searchNoResults" content="{{__global.searchNoResults}}">
+      <meta name="loc:tocFilter" content="{{__global.tocFilter}}">
+      <meta name="loc:nextArticle" content="{{__global.nextArticle}}">
+      <meta name="loc:prevArticle" content="{{__global.prevArticle}}">
+      <meta name="loc:themeLight" content="{{__global.themeLight}}">
+      <meta name="loc:themeDark" content="{{__global.themeDark}}">
+      <meta name="loc:themeAuto" content="{{__global.themeAuto}}">
+      <meta name="loc:changeTheme" content="{{__global.changeTheme}}">
+      <meta name="loc:copy" content="{{__global.copy}}">
+      <meta name="loc:downloadPdf" content="{{__global.downloadPdf}}">
+    {{/redirect_url}}
+      <script data-goatcounter="https://cssharp.goatcounter.com/count" async src="//gc.zgo.at/count.js"></script>
+  </head>
+
+  {{^redirect_url}}
+  <script type="module" src="./{{_rel}}public/docfx.min.js"></script>
+
+  <script>
+    const theme = localStorage.getItem('theme') || 'auto'
+    document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
+  </script>
+
+  {{#_googleAnalyticsTagId}}
+  <script async src="https://www.googletagmanager.com/gtag/js?id={{_googleAnalyticsTagId}}"></script>
+  <script>
+    window.dataLayer = window.dataLayer || [];
+    function gtag() { dataLayer.push(arguments); }
+    gtag('js', new Date());
+    gtag('config', '{{_googleAnalyticsTagId}}');
+  </script>
+  {{/_googleAnalyticsTagId}}
+
+  <body class="tex2jax_ignore" data-layout="{{_layout}}{{layout}}" data-yaml-mime="{{yamlmime}}">
+    <header class="bg-body border-bottom">
+      <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
+        <div class="container-xxl flex-nowrap">
+          <a class="navbar-brand" href="{{_appLogoUrl}}{{^_appLogoUrl}}{{_rel}}index.html{{/_appLogoUrl}}">
+            <img id="logo" class="svg" src="{{_rel}}{{{_appLogoPath}}}{{^_appLogoPath}}logo.svg{{/_appLogoPath}}" alt="{{_appName}}" >
+            {{_appName}}
+          </a>
+          <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
+            <i class="bi bi-three-dots"></i>
+          </button>
+          <div class="collapse navbar-collapse" id="navpanel">
+            <div id="navbar">
+              {{#_enableSearch}}
+              <form class="search" role="search" id="search">
+                <i class="bi bi-search"></i>
+                <input class="form-control" id="search-query" type="search" disabled placeholder="{{__global.search}}" autocomplete="off" aria-label="Search">
+              </form>
+              {{/_enableSearch}}
+            </div>
+          </div>
+        </div>
+      </nav>
+    </header>
+
+    <main class="container-xxl">
+      <div class="toc-offcanvas">
+        <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
+          <div class="offcanvas-header">
+            <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
+            <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
+          </div>
+          <div class="offcanvas-body">
+            <nav class="toc" id="toc"></nav>
+          </div>
+        </div>
+      </div>
+
+      <div class="content">
+        <div class="actionbar">
+          <button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em"
+              type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas"
+              aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
+            <i class="bi bi-list"></i>
+          </button>
+
+          <nav id="breadcrumb"></nav>
+        </div>
+
+        <article data-uid="{{uid}}">
+          {{!body}}
+        </article>
+
+        {{^_disableContribution}}
+        <div class="contribution d-print-none">
+          {{#sourceurl}}
+          <a href="{{sourceurl}}" class="edit-link">{{__global.improveThisDoc}}</a>
+          {{/sourceurl}}
+          {{^sourceurl}}{{#docurl}}
+          <a href="{{docurl}}" class="edit-link">{{__global.improveThisDoc}}</a>
+          {{/docurl}}{{/sourceurl}}
+        </div>
+        {{/_disableContribution}}
+
+        {{^_disableNextArticle}}
+        <div class="next-article d-print-none border-top" id="nextArticle"></div>
+        {{/_disableNextArticle}}
+
+      </div>
+
+      <div class="affix">
+        <nav id="affix"></nav>
+      </div>
+    </main>
+
+    {{#_enableSearch}}
+    <div class="container-xxl search-results" id="search-results"></div>
+    {{/_enableSearch}}
+
+    <footer class="border-top text-secondary">
+      <div class="container-xxl">
+        <div class="flex-fill">
+          {{{_appFooter}}}{{^_appFooter}}<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>{{/_appFooter}}
+        </div>
+      </div>
+    </footer>
+  </body>
+  {{/redirect_url}}
+</html>

docfx/layouts/cssharp/public/main.js

@@ -0,0 +1,14 @@
+export default {
+  iconLinks: [
+    {
+      icon: "github",
+      href: "https://github.com/roflmuffin/CounterStrikeSharp",
+      title: "GitHub",
+    },
+    {
+      icon: "discord",
+      href: "https://discord.gg/X7r3PmuYKq",
+      title: "Discord",
+    },
+  ],
+};

docfx/toc.yml

@@ -0,0 +1,6 @@
+- name: Docs
+  href: docs/
+- name: Examples
+  href: examples/
+- name: API
+  href: api/

docs/.gitignore

@@ -1,21 +0,0 @@
-# build output
-dist/
-# generated types
-.astro/
-
-# dependencies
-node_modules/
-
-# logs
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-pnpm-debug.log*
-
-
-# environment variables
-.env
-.env.production
-
-# macOS-specific files
-.DS_Store

docs/.prettierrc

@@ -1,6 +0,0 @@
-{
-  "trailingComma": "es5",
-  "tabWidth": 2,
-  "semi": true,
-  "singleQuote": true
-}

docs/astro.config.mjs

@@ -1,61 +0,0 @@
-import { defineConfig } from 'astro/config';
-import starlight from '@astrojs/starlight';
-
-// https://astro.build/config
-export default defineConfig({
-  integrations: [
-    starlight({
-      title: 'CounterStrikeSharp Docs',
-      customCss: [
-        '@fontsource/dm-sans/400.css',
-        '@fontsource/dm-sans/500.css',
-        '@fontsource/dm-sans/700.css',
-        '@fontsource/jetbrains-mono/400.css',
-        '@fontsource/jetbrains-mono/600.css',
-        './src/styles/custom.css',
-      ],
-      head: [
-        {
-          tag: 'script',
-          attrs: {
-            src: 'https://gc.zgo.at/count.js',
-            'data-goatcounter': 'https://cssharp.goatcounter.com/count',
-            async: true,
-          },
-        },
-      ],
-      social: {
-        github: 'https://github.com/roflmuffin/CounterStrikeSharp',
-      },
-      sidebar: [
-        {
-          label: 'Guides',
-          autogenerate: { directory: 'guides' },
-        },
-        {
-          label: 'Features',
-          autogenerate: { directory: 'features' },
-        },
-        {
-          label: 'Admin Framework',
-          autogenerate: { directory: 'admin-framework' },
-        },
-        {
-          label: 'Reference',
-          autogenerate: { directory: 'reference' },
-        },
-      ],
-      editLink: {
-        baseUrl:
-          'https://github.com/roflmuffin/CounterStrikeSharp/edit/main/docs/',
-      },
-    }),
-  ],
-  base: '/',
-  site: 'https://docs.cssharp.dev',
-  markdown: {
-    shikiConfig: {
-      wrap: false,
-    },
-  },
-});

docs/package.json

@@ -1,22 +0,0 @@
-{
-  "name": "",
-  "type": "module",
-  "version": "0.0.1",
-  "scripts": {
-    "dev": "astro dev",
-    "start": "astro dev",
-    "build": "astro build",
-    "preview": "astro preview",
-    "astro": "astro"
-  },
-  "dependencies": {
-    "@astrojs/starlight": "^0.11.1",
-    "@fontsource/dm-sans": "^5.0.15",
-    "@fontsource/jetbrains-mono": "^5.0.15",
-    "astro": "^3.2.3",
-    "sharp": "^0.32.5"
-  },
-  "devDependencies": {
-    "prettier": "^3.0.3"
-  }
-}

docs/src/content/config.ts

@@ -1,7 +0,0 @@
-import { defineCollection } from 'astro:content';
-import { docsSchema, i18nSchema } from '@astrojs/starlight/schema';
-
-export const collections = {
-  docs: defineCollection({ schema: docsSchema() }),
-  i18n: defineCollection({ type: 'data', schema: i18nSchema() }),
-};

docs/src/content/docs/index.mdx

@@ -1,52 +0,0 @@
----
-title: CounterStrikeSharp
-description: Write Counter-Strike 2 server plugins in C#.
-template: splash
-hero:
-  tagline: <code class="csharp">CounterStrikeSharp</code> is a simpler way to write CS2 server plugins.
-  actions:
-    - text: Get started
-      link: ./guides/getting-started/
-      icon: right-arrow
-      variant: primary
-    - text: Browse source
-      link: https://github.com/roflmuffin/CounterStrikeSharp/
-      icon: github
----
-
-```csharp
-using CounterStrikeSharp.API.Core;
-
-namespace HelloWorldPlugin;
-
-public class HelloWorldPlugin : BasePlugin
-{
-    public override string ModuleName => "Hello World Plugin";
-
-    public override string ModuleVersion => "0.0.1";
-
-    public override string ModuleAuthor => "roflmuffin";
-
-    public override string ModuleDescription => "Simple hello world plugin";
-
-    public override void Load(bool hotReload)
-    {
-        Logger.LogInformation("Plugin loaded successfully!");
-    }
-
-    [GameEventHandler]
-    public HookResult OnPlayerConnect(EventPlayerConnect @event, GameEventInfo info)
-    {
-        // Userid will give you a reference to a CCSPlayerController class
-        Logger.LogInformation("Player {Name} has connected!", @event.Userid.PlayerName);
-
-        return HookResult.Continue;
-    }
-
-    [ConsoleCommand("issue_warning", "Issue warning to player")]
-    public void OnCommand(CCSPlayerController? player, CommandInfo command)
-    {
-        Logger.LogWarning("Player shouldn't be doing that");
-    }
-}
-```

docs/src/env.d.ts

@@ -1,2 +0,0 @@
-/// <reference path="../.astro/types.d.ts" />
-/// <reference types="astro/client" />

docs/src/styles/custom.css

@@ -1,19 +0,0 @@
-:root {
-  --sl-font: 'DM Sans', serif;
-  --sl-font-mono: 'Jetbrains Mono', monospace;
-}
-
-.hero {
-  grid-template-columns: 1fr;
-}
-
-.hero .copy {
-  align-items: center;
-}
-
-.hero .actions {
-  justify-content: center;
-}
-
-.hero {
-}

docs/tsconfig.json

@@ -1,3 +0,0 @@
-{
-  "extends": "astro/tsconfigs/strict"
-}

src/core/managers/server_manager.cpp

@@ -172,17 +172,16 @@ void ServerManager::PreWorldUpdate(bool bSimulating)
 {
     std::lock_guard<std::mutex> lock(m_nextWorldUpdateTasksLock);
 
-    if (m_nextWorldUpdateTasks.empty())
-        return;
-
-    CSSHARP_CORE_TRACE("Executing queued tasks of size: {0} at time {1}", m_nextWorldUpdateTasks.size(),
+    if (!m_nextWorldUpdateTasks.empty()) {
+        CSSHARP_CORE_TRACE("Executing queued tasks of size: {0} at time {1}", m_nextWorldUpdateTasks.size(),
                        globals::getGlobalVars()->curtime);
 
-    for (size_t i = 0; i < m_nextWorldUpdateTasks.size(); i++) {
-        m_nextWorldUpdateTasks[i]();
-    }
+        for (size_t i = 0; i < m_nextWorldUpdateTasks.size(); i++) {
+            m_nextWorldUpdateTasks[i]();
+        }
 
-    m_nextWorldUpdateTasks.clear();
+        m_nextWorldUpdateTasks.clear();
+    }
 
     auto callback = globals::serverManager.on_server_pre_world_update;