Skip to content

Latest commit

 

History

History
44 lines (33 loc) · 1.82 KB

README.md

File metadata and controls

44 lines (33 loc) · 1.82 KB
Raw

CelesteMod.Templates

Templates for Celeste code mods!

NuGet

Prerequisites:

  • Celeste
  • Everest
  • .NET SDK
  • A C# IDE (Visual Studio, Rider, Code, Nano, etc.)

Installation:

dotnet new install CelesteMod.Templates

From your Celeste/Mods directory:

mkdir MyCoolMod
cd MyCoolMod
dotnet new celestemod

This will create a solution for your mod and a series of classes in the namespace Celeste.Mod.MyCoolMod ready for you to start developing.

Available parameters:

  • --Samples: Creates a set of sample entities and triggers, including Ahorn and Lönn plugins. (Defaults to false)
  • --Exports: Includes a static class for use with MonoMod.ModInterop. (Defaults to false)
  • --Settings : Includes a blank EverestModuleSettings class and configures the module to look for it. (Defaults to true)
  • --Session : Includes a blank EverestModuleSession class and configures the module to look for it. (Defaults to true)
  • --SaveData : Includes a blank EverestModuleSaveData class and configures the module to look for it. (Defaults to true)
  • --Logging : Sets logging level to Info specifically for release builds instead of the default Verbose. (Defaults to true)
  • --GitHub : Generates a GitHub action for building your mod. (Defaults to false)
  • --Legacy : Generates a mod for use with legacy Everest. This is only required if you want people to use your mod on versions of Everest older than 4465. (Defaults to false)

These can specified in the following way:

# Creates a new mod with sample entities, a GitHub build action, and a MonoMod export class 
dotnet new celestemod --Samples --GitHub --Exports