Skip to content

Commit d38663e

Browse files
authored
Update README.md
1 parent e67fcca commit d38663e

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,25 @@
11
# GUI API
2-
API plugin for display of visual elements in the player's screen.
2+
Minecraft API plugin for display of visual elements in the player's screen, such as text, images or interface components.
3+
4+
Requires the usage of the Negative Space Resource Pack by AmberW:
5+
6+
https://www.spigotmc.org/threads/negative-space-font-resource-pack.440952/
7+
8+
Reminder that you can include AmberW's resource pack in your own resource pack (see the link for details).
9+
You can also set a server resource pack in server.properties, or by using a plugin such as ForceResourcePack:
10+
11+
https://www.spigotmc.org/resources/forceresourcepack.6097/
12+
313
## For server owners:
4-
You can dd this plugin to your server for mainly two purposes:
5-
* Resolve conflicting action bar texts coming from different plugins
6-
* Make depending plugins work!
14+
If you are a server owner, you might want to add this plugin to your server for mainly two purposes:
15+
16+
### Resolve conflicting action bars coming from different plugins
17+
GUI API will store the conflicting action bar texts and cycle through them, displaying them one by one at a configurable rate.
18+
19+
### Make depending plugins work!
20+
Through the use of GUI API, other plugins can achieve amazing visual effects, displaying information relevant to their functionality or gameplay.
21+
722
## For developers:
8-
Use as a dependency of your plugin to display custom elements (for example using a resource pack), where you get to choose the position and priority of each GUI component.
23+
You can use GUI API as a dependency to display information and other visual elements, further customizing the looks of your plugin.
24+
Possible GUI Components include text in different places of the screen, and images added through a resource pack.
25+
You get to choose the position and order in which each individual GUI component is rendered.

0 commit comments

Comments
 (0)