Configuration: Difference between revisions

From Citizens Wiki

No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 8: Line 8:
   authlib:
   authlib:
     profile-url: https://sessionserver.mojang.com/session/minecraft/profile/ # generally shouldn't be touched, but allows you to configure a custom GameProfile server for advanced users
     profile-url: https://sessionserver.mojang.com/session/minecraft/profile/ # generally shouldn't be touched, but allows you to configure a custom GameProfile server for advanced users
  debug-chunk-loads: false # for advanced debugging of when chunks are loaded and why
   debug-file: '' # whether to log debug output to a file instead of to console
   debug-file: '' # whether to log debug output to a file instead of to console
   debug-mode: false # enables debugging mode with extra information on spawning, skin fetching, etc.
   debug-mode: false # enables debugging mode with extra information on spawning, skin fetching, etc.
   debug-pathfinding: false # enables pathfinding debugging which shows a visual display (yellow flowers) of where NPCs are pathfinding to
   debug-pathfinding: false # enables pathfinding debugging which shows a visual display (yellow flowers) of where NPCs are pathfinding to
   color-scheme:
   color-scheme:
     message-error: <c> # the error message colour, default red
     message-error: <red> # the error message colour, default red
     message-highlight: <e> # the highlight colour, default yellow
     message-highlight: <yelloe> # the highlight colour, default yellow
     message: <a> # the default message colour, default green
     message: <green> # the default message colour, default green
   translation:
   translation:
     locale: '' # if you want to use a specific language translation such as fr_FR etc.
     locale: '' # if you want to use a specific language translation such as fr_FR etc.
  reload-warning-enabled: true # whether to require /citizens reload entered twice
npc:
npc:
  always-use-name-holograms: false # whether to always use name holograms (armor stands) for nameplates rather than custom names
   chat:
   chat:
     options:
     options:
Line 25: Line 28:
       range: 5
       range: 5
       max-text-range: 500
       max-text-range: 500
      talk-to-npcs: true # whether to include NPCs in chat
     format:
     format:
       no-targets: '[<npc>]: <text>'
       no-targets: '[<npc>]: <text>'
Line 31: Line 35:
       with-targets-to-bystanders: '[<npc>] -> [<targets>]: <text>'
       with-targets-to-bystanders: '[<npc>] -> [<targets>]: <text>'
   pathfinding:
   pathfinding:
    new-finder:
      iterations-per-tick: 5000 # how many steps to run of the new pathfinder every tick. Useful when you want to spread pathfinding over multiple ticks
      check-bounding-boxes: false # whether to check bounding boxes of entities can fit e.g. through single block gaps or fences etc
      open-doors: false # whether to open/close doors while pathfinding
    defaults:
      destination-teleport-margin: -1 # teleport to the destination when below this threshold. e.g. you may want to teleport to the exact destination if <2 blocks away
     default-distance-margin: 2 # the distance from the goal to stop early while moving along a path measured in blocks squared
     default-distance-margin: 2 # the distance from the goal to stop early while moving along a path measured in blocks squared
     default-path-distance-margin: 1 # the distance from the goal to stop early while finding a path measured in blocks
     default-path-distance-margin: 1 # the distance from the goal to stop early while finding a path measured in blocks
     update-path-rate: 20 # how often to update the path in ticks, typically for entity targeting
     update-path-rate: 20 # how often to update the path in ticks, typically for entity targeting
     maximum-new-pathfinder-iterations: 50000 # the maximum number of blocks to search while pathfinding using the new pathfinder
     maximum-new-pathfinder-iterations: 10000 # the maximum number of blocks to search while pathfinding using the new pathfinder  
     new-finder-open-doors: false # whether the NPC should open doors while moving (new finder only)
     minecraft:
      max-fall-distance: 3 # the maximum fall distance to check while pathfinding (old pathfinder)
     attack-range: 3.0625
     attack-range: 3.0625
     use-new-finder: false # whether to use the built in Citizens A* pathfinder instead of Minecraft's  
     use-new-finder: false # whether to use the built in Citizens A* pathfinder instead of Minecraft's  
     disable-mc-fallback-navigation: true
     disable-mc-fallback-navigation: true # minecraft by default will try to use 'fallback' pathfinding where it returns the closest reachable block to the destination. by default try to reach the destination only.
   default:
   default:
    bossbar-view-range: 64 # the bossbar view range, blocks
     look-close:
     look-close:
       enabled: false
       enabled: false
       range: 5
       range: 5 # range in blocks
       random-look-enabled: false
       random-look-enabled: false
       random-look-delay: 60
       random-look-delay: 60 # delay in ticks
       disable-while-navigating: true
       disable-while-navigating: true
     pathfinding:
     pathfinding:
       range: 25.0 # the maximum pathfinding goal range in blocks
       range: 75.0 # the maximum pathfinding range to destination in blocks
     random-talker: true  
     random-talker: true  
     realistic-looking: false # whether to check line of sight when looking close
     realistic-looking: false # whether to check line of sight when looking close
     stationary-ticks: -1 # how many ticks can an NPC be stuck in the same block before teleporting to the goal / performing the 'stuck action'
     stationary-ticks: -1 # how many ticks can an NPC be stuck in the same block before teleporting to the goal / performing the 'stuck action'
    block-breaker-radius: -1 # the default radius in blocks for the NPC to pathfind to when breaking blocks
     talk-close:
     talk-close:
       enabled: false
       enabled: false
