LocaleLibrary

v1.0.0·Updated 2024-05-28

A library to add and use localizations in Content Warning in almost exactly the same way the base game does.

About this mod Author’s original text

LocaleLibrary

A library to add and use localizations in Content Warning in almost exactly the same way the base game does.

Mod Usage

Download the latest dll from the releases tab or clone and build the repo, then add it as a reference to the project. After adding it as a reference you can add it as a dependency:

[BepInDependency(LocaleLibrary.MyPluginInfo.PLUGIN_GUID)] // Make sure to specify if it's a soft or a hard dependency! BepInEx sets dependencies to hard by default.

public class YourMod: BaseUnityPlugin { //...

Integration

For in-depth documentation, check out the documentation! Examples are included in the documentation, demos are not available at this point in time.

Additions

By itself, this does nothing! This is a library for mod developers to add translations to their mods or add translations for the base game.

Issues

If the mod is throwing an error use the github issues page and copy-paste the error in there, with a description of what is happening and what you expected to happen if applicable. Or just ping me at the Content Warning Modding Discord server!

Install & use Install: BepInEx plugin

  1. The archive from playbuff is the mod itself — usually a BepInEx plugin (a .dll or a plugin folder once unzipped).
  2. Recommended: use a community mod manager (such as r2modman) — pick this game, import the mod, and the manager sets up BepInEx and its dependencies for you.
  3. Manual route: install the BepInEx loader in the game folder, then drop the unzipped .dll or plugin folder into BepInEx/plugins/.
  4. Launch the game — the BepInEx console logs every plugin it loads; seeing this mod in the log means it is installed.

Mods with listed dependencies need those installed too, or they will not load. Options are usually changed in-game or in the plugin's config file.

Dependencies

Install these first, or the mod will not work:

BepInEx-BepInExPack

File & checksum

Filename
LocaleLibrary-1.0.0.zip
File size
39.0 KiB