Browse Source

Updated a bunch of documentation shit

4.0.0-beta
Anairkoen Schno 4 years ago
parent
commit
1337c7527e
10 changed files with 41 additions and 16 deletions
  1. +1
    -1
      docs/api/index.md
  2. +4
    -0
      docs/articles/command-line.md
  3. +1
    -1
      docs/articles/index.md
  4. +4
    -0
      docs/articles/start-dev.md
  5. +4
    -0
      docs/articles/start-user.md
  6. +24
    -2
      docs/build.ps1
  7. +2
    -6
      docs/index.md
  8. +0
    -1
      docs/other_api/config/index.md
  9. +0
    -2
      docs/other_api/index.md
  10. +1
    -3
      docs/other_api/toc.yml

+ 1
- 1
docs/api/index.md View File

@ -1,4 +1,4 @@
# BSIPA API Documentation
Welcome to the full class documentation! To see guides, head over to the [Articles tab](xref:getting_started).
Welcome to the full class documentation! To see guides, head over to the [Articles tab](xref:articles.start).
Select a namespace and a class on the left to get started.

+ 4
- 0
docs/articles/command-line.md View File

@ -1,3 +1,7 @@
---
uid: articles.command_line
---
# The Command Line
BSIPA has 2 command lines: the installer, and the game.


+ 1
- 1
docs/articles/index.md View File

@ -1,5 +1,5 @@
---
uid: getting_started
uid: articles.start
---
# Getting Started


+ 4
- 0
docs/articles/start-dev.md View File

@ -1,2 +1,6 @@
---
uid: articles.start.dev
---
# Creating your own mod

+ 4
- 0
docs/articles/start-user.md View File

@ -1,3 +1,7 @@
---
uid: articles.start.user
---
# Installing BSIPA
> [!NOTE]


+ 24
- 2
docs/build.ps1 View File

@ -1,19 +1,25 @@
# read SelfConfig, remove wierd bits, load it, load Newtonsoft, and turn it into a schema
$newtonsoftLoc = "$(Get-Location)/nuget/Newtonsoft.Json.12.0.2/lib/netstandard2.0/Newtonsoft.Json.dll"
$newtonsoftSchemaLoc = "$(Get-Location)/nuget/Newtonsoft.Json.Schema.3.0.11/lib/netstandard2.0/Newtonsoft.Json.Schema.dll"
$roslynCodeDomBase = "$(Get-Location)/nuget/Microsoft.CodeDom.Providers.DotNetCompilerPlatform.2.0.1"
$roslynCodeDom = "$roslynCodeDomBase/lib/net45/Microsoft.CodeDom.Providers.DotNetCompilerPlatform.dll"
$selfConfigLoc = "../IPA.Loader/Config/SelfConfig.cs"
$ipaRoot = "../IPA"
if (!(Test-Path "nuget" -PathType Container)) {
nuget install Newtonsoft.Json -Version 12.0.2 -source https://api.nuget.org/v3/index.json -o "$(Get-Location)/nuget"
nuget install Newtonsoft.Json.Schema -Version 3.0.11 -source https://api.nuget.org/v3/index.json -o "$(Get-Location)/nuget"
nuget install Microsoft.CodeDom.Providers.DotNetCompilerPlatform -Version 2.0.1 -source https://api.nuget.org/v3/index.json -o "$(Get-Location)/nuget"
}
& docfx metadata
if ((Test-Path $newtonsoftLoc -PathType Leaf) -and (Test-Path $selfConfigLoc -PathType Leaf)) {
if ((Test-Path $newtonsoftLoc -PathType Leaf) -and (Test-Path $selfConfigLoc -PathType Leaf) -and (Test-Path $roslynCodeDom -PathType Leaf)) {
# The files we need exist, lets do this!
# Add the Roslyn CodeDom
Add-Type -Path $roslynCodeDom
# First load Newtonsoft
Add-Type -Path $newtonsoftLoc
Add-Type -Path $newtonsoftSchemaLoc
@ -56,7 +62,23 @@ if ((Test-Path $newtonsoftLoc -PathType Leaf) -and (Test-Path $selfConfigLoc -Pa
process { $_ -replace "internal", "public" }
}
Add-Type -TypeDefinition (Get-Content $selfConfigLoc | ProcessLines | Merge-Lines | FilterDef) -ReferencedAssemblies $newtonsoftLoc,"netstandard"
# set up the compiler settings
Invoke-Expression -Command @"
class RoslynCompilerSettings : Microsoft.CodeDom.Providers.DotNetCompilerPlatform.ICompilerSettings
{
[string] get_CompilerFullPath()
{
return "$roslynCodeDomBase\tools\RoslynLatest\csc.exe"
}
[int] get_CompilerServerTimeToLive()
{
return 10
}
}
"@
$codeDomProvider = [Microsoft.CodeDom.Providers.DotNetCompilerPlatform.CSharpCodeProvider]::new([RoslynCompilerSettings]::new())
Add-Type -CodeDomProvider $codeDomProvider -TypeDefinition (Get-Content $selfConfigLoc | ProcessLines | Merge-Lines | FilterDef) -ReferencedAssemblies $newtonsoftLoc,"netstandard"
# type will be [IPA.Config.SelfConfig]


+ 2
- 6
docs/index.md View File

@ -13,10 +13,6 @@ Beat Saber IPA - The mod injector tailored for Beat Saber
3. Run **IPA.exe**
4. Start the game as usual
A console window should open before the game starts if the installation was successful.
To disable this console window, pass `--no-console` to the game.
## How To Uninstall
1. Drag & drop the game exe onto **IPA.exe** while holding <kbd>Alt</kbd>
@ -37,10 +33,10 @@ Unconsumed arguments will be passed on to the game in case of `--launch`.
1. Create a new **Class Library** C# project (.NET 4.6)
2. Download a release and add **IPA.Loader.dll** to your references
3. Implement `IBeatSaberPlugin` or `IEnhancedBeatSaberPlugin`
3. Implement `IPA.IPlugin` or `IPA.IEnhancedPlugin`
4. Build the project and copy the DLL into the Plugins folder of the game.
See [Developing](https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/wiki/Developing) for more information.
See [Developing](xref:articles.start.dev) for more information.
## How To Keep The Game Patched


+ 0
- 1
docs/other_api/config/index.md View File

@ -1 +0,0 @@
# Title 2

+ 0
- 2
docs/other_api/index.md View File

@ -1,5 +1,3 @@
---
uid: other.index
---
# Title1

+ 1
- 3
docs/other_api/toc.yml View File

@ -4,6 +4,4 @@
href: config/schema.md
items:
- name: Schema
href: config/schema.md
- name: Index
href: config/index.md
href: config/schema.md

Loading…
Cancel
Save