Line 56: Line 69:
     text: # default text
     text: # default text
       '0': Hi, I'm <npc>!
       '0': Hi, I'm <npc>!
    waypoints:
      cache-paths: false # whether to cache paths found for /npc path. eliminates pathfinding when used
   limits:
   limits:
     default-limit: 10
     default-limit: 10
Line 75: Line 90:
     use-latest-by-default: false # whether to always fetch new skin updates
     use-latest-by-default: false # whether to always fetch new skin updates
     view-distance: 100.0  
     view-distance: 100.0  
    placeholder-update-frequency-ticks: 6000 # how often to update skin placeholders, in ticks
   packets:
   packets:
     update-delay: 30 # performance option, lower = faster updates to equipment, higher = slower updates but more performance
     update-delay: 30 # performance option, lower = faster updates to equipment, higher = slower updates but more performance
Line 91: Line 107:
   player-scoreboard-teams:
   player-scoreboard-teams:
     enable: true
     enable: true
  follow:
    teleport-across-worlds: true # whether to teleport cross-world when /npc follow is enabled
  commands:
    global-delay-seconds: 1 # the global delay between click commands in seconds. set to 0 for no delay between commands
    error-messages:
      maximum-times-used: You have reached the maximum number of uses ({0}).
      missing-item: Missing {1} {0}
      no-permission: You don't have permission to do that.
      not-enough-experience: You need at least {0} experience.
      not-enough-money: You need at least ${0}.
      on-cooldown: Please wait for {minutes} minutes and {seconds_over} seconds.
      on-global-cooldown: Please wait for {minutes} minutes and {seconds_over} seconds.
advanced:
advanced:
   check-minecraft-version: true
   check-minecraft-version: true

Latest revision as of 16:28, 15 December 2022

Citizens configuration is handled in the file /plugins/Citizens/config.yml. See below for detailed information on each setting. For more information on text nodes such as <npc>, see the Text Syntax page.

Default Configuration

# Citizens Configuration

general:
  authlib:
    profile-url: https://sessionserver.mojang.com/session/minecraft/profile/ # generally shouldn't be touched, but allows you to configure a custom GameProfile server for advanced users
  debug-chunk-loads: false # for advanced debugging of when chunks are loaded and why
  debug-file: '' # whether to log debug output to a file instead of to console
  debug-mode: false # enables debugging mode with extra information on spawning, skin fetching, etc.
  debug-pathfinding: false # enables pathfinding debugging which shows a visual display (yellow flowers) of where NPCs are pathfinding to
  color-scheme:
    message-error: <red> # the error message colour, default red
    message-highlight: <yelloe> # the highlight colour, default yellow
    message: <green> # the default message colour, default green
  translation:
    locale: '' # if you want to use a specific language translation such as fr_FR etc.
  reload-warning-enabled: true # whether to require /citizens reload entered twice
