Pages

Configuration File - Version 3

AutoSave Version 2.x.x uses a YAML backed configuration file located at "plugins/AutoSave/config.yml", the following should explain what each option means:

  • var.interval: Number of seconds between saves
  • var.warntime: n time before the save happens when a warning is broadcast to players (a list of values, each value on separate line)
  • var.broadcast: True or False value specifying if broadcasts should be used
  • var.report: Toggles reporting thread
  • var.uuid: Anonymous identification
  • var.worlds: List of loaded worlds to be saved. * indicates ALL worlds will be saved (each value on separate line)
  • var.debug: True or False value specifying for additional console output
  • var.mode: Either SYNCHRONOUS or ASYNCHRONOUS, for more information on this option, see the Performance page.
  • value.off: Customizable value of "off"
  • value.on: Customizable value of "on"
  • message.status.fail: Message sent to player when using /save status when there is an error.
  • message.status.notrun: Message sent to player when using /save status when the AutoSave thread is not running.
  • message.status.off: Message sent to player when using /save status when AutoSave is disabled
  • message.insufficentpermissions: Customizable generic insufficient permissions message
  • message.broadcast.prost: Message broadcast to all players after save completed
  • message.broadcast.pre: Message broadcast to all players prior to save
  • message.stopping: Message logged to console when AutoSave thread stops.
  • message.starting: Message logged to console when AutoSave thread starts.
  • message.warning: Customizable warning message
  • message.version: Customizable version message
  • message.info.nan: Error message about input being Not a Number
  • message.info.invalid: Error message for selecting invalid options.
  • message.info.listlookup: Response of variables in a list.
  • message.info.changesuccess: Response of a variable change.
  • message.info.lookup: Response of a variable lookup.

An example: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
var:
    interval: 300
    warntime:
    - 0
    broadcast: true
    report: true
    uuid: 7424cfb8-4196-4dca-8ca8-42600dede5ba
    worlds:
    - '*'
    debug: false
    mode: SYNCHRONOUS
value:
    'off': 'off'
    'on': 'on'
messages:
    status:
        fail: '&9AutoSave has stopped, check the server logs for more info'
        notrun: '&9AutoSave is running but has not yet saved.'
        'off': '&9AutoSave is not running (disabled)'
        success: '&9AutoSave is running and last saved at ${DATE}.'
    insufficentpermissions: '&cYou do not have access to that command.'
    broadcast:
        post: '&cAutoSave Complete'
        pre: '&CAutoSaving'
    starting: '&9AutoSave Starting'
    stopping: '&9AutoSave Stopping'
    warning: '&9Warning, AutoSave will commence soon.'
    version: '&9AutoSave v${VERSION}, Instance ${UUID}'
    info:
        nan: '&cYou must enter a valid number, ex: 300'
        invalid: '&cYou must enter a valid setting (${VALIDSETTINGS})'
        listlookup: '&9${VARIABLE} is set to [${VALUE}]'
        changesuccess: '&9${VARIABLE} has been updated.'
        lookup: '&9${VARIABLE} is ${VALUE}'