https://github.com/christopherhaws/mc-text-utilities
Adds buttons to set the color and formatting of text
https://github.com/christopherhaws/mc-text-utilities
Last synced: 12 months ago
JSON representation
Adds buttons to set the color and formatting of text
- Host: GitHub
- URL: https://github.com/christopherhaws/mc-text-utilities
- Owner: ChristopherHaws
- License: lgpl-3.0
- Created: 2022-08-16T03:29:44.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-15T22:48:47.000Z (over 1 year ago)
- Last Synced: 2025-02-15T23:26:35.147Z (over 1 year ago)
- Language: Java
- Size: 334 KB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Text Utilities (for Fabric)
[](https://discord.gg/kQjty3rfJd)
Text Utilities is a free and open-source mod for Minecraft which adds color and formatting
options to signs, books, and anvils.
---
## Features
- Adds color and formatting buttons to the sign editor screen, anvil screen, and the book edit screen
- Adds color and formatting support to fabric server's when installed on a server
- Formatting code prefix is configurable to support servers that don't use the default `§` (for example, Purpur has built in support for `&`)
- Adds the ability to click-through signs and item frames when they are attached to containers
- Sign click through is prevented when holding a sign, dye, an ink sac, or a glowing ink sac in your main hand
- Item Frame click through is prevented while sneaking or if the item frame has no item in it
NOTE: At the moment, you have to press a color before a format button if you want to use both.
---
## Installation
[
](https://modrinth.com/mod/fabric-api)
[
](https://modrinth.com/mod/cloth-config)
### Manual installation
You will need Fabric Loader 0.10.x or newer installed in your game in order to load Text
Utilities. If you haven't installed Fabric mods before, you can find a variety of community
guides for doing so [here](https://fabricmc.net/wiki/install).
#### Stable releases
The latest releases of Text Utilities are published to our [Modrinth](https://modrinth.com/mod/text-utilities),
[CurseForge](https://www.curseforge.com/minecraft/mc-mods/text-utilities),
and [GitHub release](https://github.com/ChristopherHaws/mc-text-utilities/releases) pages. Releases
are considered to be **suitable for general use**, but they are not guaranteed to be free of bugs
and other issues.
Usually, releases will be made available on GitHub slightly sooner than other locations.
#### Bleeding-edge builds (unstable)
[](https://github.com/ChristopherHaws/mc-text-utilities/actions/workflows/build.yml)
If you are a player who is looking to get your hands on the latest **bleeding-edge changes for
testing**, consider taking a look at the automated builds produced through our
[GitHub Actions workflow](https://github.com/ChristopherHaws/mc-text-utilities/actions/workflows/build.yml?query=event%3Apush).
This workflow automatically runs every time a change is pushed to the repository, and as such,
the builds it produces will generally reflect the latest snapshot of development.
Bleeding edge builds will often include unfinished code that hasn't been extensively tested.
That code may introduce incomplete features, bugs, crashes, and all other kinds of weird issues.
You **should not use these bleeding edge builds** unless you know what you are doing and are
comfortable with software debugging.
### Reporting Issues
You can report bugs and crashes by opening an issue on our [issue tracker](https://github.com/ChristopherHaws/mc-text-utilities/issues).
Before opening a new issue, use the search tool to make sure that your issue has not already
been reported and ensure that you have completely filled out the issue template. Issues that are
duplicates or do not contain the necessary information to triage and debug may be closed.
Please note that while the issue tracker is open to feature requests, development is primarily
focused on improving hardware compatibility, performance, and finishing any unimplemented
features necessary for parity with the vanilla renderer.
---
### License
Text Utilities is licensed under GNU LGPLv3, a free and open-source license. For more information,
please see the [license file](https://github.com/ChristopherHaws/mc-text-utilities/blob/main/LICENSE).