npc:
  always-use-name-holograms: false # whether to always use name holograms (armor stands) for nameplates rather than custom names
  chat:
    options:
      bystanders-hear-targeted-chat: true 
      max-number-of-targets-to-show: 2
      multiple-targets-format: <target>|, <target>| & <target>| & others
      range: 5
      max-text-range: 500
      talk-to-npcs: true # whether to include NPCs in chat
    format:
      no-targets: '[<npc>]: <text>'
      with-target-to-bystanders: '[<npc>] -> [<target>]: <text>'
      to-target: '[<npc>] -> You: <text>'
      with-targets-to-bystanders: '[<npc>] -> [<targets>]: <text>'
  pathfinding:
    new-finder:
      iterations-per-tick: 5000 # how many steps to run of the new pathfinder every tick. Useful when you want to spread pathfinding over multiple ticks
      check-bounding-boxes: false # whether to check bounding boxes of entities can fit e.g. through single block gaps or fences etc
      open-doors: false # whether to open/close doors while pathfinding
    defaults:
      destination-teleport-margin: -1 # teleport to the destination when below this threshold. e.g. you may want to teleport to the exact destination if <2 blocks away
    default-distance-margin: 2 # the distance from the goal to stop early while moving along a path measured in blocks squared
    default-path-distance-margin: 1 # the distance from the goal to stop early while finding a path measured in blocks
    update-path-rate: 20 # how often to update the path in ticks, typically for entity targeting
    maximum-new-pathfinder-iterations: 10000 # the maximum number of blocks to search while pathfinding using the new pathfinder 
    minecraft:
      max-fall-distance: 3 # the maximum fall distance to check while pathfinding (old pathfinder)
    attack-range: 3.0625
    use-new-finder: false # whether to use the built in Citizens A* pathfinder instead of Minecraft's 
    disable-mc-fallback-navigation: true # minecraft by default will try to use 'fallback' pathfinding where it returns the closest reachable block to the destination. by default try to reach the destination only.
  default:
    bossbar-view-range: 64 # the bossbar view range, blocks
    look-close:
      enabled: false
      range: 5 # range in blocks
      random-look-enabled: false
      random-look-delay: 60 # delay in ticks
      disable-while-navigating: true
    pathfinding:
      range: 75.0 # the maximum pathfinding range to destination in blocks
    random-talker: true 
    realistic-looking: false # whether to check line of sight when looking close
    stationary-ticks: -1 # how many ticks can an NPC be stuck in the same block before teleporting to the goal / performing the 'stuck action'
    block-breaker-radius: -1 # the default radius in blocks for the NPC to pathfind to when breaking blocks
    talk-close:
      enabled: false
      range: 5
    text: # default text
      '0': Hi, I'm <npc>!
    waypoints:
      cache-paths: false # whether to cache paths found for /npc path. eliminates pathfinding when used
  limits:
    default-limit: 10
    max-permission-checks: 100 # number of permission nodes to check when using NPC limits
    max-packet-entries: 15 
    max-speed: 100
  tablist:
    disable: true # whether to keep NPCs on the tab list
  chunks:
    always-keep-loaded: false
  controllable:
    max-ground-speed: 0.5 # maximum speed while on the ground
    use-boat-controls: true # using WASD type controls
    ground-direction-modifier: 1.0 # % speed modifier to turning while on the ground
  skins:
    max-retries: -1 # maximum time to try from Mojang
    retry-delay: 120 # delay in ticks between retries
    rotation-update-degrees: 90.0 
    use-latest-by-default: false # whether to always fetch new skin updates
    view-distance: 100.0 
    placeholder-update-frequency-ticks: 6000 # how often to update skin placeholders, in ticks
  packets:
    update-delay: 30 # performance option, lower = faster updates to equipment, higher = slower updates but more performance
  selection:
    quick-select: false 
    item: stick # selection item
    message: <b>You selected <a><npc><b>!
  player:
    remove-from-list: true
  server-ownership: false
  text:
    max-talk-cooldown: 5
    min-talk-cooldown: 10
    talk-item: book
  teleport-delay: -1
  player-scoreboard-teams:
    enable: true
  follow:
    teleport-across-worlds: true # whether to teleport cross-world when /npc follow is enabled
  commands:
    global-delay-seconds: 1 # the global delay between click commands in seconds. set to 0 for no delay between commands
    error-messages:
      maximum-times-used: You have reached the maximum number of uses ({0}).
      missing-item: Missing {1} {0}
      no-permission: You don't have permission to do that.
      not-enough-experience: You need at least {0} experience.
      not-enough-money: You need at least ${0}.
      on-cooldown: Please wait for {minutes} minutes and {seconds_over} seconds.
      on-global-cooldown: Please wait for {minutes} minutes and {seconds_over} seconds.
advanced:
  check-minecraft-version: true
economy:
  npc:
    cost: 100.0 # the cost of /npc create if using economy integration
storage:
  save-task:
    delay: 72000
  file: saves.yml
  type: yaml
subplugins:
  folder: plugins


{{#if:|}}