Core ‐ (READ HERE FIRST) - pearuhdox/Cartographer-2.0 GitHub Wiki
Cartographer depends on a set of helper functions and systems known as "Core" as well as a couple other external libraries. These libraries are provided for you in the download, so there is no need to worry about needing to download external datapacks. This page details some important information about Core, and some of the utility it offers, as well as links to the respective libraries (so you can check out how they work and use them yourself). All Libraries in Cartographer are provided exactly as they are from the original provider, with the permission of the original provider. (So copies provided from their github pages will work.)
All packs outside of Core are designed to be modular, so mappers have the flexibility to install what they wish. However, some features that utilize features in other packs (e.g. Custom Enchantments that inflict Custom Statuses) will not work properly without all needed packs installed.
Installation
Installing Cartographer is designed to be fairly simple and easy. To do so:
-
Navigate to the main page of this github (Code in the upper left corner of the site) and download the latest release (found in Releases, on the right side of the main page)
-
Download the source code from the latest release, unzip the source, and drag and drop all Datapacks you want into your datapacks folder of your minecraft world (located in .minecraft/saves). In addition, install Core and all Libraries included in the download in your datapacks folder.
-
Open your world and the packs should auto install. If your world is already open, type
/reload
in the chat to reload your world and install the packs. -
If installed correctly, you should receive a chat message upon reloading/startup.
The best way to download Cartographer with all current pushed code is to download directly from the main branch for the version you wish to download, such as "1.21" and click the "<> Code" button, and "Download ZIP". Occasionally a release package will be made for the most recent version, but these are made periodically and not guaranteed to have all bug fixes and new content for a version.
It is important to note that no module in Cartographer will work properly without Core or the below Libraries. Make sure you include them in your world even though they do not add features!
Library Information
Cartographer runs Gibbsly's LTOS library, which replaces all the loot tables for blocks and entities with identical ones that drop a marker item to detect if an entity was killed or block was broken. While using Cartographer, remove all added replacements to vanilla loot tables and modify these Cartographer ones directly. These can be found within Cartographer's Core datapack, in the minecraft datapack section. Additionally, refer to Gibbsly's documentation on how to make your custom loot tables compatible with LTOS. https://github.com/gibbsly/ltos?tab=readme-ov-file#mixing-loot-tables
Cartographer Equipment Stat Tracking Behavior
Cartographer uses unique rules unlike Vanilla Minecraft's enchantments and attributes to better control what stats apply based on the slots items are placed in.
By default, Custom Enchantments, Attributes, and Custom Status Action data tracks with the following rules.
- Armor Items and wearable items are not tracked in any held slot.
- Items placed in the offhand will not be tracked unless they are in the
#cartographer_core:offhand_allowed
tag. By default, this tag includes all ranged and throwable weapons, fishing rods, shields, totems, dyes, and nether stars. - Items of the above tag that have the
weapon
item component will not be tracked.
Several custom data tags exist to give more customization to items. This controls what stats (custom attributes, custom enchantments, custom status actions). These will modify the above behavior.
allow_offhand
: This will allow the item to have tracked custom stats in the offhand slot.
disable_offhand
: This will prevent the item from tracking custom stats in the offhand slot (if it is allowed to).
disable_mainhand
: This will prevent the item from tracking custom stats in the mainhand slot (if it is allowed to).
Event Handler API
(Cartographer's Event Handler API documentation will eventually be uploaded here, for custom working with said API. For now, this system's documentation is not yet finished.)