ContentSettings

A library for adding custom settings to Content Warning.

Features

• [x] Register custom settings
  • [x] Manual registration
  • [x] Attribute-based registration
  • [x] Custom categories
• [x] Addition inputs
  • [x] Text input (TextField)
  • [x] Integer input (Slider)
  • [x] Boolean input (Checkbox)

Planned

• [ ] More input types
• [ ] Networking support

Usage

If you just want to look at some code, take a look at the Example Plugin.

Registering a Setting

void Awake()
{
    SettingsLoader.RegisterSetting("YOUR TAB", new ExampleSetting());
}

public class ExampleSetting : FloatSetting, ICustomSetting
{
    public override void ApplyValue()
    {
        // Do something with the value
    }

    public override float GetDefaultValue() => 0.5f;

    public override float2 GetMinMaxValue() => new(0f, 1f);

    public string GetDisplayName() => "Example Setting";
}  

Contributing

This repository follows Conventional Commits

Commits will be rejected automatically if they do not follow the format specified below.

Format

<type>(optional scope): <description>

Example: feat(pre-event): add speakers section

Credits

• CommanderCat - Creator and Developer
• dhkatz - Developer and Maintainer

License

Released under GPL-3.0 by @Commander-Cat101.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

v1.2.1 - 2024-04-22

What's Changed

• fix(api): fix empty category not displaying before normal categories by @dhkatz in https://github.com/Commander-Cat101/ContentSettings/pull/16

Full Changelog: https://github.com/Commander-Cat101/ContentSettings/compare/v1.2.0...v1.2.1

v1.2.0 - 2024-04-22

What's Changed

• feat(api): use BepInAutoPlugin to define plugin classes by @dhkatz in https://github.com/Commander-Cat101/ContentSettings/pull/12
• docs(readme): improve README.md by adding example and commit guidelines by @dhkatz in https://github.com/Commander-Cat101/ContentSettings/pull/13
• feat(api): add new IntSetting and BoolSetting types and support pages by @dhkatz in https://github.com/Commander-Cat101/ContentSettings/pull/15

Full Changelog: https://github.com/Commander-Cat101/ContentSettings/compare/v1.1.0...v1.2.0

v1.0.2 - 2024-04-12

v1.0.1 - 2024-04-05

Fixed

• Fixed release on Thunderstore.

v1.0.0 - 2024-04-04

Fixed

• Fixed an issue with access rights due to the use of non-publicized DLLs.

v0.0.1 - 2024-04-03

Added

• Initial release of ContentSettings.