Skip to content

Commit

Permalink
new readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sisby-folk committed Aug 4, 2024
1 parent e24c0af commit 765670e
Showing 1 changed file with 48 additions and 4 deletions.
52 changes: 48 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,50 @@
Right now Glowcase adds three blocks: the Text Block, the Hyperlink Block, and the Item Display Block. The Text Block acts as a more flexible sign, while the Hyperlink Block displays a URL that players can click on to open, and the Item Display Block is a more freeing item frame that also allows you to show off entities with their appropriate spawn egg.
<!--suppress HtmlDeprecatedTag, XmlDeprecatedElement -->
<center><img alt="mod preview" src="https://cdn.modrinth.com/data/HPdKhYvx/images/4357be2ef78350e44b50b9cdeacddd2335747ec3.png" /></center>

## Credits
<center>
Shiny creative blocks for in-game showcase events!<br/>
Intended for use in <a href="https://modfest.net">ModFest</a> events.
</center>

Originally created by [Haven King](https://github.com/Haven-King) for [ModFest 1.16](https://legacy.modfest.net/1.16/).
Now maintained by the ModFest team for use in ModFest events.
---

**Glowcase** adds creative-only blocks designed for adventure maps, server spawns, and virtual events.<br/>

## Features

To modify glowcase blocks, use them while holding a similar block in creative mode.

### Text Block

Appears as floating text, with no backing.

- Can display large bodies of text over many lines, far beyond the borders of the block
- Editable via a multiline text editor with copy+paste support
- Allows setting an arbitrary text scale, for large signs etc.
- Allows setting a custom hex color for contained text
- Displays text with a shadow, no shadow, or a tinted backdrop (toggleable)
- Support for inline text formatting, including colors, bold, italic, underline, strikethrough, and fonts
- See [Text Placeholder API](https://modrinth.com/mod/placeholder-api)'s [QuickText](https://placeholders.pb4.eu/user/quicktext/) format documentation for more details

### Item Display Block

Appears as a floating item stack.

- Displays the stack display name on hover (toggleable)
- Dispenses a copy of the stack on use (toggleable)
- Rotates towards the player (toggleable)

To set the item stack, use the desired stack an empty display block.<br/>
To modify other settings, use the same item on the block again.

### Hyperlink Block

Appears as a floating, billboarded 🌐 symbol.

- Displays a custom title on hover
- Requests to open a custom external link on use

---

This mod was originally created by Haven King as part of [ModFest 1.16](https://modfest.net/1.16/submissions).<br/>
Feel free to contribute bugfixes and improvements!

0 comments on commit 765670e

Please sign in to comment.