Skip to content

Commit 7bdac92

Browse files
authored
GH-60 Add EternalCore FAQ and pfandleiher chatformatter config (#60)
* Add EternalCore FAQ containing minimessages guide, command disabling and no flickering in title. Add chatformatter config created by @Pfandleiher * Change faq questions * fix animation issue * word fixup
1 parent 21a47ae commit 7bdac92

File tree

7 files changed

+140
-23
lines changed

7 files changed

+140
-23
lines changed

docs/.vitepress/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@ function configureSidebar(currentPath: string) {
6565
items: [
6666
{ text: "🚀 Getting Started", link: "/eternalcore/introduction" },
6767
{ text: "🔧 Installation", link: "/eternalcore/installation" },
68+
{ text: "❓ FAQ", link: "/eternalcore/faq" },
6869
{ text: "✨ Features", link: "/eternalcore/features" },
6970
{ text: "👷 Developer API", link: "/eternalcore/using-api"},
70-
{ text: "📖 Text center", link: "/eternalcore/center" },
7171
{ text: "📑 Placeholders", link: "/eternalcore/placeholders" },
7272
{ text: "🔔 Notifications", link: "/eternalcore/notifications" },
7373
{ text: "🏠 Homes", link: "/eternalcore/homes" },

docs/chatformatter/examples.md

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,90 @@ Our plugin allows users to create custom styles for messages sent inside Minecra
1515

1616
[Formats and styles for MiniMessage](https://docs.advntr.dev/minimessage/format.html)
1717

18-
![Example for transition](/assets/chatformatter/example2.png)
18+
![Example for transition](/assets/chatformatter/example2.png)
19+
20+
## 📚 Example configuration
21+
22+
One of our discord members created amazing configuration for chatformatter. Created by @pfandleiher. Check it out below:
23+
24+
```yaml
25+
# ____ _ _ _____ ChatFormatter _ _
26+
# / ___| |__ __ _| |_| ___|__ _ __ _ __ ___ __ _| |_| |_ ___ _ __
27+
# | | | '_ \ / _` | __| |_ / _ \| '__| '_ ` _ \ / _` | __| __/ _ \ '__|
28+
# | |___| | | | (_| | |_| _| (_) | | | | | | | | (_| | |_| || __/ |
29+
# \____|_| |_|\__,_|\__|_| \___/|_| |_| |_| |_|\__,_|\__|\__\___|_|
30+
31+
32+
# Do you want to receive updates about new versions of ChatFormatter?
33+
receiveUpdates: true
34+
35+
# Chat format for ranks (Vault) Support mini-messages and legacy colors
36+
37+
# We're recommending to use webui for mini-messages: https://webui.adventure.kyori.net/
38+
39+
# documentation is here: https://docs.adventure.kyori.net/minimessage/format.html
40+
41+
# You can check LuckPerms setup and placeholders here: https://luckperms.net/wiki/Placeholders
42+
#
43+
# Example usages:
44+
#
45+
# Hover message:
46+
# One line: <hover:show_text:'<red>test'>TEST
47+
# Multiple lines: <hover:show_text:'<red>test'>Test<newline>Test2</hover>
48+
#
49+
# Click message:
50+
# Open URL: <click:open_url:'https://webui.adventure.kyori.net'>TEST</click>
51+
# Run command: <click:run_command:/say hello>Click</click> to say hello
52+
# Suggest command: <click:suggest_command:'/msg {displayname}'></click>
53+
#
54+
# RGB and gradient message usage:
55+
# <color:#ff00ee>Example message</color>
56+
# <gradient:#ff00ee:#f79459>Example message</gradient>
57+
#
58+
# You can use three more internal placeholders: <displayname> <name> <message>
59+
#
60+
defaultFormat: "$hoverWorld({world}) $hoverRank({player_rank}) &7| $hoverName({displayname})&r: $hoverChat({message})"
61+
62+
# Here you can set different formats for each rank.
63+
# Remember! Rank name must be exactly the same as in you permission plugin configuration.
64+
# If player have more than one rank remember to correctly setup rank weight configuration
65+
format:
66+
vip: "{vip} &f$hoverName({displayname}) <dark_gray>» <gradient:#ffd270:white>{message}"
67+
mod: "{mod} &f$hoverName({displayname}) <dark_gray>» <gradient:#a3ff9e:white>{message}"
68+
admin: "{admin} &f$hoverName({displayname}) <dark_gray>» <gradient:#bac8ff:white><b>{message}"
69+
owner: "{owner} &f$hoverName({displayname}) <dark_gray>» <gradient:#ff9195:white><b>{message}"
70+
71+
# Placeholders, it allows you to make a shorter text, you can use some prefixes, characters etc.
72+
# You can use here PAPI placeholders.
73+
placeholders:
74+
{world}: "%multiverse_world_name_colored%"
75+
{world_info}: "%multiverse_world_name_colored% %multiverse_world_color%%multiverse_world_name%"
76+
{rank}: "%luckperms_prefix%"
77+
{rank_info}: "&#00bbffPlayer Ranking\n&7Calculated based on:\n▪&#22c55e ⛏ In-game statistics\n&7▪&#ef4444 🗡 PvP stats\n&7▪&#ec4899 ⌚ Play Time\n\n&#f97316» &7Click to open Leaderboard"
78+
{displayname}: "<displayname>"
79+
{name}: "<name>"
80+
{player_info}: "&#00bbffPlayer Info &7» %luckperms_meta_ucolor%<name> &7(&#7cd3fc#%minetrax_player_id%&7)\n&7Joined %minetrax_player_first_seen_at%\n\n&#22c55e⭐ Position: &f#%minetrax_player_position%\n&#ef4444🗡 Kills: &f%minetrax_player_total_player_kills%\n&7☠ Deaths: &f%minetrax_player_total_deaths%\n\n&#f97316» &7Click to send private message"
81+
{message}: "<message>"
82+
{report_message}: "&4» &cReport <displayname>"
83+
84+
# This section is made for experienced users
85+
# It is used to shorten the text even more and keep the clean file!
86+
templates:
87+
- "$hoverWorld($world) -> '<hover:show_text:'{world_info}'>{world}</hover>'"
88+
- "$hoverRank($rank) -> '<hover:show_text:'{rank_info}'><click:open_url:'https://rockg.de/stats'>{rank}</click></hover>'"
89+
- "$hoverName($name) -> '<hover:show_text:'{player_info}'><click:suggest_command:'/msg {displayname} '>{displayname}</click></hover>'"
90+
- "$hoverChat($chat) -> '<hover:show_text:'{report_message}'><click:suggest_command:'/report {displayname} '>{message}</click></hover>'"
91+
```
92+
93+
In game examples:
94+
```yaml
95+
"&#00bbffPlayer Ranking\n&7Calculated based on:\n▪&#22c55e ⛏ In-game statistics\n&7▪&#ef4444 🗡 PvP stats\n&7▪&#ec4899 ⌚ Play Time\n\n&#f97316» &7Click to open Leaderboard"
96+
```
97+
98+
![img.png](/assets/chatformatter/pfandleiher_example.png)
99+
100+
101+
```yaml
102+
"&#00bbffPlayer Info &7» %luckperms_meta_ucolor%<name> &7(&#7cd3fc#%minetrax_player_id%&7)\n&7Joined %minetrax_player_first_seen_at%\n\n&#22c55e⭐ Position: &f#%minetrax_player_position%\n&#ef4444🗡 Kills: &f%minetrax_player_total_player_kills%\n&7☠ Deaths: &f%minetrax_player_total_deaths%\n\n&#f97316» &7Click to send private message"
103+
```
104+
![img_1.png](/assets/chatformatter/pfandleiher_example2.png)

docs/eternalcore/center.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/eternalcore/faq.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# ❓ Frequently Asked Questions
2+
3+
## ⛔ How to disable command in EternalCore?
4+
5+
### Problem:
6+
Command from my other plugin is clashing against EternalCore command.
7+
8+
### Solution:
9+
You can disable command in `commands.yml` file.
10+
11+
### Example:
12+
```yaml
13+
rtp:
14+
name: []
15+
enabled: false
16+
aliases: []
17+
permissions: []
18+
subCommands: []
19+
```
20+
21+
## 🎨 How do I format text in chat?
22+
23+
### Problem:
24+
I want to format text in chat. I want to style it, color it, etc.
25+
26+
### Solution:
27+
You can use MiniMessage formatting. Check out the [MiniMessage Viewer](https://webui.advntr.dev/).
28+
29+
### Example:
30+
```yaml
31+
message: "<gradient:#ff00ee:#f79459>Example message</gradient>"
32+
```
33+
34+
35+
## 🏃💨 How do I stop my title from flickering?
36+
37+
### Problem:
38+
I want to create in game title with timer, but it keeps flickering on users screen.
39+
40+
### Solution:
41+
You can use `times` key in configuration file.
42+
43+
### Example:
44+
```yaml
45+
teleportTimerFormat:
46+
actionbar: "<green>► <white>Teleporting in <green>{TIME}"
47+
chat: "<green>► <white>Teleporting in <green>{TIME}"
48+
title: "<white>Teleporting..."
49+
subtitle: "<green>{TIME}"
50+
times: "1s 2s 1s" # No flickering
51+
```

docs/eternalcore/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ Plugin includes full support for teleportation, warps, homes and chat management
55

66
## EternalCore wiki's
77
* [Installation and upgrading](installation.md)
8+
* [FAQ](faq.md)
89
* [Features, Commands and Permissions](features.md)
910
* [Developer API](using-api.md)
1011
* [Notifications](notifications.md)
1112
* [Homes](homes.md)
1213
* [Placeholders](placeholders.md)
13-
* [Text centering](center.md)
Loading
Loading

0 commit comments

Comments
 (0)