Skip to content

Latest commit

 

History

History
93 lines (73 loc) · 3.78 KB

File metadata and controls

93 lines (73 loc) · 3.78 KB

shreddedpaper.yml

# Multithreading settings
multithreading:

  # The number of threads to use for ticking chunks. `-1` defaults to the number
  # of available processors subtract one, or 1, whichever is larger.
  # Set to `1` to essentially disable multi-threading.
  thread-count: -1
  
  # The size of a region in chunks. Chunks are grouped into regions when
  # ticking, and neighbouring regions are locked so any changes into the
  # neighbouring region do not step on other threads.
  # The larger the value, the more performant the server will be, but the more
  # likely the work is not evenly distributed between threads. Too small, and
  # threads may accidentally try accessing chunks of another thread.
  # A minimum of 8 chunks is recommended, as lightning rods have the largest
  # search radius at 8 chunks.
  # Must be a power of 2.
  region-size: 8
  
  # Whether to run plugins' code without 'folia-supported: true' in sync. This
  # will give unsupported plugins a better chance of working, but is not
  # guaranteed. If false, or if the plugin is supported, all the plugin's code
  # will run asynchronously in the ticking region worker threads.
  run-unsupported-plugins-in-sync: true
  
  # Can unsupported plugins modify blocks/entities/etc from the global scheduler
  # This will be false if there are multiple servers as tasks in the global
  # scheduler do not have the required region locks. These locks aren't needed
  # for single server instances.
  allow-unsupported-plugins-to-modify-chunks-via-global-scheduler: true

# ShreddedPaper's optimizations settings
optimizations:
  
  # Check entity activation range less often. Spigot does this every tick
  # unnecessarily. Set to '0' to disable.
  entity-activation-check-frequency: 20
  
  # Disable Bukkit's vanish api. Set to 'true' to increase performance. This
  # will break plugins using this api.
  disable-vanish-api: false
  
  # Disable the locator bar and Minecraft's waypoint system. This is horribly
  # inefficient at large player counts, set to 'true' to increase performance.
  # Warning: Doing `/gamerule locator_bar false` does NOT increase performance.
  # The locator bar must be disabled internally in this config to have an
  # impact on performance.
  disable-locator-bar: true
  
  # Don't wake up the event loop thread when not flushing packets. Set to
  # 'true' to increase performance. 
  use-lazy-execute-when-not-flushing: true

  # Flush the players' connection queues in parallel. Set to 'true' to increase
  # performance.
  flush-queue-in-parallel: true
  
  # Process the track queue in parallel. Set to 'true' to increase performance.
  process-track-queue-in-parallel: true
  
  # Maximum number of players to render each entity to. Can be bypassed with the
  # permission 'shreddedpaper.maximumtrackerbypass'
  maximum-trackers-per-entity: 500

  # How often (in ticks) to do a full tracker update per entity. The vanilla
  # default is '1'.
  tracker-full-update-frequency: 20
  
  # How often (in ticks) to purge stale tickets. The papermc default is '1'.
  purge-stale-tickets-frequency: 20

  # Cache full chunk packets so that we aren't recreating them every time the
  # same chunk is sent to a new player. Useful when lots of players are in the
  # same area.
  chunk-packet-caching:
    enabled: true
    
    # How long to keep the cached packets in ticks. Cached packets automatically
    # expire if the chunk is modified.
    expire-after: 1200
    
    # Use soft references for the cached packets. This will mean the garbage
    # collector will reclaim the memory before an OutOfMemoryError occurs,
    # but will leave the cache alive as long as possible.
    # Set to 'false' to use weak references, which will be collected by the
    # garbage collector much sooner than soft references.
    use-soft-references: true