Skip to content

Properties

Bawnorton edited this page Aug 4, 2025 · 1 revision

The configurable.properties file is necessary for Configurable to know what to call your config and what type it should serialise to.

This file is expected to be at your project root as it is referenced via System.getProperty(user.dir)

Entries

name

The name of your config

  • Mandatory
  • Case Sensitive

type

The type of your config

  • Optional
  • Accepts toml, json5
  • Case Insensitive
  • Defaults to json5

naming_policy

The default way fields are named

  • Optional
  • accepts IDENTITY, UPPER_CASE_WITH_UNDERSCORES, LOWER_CASE_WITH_UNDERSCORES, LOWER_CASE_WITH_DASHES, LOWER_CASE_WITH_DOTS
  • Case Insensitive
  • Defaults to LOWER_CASE_WITH_UNDERSCORES

Example:

name=my_config
type=toml
naming_policy=lower_case_with_dashes

Clone this wiki locally