Please don't publish the mods you have made with the API as long as TeacherAPI 0.1.0 is not released on GameBanana.
Right now, there is no official builds of Teacher Extensions (Foxo, Null, Viktor, Alice) on Gamebanana. Although, you can find preview builds on the Discord.
Using NuGet, add your package in your csproj. Right click on Dependencies > Manage NuGet Packages and install the last version.
You can also add this as a PackageReference if you can't figure it out in your csproj file
<PackageReference Include="Sakyce.TeacherAPI" Version="0.*" />
<PackageReference Include="Sakyce.TeacherAPI.Analyzers" Version="*" /> <!-- Not required but recommended -->If you want to already start with something, you can fork this Example Teacher and create your own Teacher from it. (Very recommended!)
Warning
Only use the NuGet package for adding TeacherAPI as a dependency, don't add the dll as a dependency as it's considered bad practice!
- Include options to disable your teacher as main, and disable your teacher as assistant, as well as tweaking weights.
- Only make your teacher an assistant if you have tested it and made sure it's at least compatible with most teachers provided by the mod.
- Separate your teacher dll from other features in your mod to be friendly with modpacks.
Send help... please.
Important
Try to reproduce the error without the others mods installed to make sure that it is caused by TeacherAPI and not an unrelated mod! We don't want to debug your big modpack.
Warning
We don't provide compatibility support with unstable/proprietary/closed-source/poorly coded mods like Sugaku Modpack or Level Editor. We also don't provide support for outdated mods or mods marked as hardly imcompatible.
If you have a Github Account, report the issue as usual. Although, we require you to do these steps first:
- Make sure that you have enabled those settings in BepInEx.cfg in your installation. Restart your game to apply changes:
[Logging.Disk]
WriteUnityLog = true
[Logging.Console]
Enabled = true-
Attach a screenshot the full console window with the logs in it.
-
Attach a screenshot of the plugins folder like this:
-
Attach the LogOutput file from
BepInEx/LogOutput.log. If you think the issue is from somewhere else, avoid posting first. Make sure that an error like this will actually appear in the file: (please note that the error doesn't come from TeacherAPI or its associated mods in this example). Don't send any screenshot, send the file directly!
[Error : Unity Log] ArgumentException: The Object you want to instantiate is null.
Stack trace:
Object UnityEngine.Object.Instantiate(Object original, Transform parent, bool instantiateInWorldSpace)
CursorController UnityEngine.Object.Instantiate<CursorController>(CursorController original, Transform parent, bool worldPositionStays)
CursorController UnityEngine.Object.Instantiate<CursorController>(CursorController original, Transform parent)
void CursorInitiator.Inititate()
void CursorInitiator.OnEnable()
UnityEngine.GameObject:AddComponent()
PineDebug.PineDebugManager:InitUI()
PineDebug.PineDebugManager:Initialize()
PineDebug.BasePlugin:Postload()
MTM101BaldAPI.MTM101BaldiDevAPI:OnSceneUnload()
MTM101BaldAPI.<ReloadScenes>d__19:MoveNext()
UnityEngine.SetupCoroutine:InvokeMoveNext(IEnumerator, IntPtr)
- Explain us how to reproduce the steps, what do you see, what it's supposed to happen.
Tip
Spare us the work of searching which mod is incompatible by removing every mods, then add mods one by one until it breaks.
- If you don't follow these steps correctly, your issue will be closed as not completed without any explaination.
If you don't have Github, you can report it in the appropriate channel in the Official Discord Guild, still do the same steps as mentionned earlier or Baldi will get angry.
Note
Your report on Discord can still be rejected if it badly follows the instructions. We will link you to this page as a warning.