What are you searching for?

Text Placeholder API

Text Placeholder API

Placeholder and Text manipulation library for your Minecraft mods.

download 27.1M Downloads · favorite 1,170 Followers · Updated 6 days ago
Fabric Library Management Quilt 1.17 1.17.1 1.18 1.18.1 1.18.2 +37 more

Versions

inventory_2
2.8.2+1.21.10

2.8.2+1.21.10 · 6 days ago · 262.37 KB

Release download
Fabric Quilt 1.21.10 1.21.11
inventory_2
2.8.1+1.21.10

2.8.1+1.21.10 · 3 months ago · 261.65 KB

Release download
Fabric Quilt 1.21.9 1.21.10 1.21.11-pre1
inventory_2
2.8.0+1.21.9

2.8.0+1.21.9 · 4 months ago · 258.93 KB

Release download
Fabric Quilt 1.21.9-rc1 1.21.9 1.21.10
inventory_2
2.8.0-rc.1+1.21.9

2.8.0-rc.1+1.21.9 · 4 months ago · 258.94 KB

Release download
Fabric Quilt 1.21.9-pre1 1.21.9-pre2 1.21.9-pre3
inventory_2
2.7.2+1.21.8

2.7.2+1.21.8 · 5 months ago · 256.89 KB

Release download
Fabric Quilt 1.21.6 1.21.7 1.21.8

About

About Placeholder API

It's a small, JIJ-able API that allows creation and parsing placeholders within strings and Minecraft Text Components. Placeholder API uses a simple format of %modid:type% or %modid:type data% (%modid:type/data% prior to 1.19). It also includes simple, general usage text format indented for simplifying user input in configs/chats/etc.

For users

It allows users to configure multiple mods in similar way without losing compatibility between mods. Placeholders allow changing what and where any information is present within compatible mods.

Additionally, Simplified Text Format allows to style them in readable way without the requirement of writing JSON manually or using generators.

Mods generally using this api should just include it directly, but you can downloaded updated version from here if needed!

For developers

Usage of Placeholder API is a simple way to achieve good mod compatibility without having to implement multiple mod specific apis. Additionally, the placeholder parsing system can be used for replacing own static (or dynamic placeholders) in Text created by player or read from config. This with combination of Simplified Text Format allows creating great user/admin experience.

*[JIJ]: Jar-in-Jar

open_in_new View on Modrinth
Compatibility
Client: Optional Server: Optional
gavel LGPL-3.0-only

Conversation

What are your thoughts?

Related projects

Library
Fabric API
Fabric API

by modmuss50

Lightweight and modular API providing common hooks and intercompatibility measures utilized by mods using the Fabric toolchain.

download 127.9M
favorite 27,365
Library
Cloth Config API
Cloth Config API

by shedaniel

Configuration Library for Minecraft Mods

download 94.0M
favorite 13,653
Library Management Utility
YetAnotherConfigLib (YACL)
YetAnotherConfigLib (YACL)

by isxander

A builder-based configuration library for Minecraft!

download 65.8M
favorite 7,589
Library
Architectury API
Architectury API

by shedaniel

An intermediary api aimed to ease developing multiplatform mods.

download 60.8M
favorite 6,641
lock Cookie consent

SkinMC uses cookies to provide functionality and features.