Configuration

config.yml holds the server wide settings: languages, storage, limits, posting modes and menu steps, progress, tax, broadcasts, ratings and the admin log. Currencies live in currencies.yml, job types in job-types.yml and menus in the menus folder.

Apply changes with /hirehall admin reload. Only storage and jobs.expiry-check-seconds need a restart.

General

Key	What it does	Default
`config-version`	File version, do not change	`2`
`language`	Language file from the `lang` folder. See Messages and language	`en_US`
`menu-language`	Language the menu files and `job-types.yml` are made in the first time they are created. `auto` follows `language`. Bundled: `en_US`, `fr_FR`, `es_ES`. See Menu language	`auto`

storage

See Storage for details. Changes need a restart.

Key	What it does	Default
`storage.type`	`SQLITE` or `MYSQL`	`SQLITE`
`storage.sqlite-file`	SQLite file inside the plugin folder	`data.db`
`storage.table-prefix`	Text in front of every table name. Letters, numbers and `_` only, anything else falls back to the default	`hirehall_`
`storage.mysql.host`	MySQL host	`localhost`
`storage.mysql.port`	MySQL port	`3306`
`storage.mysql.database`	Database name	`hirehall`
`storage.mysql.username`	User	`root`
`storage.mysql.password`	Password	empty
`storage.mysql.use-ssl`	Use an SSL connection	`false`
`storage.mysql.pool-size`	Most connections kept open, at least 2	`10`

limits

Key	What it does	Default
`limits.default-employ-slots`	Workers a player may have hired at one time, when they have no `hirehall.limit.<n>` permission	`3`
`limits.default-job-slots`	Jobs a player may work on at one time, when they have no `hirehall.jobs.<n>` permission	`3`
`limits.max-open-postings`	Open and offered jobs one employer may have at one time, at least 1	`5`
`limits.post-cooldown-seconds`	Seconds between two posts by the same player	`30`
`limits.max-payment-stacks`	Most item stacks in one item payment	`27`
`limits.max-deadline-hours`	Longest deadline an employer may choose	`168`
`limits.max-quantity`	Largest amount any job may ask for. Job types with `max-quantity: 0` use this. `0` means no limit of your own, amounts are still capped at 1,000,000,000	`1000000`

See Permissions for the limit permissions.

posting

These set the buttons in the posting menus.

Key	What it does	Default
`posting.modes.community`	Allow community jobs	`true`
`posting.modes.exclusive`	Allow jobs one player takes and finishes	`true`
`posting.modes.direct-offer`	Allow direct offers	`true`
`posting.default-mode`	Mode selected when posting starts: `COMMUNITY`, `EXCLUSIVE` or `DIRECT`	`EXCLUSIVE`
`posting.default-pricing`	Pricing selected when posting starts: `UNIT` (price per unit) or `TOTAL` (one price)	`UNIT`
`posting.quantity-steps`	Plus and minus steps on the amount menu	`[1, 10, 100]`
`posting.money-steps`	Plus and minus steps on the currency menu	`[1, 10, 100, 1000]`
`posting.deadline-hours`	Deadline choices in hours	`[1, 6, 12, 24, 72, 168]`
`posting.max-note-length`	Longest note an employer may write	`60`

The mode step is skipped when only one mode is available. See Posting modes.
Zero and negative values in the lists are ignored. An empty list falls back to the default.
deadline-hours values above limits.max-deadline-hours are left out.
Each step and deadline needs a slot in its menu template. The default menus have 3 quantity steps, 4 money steps and 7 deadline slots. See Templates.

jobs

Key	What it does	Default
`jobs.milestones`	Progress percentages at which the employer gets a message. Values from 1 to 99	`[25, 50, 75]`
`jobs.deadline-warning-minutes`	Minutes before the deadline when the worker is warned	`30`
`jobs.expiry-check-seconds`	How often deadlines are checked, at least 5. Needs a restart	`20`
`jobs.exclude-spawner-mobs`	Stop mobs from spawners counting toward hunting jobs	`false`
`jobs.delivery-only`	Hide every job type in `ACTIVITY` mode, so every job ends with items handed in. See Activity or delivery	`false`

A job can expire up to expiry-check-seconds after its deadline, since that is how often deadlines are checked.

tax

Key	What it does	Default
`tax.enabled`	Take a share of every money payout for finished work	`false`
`tax.percent`	The share, from 0 to 100	`5.0`

See Server tax.

broadcast

Key	What it does	Default
`broadcast.enabled`	Announce new board jobs that pay well	`true`
`broadcast.thresholds`	Pay per currency id at or above which a job is announced. Currencies not listed are never announced	`vault: 10000`

See Broadcasts.

ratings

Key	What it does	Default
`ratings.enabled`	Let employers rate completed jobs	`true`

admin-log

Key	What it does	Default
`admin-log.enabled`	Write admin actions to `logs/admin.log`	`true`
`admin-log.max-size-kb`	Size at which the log rolls over, at least 16	`512`
`admin-log.keep-files`	Old log files kept	`5`

See Admin log.

Updating

When a new version adds keys, they are added to your config.yml on startup with their defaults. Your own values are kept.

On this page