Merge branch 'main' into sup43-condebug

Author: SupinePandora43

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "gmodnet.versiontool": {
-      "version": "0.2.0-alpha.1.22426226.dev",
+      "version": "2.0.0-alpha.1.41543664.main",
       "commands": [
         "gmodnet-vt"
       ]

.github/workflows/ci.yml

@@ -4,12 +4,12 @@ on: [push, pull_request]
 
 env:
   GMODNET_VERSION: '0.6.0'
-  DOTNET_SDK_VERSION: '5.0.100'
+  DOTNET_SDK_VERSION: '5.0.300'
 
 jobs:
  linux-build:
 
-   runs-on: ubuntu-latest
+   runs-on: ubuntu-20.04
 
    steps:
     - name: Checkout
@@ -51,8 +51,16 @@ jobs:
     - name: Run Garry's Mod
       run: ./srcds_run_x64 -game garrysmod -systemtest -condebug +sv_hibernate_think 1 || true
       working-directory: ./gmod/
-      timeout-minutes: 5
+      timeout-minutes: 1
       continue-on-error: true
+      env:
+        COREHOST_TRACE: 1
+        COREHOST_TRACE_VERBOSITY: 4
+        COREHOST_TRACEFILE: corehost_trace.txt
+
+    - name: Print Corehost trace
+      working-directory: ./gmod/
+      run: cat corehost_trace.txt
 
     - name: Print test log
       run: cat gmod/tests-log.txt
@@ -281,7 +289,7 @@ jobs:
 
  deploy-and-notify:
 
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-18.04
 
     needs: [linux-build, windows-build, mac-build]
 

docfx_project/api-fusion/index.md

@@ -0,0 +1,8 @@
+# GmodDotNet API Documentation
+GmodDotNet consists of two main components: [GmodNET.API package](https://www.nuget.org/packages/GmodNET.API/), a .NET library which contains methods, types, and interfaces needed for writing Garry's Mod modules, and core GmodDotNet runtime, which supports, manages, and loads .NET modules directly into the game process.
+
+Thus GmodDotNet documentation covers two public API layers:
+
+1) [Docs for GmodNET.API](/api/GmodNET.API.html) .NET library.
+
+2) [Docs for dotnet Lua library](/lua-api/dotnet.html) exposed by the core GmodDotNet runtime to manage modules (load and unload them).

docfx_project/api-fusion/toc.yml

@@ -0,0 +1,4 @@
+- name: .NET API
+  href: ../api/toc.yml
+- name: Lua API
+  href: ../lua-api/toc.yml

docfx_project/docfx.json

@@ -29,6 +29,18 @@
           "toc.yml",
           "*.md"
         ]
+      },
+      {
+        "files": [
+          "api-fusion/**.md",
+          "api-fusion/**.yml"
+        ]
+      },
+      {
+        "files": [
+          "lua-api/**.md",
+          "lua-api/**.yml"
+        ]
       }
     ],
     "resource": [
@@ -51,6 +63,10 @@
     ],
     "dest": "_site",
     "globalMetadataFiles": [],
+    "globalMetadata": {
+      "_appLogoPath": "images/gmodnetlogo-50px.png",
+      "_appFaviconPath": "images/favicon.ico"
+    },
     "fileMetadataFiles": [],
     "template": [
       "default",
@@ -61,6 +77,9 @@
     "noLangKeyword": false,
     "keepFileLink": false,
     "cleanupCacheHistory": false,
-    "disableGitFeatures": false
+    "disableGitFeatures": false,
+    "xrefService": [
+      "https://xref.docs.microsoft.com/query?uid={uid}"
+    ]
   }
 }

docfx_project/images/favicon.ico

@@ -1,4 +1,3 @@
-# This is the **HOMEPAGE**.
-Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
-## Quick Start Notes:
-1. Add images to the *images* folder if the file is referencing an image.
+# GmodDotNet documentation
+
+This is an early preview of the GmodDotNet documentation. Work is still in progress.

docfx_project/images/gmodnetlogo-50px.png

@@ -0,0 +1,53 @@
+# dotnet
+The Lua library to interact with the GmodDotNet runtime.
+This library is added to the Lua global scope after GmodDotNet runtime is loaded to the game with
+`require("dotnet")` (see [require](https://wiki.facepunch.com/gmod/Global.require) for more info).
+
+## Functions
+
+### load(string)
+Loads a GmodDotNet module by its name.
+
+##### Declaration
+```lua
+boolean dotnet.load(string module_name)
+```
+
+##### Parameters
+| Type | Name | Description |
+|------|------|-------------|
+| [string](https://wiki.facepunch.com/gmod/string) | module_name | A name of the module to load |
+
+##### Returns
+| Type | Description |
+|------|-------------|
+| [boolean](https://wiki.facepunch.com/gmod/boolean) | `True`, if the module was loaded successfully, `False` otherwise.|
+
+##### Remarks
+Loads a GmodDotNet module at path `[garrys mod (or dedicated server) root folder]/garrysmod/lua/bin/Modules/[module name]/[module name].dll`.
+
+Module must be accompanied by all its dependencies and `[module name].deps.json` file.
+In practice it means that folder `[garrys mod root folder]/garrysmod/lua/bin/Modules/[module name]` must contain the full output of [`dotnet publish`](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-publish) operation of dotnet sdk.
+
+If GmodDotNet runtime is not able to load the module, the function will return `False`, and the error message will be printed to a game console.
+
+### unload(string)
+Unloads a GmodDotNet module by its name.
+
+##### Declaration
+```lua
+boolean dotnet.unload(string module_name)
+```
+
+##### Parameters
+| Type | Name | Description |
+|------|------|-------------|
+| [string](https://wiki.facepunch.com/gmod/string) | module_name | A name of the module to unload |
+
+##### Returns
+| Type | Description |
+|------|-------------|
+| [boolean](https://wiki.facepunch.com/gmod/boolean) | `True`, if the module was unloaded successfully, `False` otherwise.|
+
+##### Remarks
+If GmodDotNet runtime is not able to unload the module (exception was thrown while unloading, module is not able to free its resources, module with given name is not loaded, etc.), the function will return `False`, and the error message will be printed to a game console.

docfx_project/index.md

@@ -0,0 +1,4 @@
+- name: GmodDotNet
+  items:
+    - name: dotnet
+      href: dotnet.md