Charted in a modpack

Set Charted's defaults and lock settings in config/charted.pack.json, and ship waypoints, no code needed.

Use Charted in any modpack, free or paid, without asking. A pack can set how Charted starts out for its players in config/charted.pack.json, a file next to Charted's own config/charted.json that only the pack writes. Charted never changes it.

config/charted.pack.json JSON
{
  "defaults": { "mapStyle": "ATLAS", "radarHostile": true, "minimapZoom": 1 },
  "locked":   { "caveView": false },
  "reason":   "No cave view in this pack"
}

What the pack ships #

In the pack's config folder
  • config/
  • charted.pack.json Your defaults and locked settings. Charted only reads it. Since 0.1.1.
  • charted/
  • waypoints.json Waypoints to add to each world. See Waypoints in a modpack.
  • charted.json The player's own settings. Don't ship it.

Don't ship config/charted.json to set Charted up: it overwrites what the player changed on every pack update. Put the same keys in charted.pack.json instead.

Defaults #

  1. Step 1:Your default A key and value under defaults.
  2. Step 2:Did the player change it? Charted compares with its own default and with your default from last time (kept in charted.pack-applied.json).
  3. Step 3:The setting
    • Not changed: it takes your default
    • Changed by the player: theirs stays
Each time the game starts, for each of your defaults.
  • A default applies wherever the player still has Charted's own default, or the pack's default from last time.
  • So a pack update that changes a default reaches every player who never touched that setting, and leaves alone those who did.
  • A default the pack drops goes back to Charted's. /charted reset and Reset in the settings go to the pack's defaults.

Locked settings #

A locked setting holds its value through every start and save, also when a key would switch it. Its row in the settings is greyed out and says "Set by the modpack.", with your reason after it when you give one.

The keys #

Keys are the top-level keys of config/charted.json, and a value is anything that file holds there. Start the game once with Charted to see the file. Some you may want:

KeyThe settingValues
minimapShownShow the minimaptrue, false
minimapRotateTurn with metrue, false
minimapZoomThe minimap's zoom-3 (far out) to 2 (close), in steps of 0.5; 0 by default
mapStyleMap style"SATELLITE", "ATLAS", "MINECRAFT"
worldMapViewView"FLAT", "TILTED"
caveViewCave viewtrue, false
radarPlayers, radarHostile, radarOtherMobsOther players, Hostile mobs, Other mobstrue, false
infoCoordinates, infoBiome, infoTimeLines under the minimaptrue, false
waypointsShownShown at once8 to 512; 512 is all
deathPointsDeath points0 (off) to 20
minimapOpacityOpacity20 to 100
heightShadingHeight shading0 (flat) to 100
biomeColors, waterDepth, dayNightBiome colors, Water depth, Day and nighttrue, false
radarPets, radarFacesTamed animals, Facestrue, false
waypointBeamsBeamstrue, false
waypointRangeBeams up to50 to 10000 blocks
portalPointsNether portalstrue, false
shareFormatShare waypoints as"CHARTED", "XAERO", "JOURNEYMAP"
memoryMiBMap memory0 (Automatic), or 128 to 4096
onboardingDoneWhether the walkthrough has been seentrue skips it

Charted has no feature switches of its own for the features part of the pack file; leave it out. A pack file Charted cannot read is logged and left out.

Waypoints #

A pack can also ship waypoints, added once to each world they are for. See Waypoints in a modpack.

Something missing or wrong on this page? Say so on Discord.