Commands

LinearReader has many commands which either provide information and statistics, or perform certain actions. These commands are meant for server owners (or for use in singleplayer) and require operator level permissions to run them. A brief summary of each command will be provided, along with a more in depth explanation (if applicable).

All commands are run by typing /linearreader followed by the desired command.

Info Commands

• cache_info Returns the number of regions currently open, current number of dirty regions, and an estimate for how much RAM is currently being used by the cache. For more information about the cache, see here.
• storage Returns the number of .linear and .bak files that exist for this world, how much storage each of those takes up, and how much storage chunk data is using in total.
• pos Returns the player's current block coordinate (x, y, z), chunk coordinate (both the chunk's coordinates (i.e. 400, 400), and the player's chunk coordinates (i.e. 9, 9)), and which region file that chunk is in, along with whether that file is cached or not.
• bench Provides the following benchmarking information:
  • How long the current measurement window has been active. Run bench reset to reset the window and start measuring anew.
  • Chunk Activity:
    • Chunk reads: number of reads, reads per second, average read time, minimum read time, and maximum read time.
    • Chunk writes: number of writes, writes per second, average write time, minimum write time, and maximum write time.
  • Disk Activity:
    • Region loads: how many region files (.linear files) were loaded into memory, average load time, minimum load time, and maximum load time.
    • Region flushes: how many regions were saved and written back on to the disk, average flush time, minimum flush time, and maximum flush time.
  • Compression:
    • Uncompressed data size: of the total data written this session, how large would it be if it was raw, uncompressed data.
    • Compressed data size: of the total data written this session, how large is it after being compressed to the .linear format.
    • Storage saved percentage: the percentage of storage saved when compressing the raw data to .linear.
  • Cache Behavior:
    • Linear cache: how often data was already decoded and ready to be reused.
    • Region wrapper cache: how often region files were already loaded into memory and used without requiring disk access.
      • A high wrapper cache rate is expected during normal gameplay since regions are kept in memory while players are nearby.
    • Resident reloads: number of regions in memory that were reloaded without being evicted.
    • Evictions: number of regions removed from memory due to cache limits.
• pins Lists all current regions pinned in the cache. See the pin command below for more details.
• verify Scans all .linear files and reports any that show signs of corruption.

Action Commands

For more detailed information on these features, see the Features page of this wiki

Cache Management

• pin/unpin: Running pin pins the region you are standing in to the cache, meaning that it will never be evicted. Running unpin unpins the region you are standing in from the cache, making it no different than any other region file. You can also run pin/unpin [<rx>] <rz> in which rx means the x coordinate of the region file, and rz means the z coordinate of the region file. For example, running pin 0 -1 would pin the file r.0.-1.linear to the cache.

Storage Savers

• afk-compress:
• prune-chunks:

Backup Management

• sync-backups:

File Conversion

• export-mca: