Skip to content

GhoulMage/GhoulMage.LethalCompany

Repository files navigation

GhoulMage.LethalCompany v2.0.0 (stable)

Common API for some Lethal Company plugins. Free to use.

Features

  • GhoulMagePlugin - Abstract class that automatically manages compatibility with the game (see LethalGameVersions class)
  • LC_Info - Info about the game. For now just convenient shortcuts for the game version and check if a plugin is loaded.
  • Templates for quickly creating a GhoulMagePlugin using VSCode and Visual Studio

Soft Dependencies

  • LC_API - For correctly fetching the game version if ModdedServer.ModdedOnly is true.

Bugs

  • Shouldn't have.


Report any bugs, improvements, incompatibilities or push request the appropiate fixes and I'll look into them.

Change-log

  • 2.0.0

    • Updated to consider LC_API 3.0.0
    • Changed uint Version to string Version (major.minor.patch format) in the GhoulMagePlugin class. Currently 1.0.1 due to no real breaking changes
    • Renamed class 'LethalApp' to 'LC_Info' to better reflect the class' responsibility.
    • Move 'VersionPrefix' from LethalGameVersions to 'LC_Info'
    • Added const string APIVersion in GhoulMagePlugin class to quickly refer to the GhoulMage.LethalCompany Assembly version.
    • Added some XML comments on some stuff for better documentation.
  • 1.0.0

    • First Version

For Players

Go into Releases and download the latest version.

For Devs

  1. There are templates for vscode and visual studio

  • GhoulMagePlugin.Version refers to GhoulMagePlugin's api.
  • GhoulMagePlugin.APIVersion refers to the Assembly's api.
  • After important api changes, GhoulMagePlugin.Version and GhoulMagePlugin.APIVersion will update accordingly.
  1. Dependencies
  • Assembly-CSharp.dll (From Lethal Company_Data/Managed)
  • UnityEngine.dll

  1. Build
  • Build normaly using dotnet or whatever.

  1. Copyright
  • MIT License. For details see LICENSE

About

Generic API for Lethal Company mods using BepinEx

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages