Papyrus
\n=======<\/p>\n
Papyrus provides various named mappings to the Fabric loader MappingResolver. This allows for more developer friendly
\naccess to mappings at runtime for example for using named classes in reflection instead of intermediary.
\nPapyrus downloads mappings on the first run on any given version and stores cached mappings in tiny v2 format at
\n${game_dir}\/cache\/papyrus\/${mapping}_${version}.tiny<\/p>\n
# Using Papyrus
\nTo use Papyrus just add the maven repository which hosts Papyrus to your gradle build script:
\n“` kotlin
\n# Kotlin DSL
\nrepositories {
\n maven(“https:\/\/maven.nelind.dk\/releases”) {
\n name = “Nelind Maven”
\n }
\n}<\/p>\n
# Groovy DSL
\nrepositories {
\n maven {
\n name ‘Nelind Maven’
\n url ‘https:\/\/maven.nelind.dk\/releases’
\n }
\n}
\n“`
\nand then include Papyrus JIJ with the standard loom “include” gradle configuration:
\n“` kotlin
\n# Kotlin DSL
\nmodRuntimeOnly(include(“dk.nelind:papyrus:(version)”)!!)<\/p>\n
# Groovy DSL
\nmodRuntimeOnly include(“dk.nelind:papyrus:(version)”)
\n“`
\nYou can also choose to not include Papyrus JIJ in that case make sure to manually add Papyrus as a dependency in your
\n`fabric.mod.json`. If you need to access Papyrus internals you can also add Papyrus with the `modApi` configuration instead of the
\n`modRuntimeOnly` configuration.<\/p>\n
Then in your `fabric.mod.json` you need to tell Papyrus what mappings you need access to and the version thereof:
\n“`json
\n{
\n …
\n “custom”: {
\n “papyrus”: {
\n “mappings”: [
\n “mojmap”,
\n “yarn:build.1”
\n ]
\n }
\n }
\n}
\n“`<\/p>\n
Then get and use the `MappingResolver` with any of the added mapping namespaces:
\n“`java
\nMappingResolver mappingResolver = FabricLoader.getInstance().getMappingResolver();
\nString runtimeClassNameFromYarnName = mappingResolver.mapClassName(“yarn:build.1”, yarnClassName);
\nString runtimeClassNameFromMojmapName = mappingResolver.mapClassname(“mojmap”, mojmapClassName);
\n“`<\/p>\n
### Usage notes:
\n– Papyrus injects the added mappings at `preLaunch` so you should only use Papyrus at some point after that.
\n If the here and there talks about possible future fabric loader plugins go somewhere where it makes sense for
\n Papyrus to become a loader plugin it will. Hopefully making extra mappings available at `preLaunch`<\/p>\n
– Mojmap handles inherited class members differently from Intermediary and Yarn!
\nIntermediary and Yarn only give mappings for members defined directly in a class in said classes mapping
\ndefinition whereas Mojmap gives names for all members a class has, inherited or not. In practice this means that if you
\nask the mapping resolver for a Mojmap method name in a class where the class has inherited the method while the runtime
\nmappings are either Intermediary or Yarn you’ll get `null` because the resolver *can* find that name (in Mojmap) but
\nthere is no defined name for that method in the runtime mapping. ***What does this mean for you?*** If you’re using
\nMojmap names as the input to the mapping resolver *you should use the class name of the class a method or field is
\ndeclared on not the class you want to modify*. Alternatively you can have a null check and programmatically find the
\nclass’s super class and ask the mapping resolver for the member name with that class as the owning class.<\/p>\n
## Provided mappings<\/p>\n
| Mappings | Namespace used in mapping resolver |
\n|:—————:|:———————————-:|
\n| Mojang Mappings | mojmap |
\n| Yarn | yarn |<\/p>\n
## Note on versioning
\nSince Papyrus is almost entirely independent of the version of the game itself. The mod version indicates the java
\nversion said build was built against. For example Papyrus x.y.z+java.17 is built against java 17 and as such supports
\nany game version that’s also built against java 17 (that being any version from 1.18 to 1.20.4 inclusively).<\/p>\n","protected":false},"excerpt":{"rendered":"
A mod that provides various named mappings to the Fabric loader MappingResolver<\/p>\n","protected":false},"featured_media":0,"template":"","meta":{"_minecraft_slug":"papyrus","_minecraft_project_id":"j2IRvAZ2","_minecraft_author":"nelind","_minecraft_license":"MIT","_minecraft_downloads":2181,"_minecraft_follows":1,"_minecraft_client_side":"optional","_minecraft_server_side":"optional","_minecraft_storage_type":"zip","_minecraft_archive_name":"papyrus.zip","_minecraft_size_bytes":623762,"_minecraft_version_count":4,"_minecraft_updated_at":"2026-05-15T22:48:50.199126Z","_minecraft_date_created":"2024-06-10T02:15:27.403177Z","_minecraft_date_modified":"2024-09-22T23:37:18.502563Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/papyrus","_minecraft_icon_attachment_id":0,"_minecraft_imported_at":"2026-06-07T00:28:36+00:00","_minecraft_import_hash":"fe5c28820055c42d1c68aa3ed7f30fb0","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[97,873],"mod_loader":[99],"minecraft_version":[51,52,53,54,55,56,57,58,59,36,60,93,94,101,102,62,37],"class_list":["post-119353","mod","type-mod","status-publish","hentry","mod_category-fabric","mod_category-library","mod_loader-fabric","minecraft_version-1-18","minecraft_version-1-18-1","minecraft_version-1-18-2","minecraft_version-1-19","minecraft_version-1-19-1","minecraft_version-1-19-2","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-20-2","minecraft_version-1-20-3","minecraft_version-1-20-4","minecraft_version-1-20-5","minecraft_version-1-20-6","minecraft_version-1-21","minecraft_version-1-21-1"],"yoast_head":"\n