Browse Source

Tweaked some things with doc generation

pull/62/head
Anairkoen Schno 4 years ago
parent
commit
51281860ee
Signed by: DaNike GPG Key ID: BEFB74D5F3FC4387
4 changed files with 4 additions and 6 deletions
  1. +1
    -0
      IPA.Loader/Config/SelfConfig.cs
  2. +0
    -3
      docs/articles/dev-resources/manifest.json
  3. +2
    -2
      docs/articles/start-dev.md
  4. +1
    -1
      docs/build.ps1

+ 1
- 0
IPA.Loader/Config/SelfConfig.cs View File

@ -153,6 +153,7 @@ namespace IPA.Config
"BeatmapCore.dll", "GameplayCore.dll","HMLibAttributes.dll",
#else // otherwise specify Assembly-CSharp.dll
"Assembly-CSharp.dll"
// LINE: ignore
#endif
};
// LINE: ignore


+ 0
- 3
docs/articles/dev-resources/manifest.json View File

@ -9,9 +9,6 @@
"id": null,
"name": "Demo Plugin",
"version": "0.0.1",
"features": [
],
"links": {
"project-home": "https://example.com/demo-plugin",
"project-source": "https://github.com/exampleman/demo-plugin/",


+ 2
- 2
docs/articles/start-dev.md View File

@ -47,7 +47,7 @@ If you are starting from scratch, you will need one other thing to get your plug
A basic manifest for that might look a little like this:
[!code-json[manifest.json](./dev-resources/manifest.json?range=1,3,4,6-12,14-19,23-)]
[!code-json[manifest.json](./dev-resources/manifest.json?range=1,3,4,6-12,14-16,20-)]
There is a lot going on there, but most of it should be decently obvious. Among the things that *aren't* immediately obvious,
are
@ -72,7 +72,7 @@ At this point, if the main plugin source file and the manifest are in the same s
project's default namespace, the plugin will load just fine. However, this is somewhat difficult both to explain and verify, so I
recommend you use the the `misc.plugin-hint` field in your manifest. It can be used like so:
[!code-json[manifest.json#misc.plugin-hint](./dev-resources/manifest.json?range=20-22)]
[!code-json[manifest.json#misc.plugin-hint](./dev-resources/manifest.json?range=17-19)]
With this, you can set `plugin-hint` to the full typename of your plugin type, and it will correctly load. This is a hint though,
and will also try it as a namespace if it fails to find the plugin type. If that fails, it will then fall back to using the manifest's


+ 1
- 1
docs/build.ps1 View File

@ -90,7 +90,7 @@ class RoslynCompilerSettings : Microsoft.CodeDom.Providers.DotNetCompilerPlatfor
$schema.ToString() | Out-File "other_api/config/_schema.json"
}
$ipaExe = "$ipaRoot/bin/Release/IPA.exe"
$ipaExe = "$ipaRoot/bin/Release/net461/IPA.exe"
# generate IPA.exe args file
if (-not (Test-Path $ipaExe -PathType Leaf)) {
msbuild -p:Configuration=Release -p:Platform=AnyCPU -p:SolutionDir=.. "$ipaRoot/IPA.csproj"


Loading…
Cancel
Save