Skip to content

Commit 61ebef0

Browse files
Update README.md
1 parent 6a9d9e7 commit 61ebef0

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ ServerLinksZ is a simple plugin, that allows you to add Links to the "Server Lin
2424
- **/sl add <id> <name> <url> <allowCommand?>** - Add a link to the Link page
2525
- **/sl remove <id>** - Remove the link with this id
2626
- **/sl reload** - Reload the plugin
27-
- **/link <id>** - Open a link with this id
27+
- **/link <id>** - Open a link with this id
28+
29+
and custom link commands (e.g. `/discord`, `/website`)
2830

2931
## Permissions
3032

@@ -34,7 +36,7 @@ ServerLinksZ is a simple plugin, that allows you to add Links to the "Server Lin
3436

3537
Here is an example of the configuration file:
3638
<details>
37-
<summary>Click me!</summary>
39+
<summary>config.yml</summary>
3840

3941
```yml
4042
# _____ _ _ _ ______
@@ -57,14 +59,38 @@ Here is an example of the configuration file:
5759

5860
# Set the language to any code found in the "lang" folder (don't add the .yml extension)
5961
# You can add your own language files. Use https://github.com/KartoffelChipss/ServerLinksZ/tree/main/src/main/resources/lang/en-US.yml as a template
60-
# | en-US | de-DE |
62+
# If you want to share your language file, either create a pull request on GitHub or use GitLocalize: https://gitlocalize.com/repo/9890
63+
# | en-US | de-DE | zh-CN | ru-RU | zh-TW
6164
lang: "en-US"
6265

6366
# Wether to show hints when using commands
6467
hints: true
6568

6669
# Add a /link command to view the links
6770
linkCommand: true
71+
72+
# Instead of using the /link command, you can also use a custom command for any link (e.g. /mycoollink)
73+
# This feature is experimental and might not work as expected
74+
dynamicCommands: false
75+
76+
# [!!!] You can configure the links in the links.yml file!
77+
```
78+
</details>
79+
80+
And here an example of the links configuration file:
81+
82+
<details>
83+
<summary>links.yml</summary>
84+
85+
```yml
86+
discord:
87+
name: "<#7289da>&lDiscord"
88+
url: "https://strassburger.org/discord"
89+
allowCommand: true
90+
website:
91+
name: "<#7cd770>&lWebsite"
92+
url: "https://modrinth.com/plugin/serverlinksz"
93+
allowCommand: false
6894
```
6995
</details>
7096

0 commit comments

Comments
 (0)