Skip to content

Commit 895862a

Browse files
committed
Refactor server links documentation to improve clarity and remove outdated sections
1 parent 0a047a4 commit 895862a

File tree

1 file changed

+1
-180
lines changed

1 file changed

+1
-180
lines changed

content/docs/tweaks/server-links.mdx

Lines changed: 1 addition & 180 deletions
Original file line numberDiff line numberDiff line change
@@ -111,183 +111,4 @@ When `add-server-links` is enabled, Tweaks automatically integrates with Minecra
111111

112112
1. **Automatic Registration**: Enabled links are automatically registered with the Minecraft client
113113
2. **Client Integration**: Players can access links through the server list or in-game menus
114-
3. **Seamless Experience**: No need for players to remember commands or URLs
115-
116-
### Supported Link Types
117-
118-
Minecraft's Server Links feature supports these categories:
119-
120-
- **Bug Report** (`issues`)
121-
- **Community Guidelines** (`guidelines`)
122-
- **Discord** (`discord`)
123-
- **Feedback** (`feedback`)
124-
- **Forums** (`forum`)
125-
- **News** (`news`)
126-
- **Status** (`status`)
127-
- **Support** (`support`)
128-
- **Website** (`website`)
129-
130-
## Link Command Behavior
131-
132-
### Default Behavior
133-
134-
When a player uses a social link command:
135-
136-
1. **Message Display**: A formatted message appears in chat with the link
137-
2. **Click Action**: Players can click the message to open the URL
138-
3. **Hover Info**: Additional context appears on hover
139-
140-
### Permissions
141-
142-
Social link commands **do not require any permissions** by default. This ensures all players can access your community resources.
143-
144-
To restrict access to specific commands, you can:
145-
146-
```yaml
147-
# Deny access to specific commands
148-
- -tweaks.command.discord
149-
150-
# Or create custom permission groups
151-
tweaks.links.staff:
152-
- tweaks.command.feedback
153-
- tweaks.command.issues
154-
```
155-
156-
## Customization
157-
158-
### Message Formatting
159-
160-
You can customize the appearance of link messages in your translation files:
161-
162-
```json
163-
{
164-
"commands": {
165-
"discord": {
166-
"format": "<click:open_url:'{url}'><gradient:#5865F2:#7289DA>[Discord]</gradient> Join our community!</click>",
167-
"hover": "Click to join our Discord server"
168-
}
169-
}
170-
}
171-
```
172-
173-
### Conditional Links
174-
175-
You can make links conditional based on player permissions or other criteria:
176-
177-
```json
178-
{
179-
"social": {
180-
"staff-feedback": {
181-
"enabled": true,
182-
"permission": "tweaks.links.staff",
183-
"url": "https://staff.yourserver.com/feedback"
184-
}
185-
}
186-
}
187-
```
188-
189-
## Best Practices
190-
191-
### URL Configuration
192-
193-
1. **Use HTTPS** whenever possible for security
194-
2. **Test all links** before deploying to production
195-
3. **Keep URLs current** and monitor for broken links
196-
4. **Use short URLs** for better chat display when needed
197-
198-
### Community Integration
199-
200-
1. **Consistent Branding**: Match your server's theme across all platforms
201-
2. **Clear Descriptions**: Make it obvious what each link provides
202-
3. **Strategic Selection**: Don't overwhelm players with too many options
203-
4. **Regular Updates**: Keep content fresh and links active
204-
205-
### Server Links Tab
206-
207-
1. **Enable selectively**: Only show links that provide real value
208-
2. **Prioritize important links**: Website, Discord, and rules are most important
209-
3. **Test client integration**: Verify links work from the Minecraft client
210-
4. **Monitor usage**: Remove unused links to keep the list clean
211-
212-
## Troubleshooting
213-
214-
### Common Issues
215-
216-
**Links not appearing in Server Links tab:**
217-
- Verify `add-server-links` is enabled
218-
- Check that URLs are properly formatted
219-
- Ensure the server has restarted after configuration changes
220-
221-
**Commands not working:**
222-
- Confirm `add-link-commands` is enabled
223-
- Verify specific platform toggles are enabled
224-
- Check for permission restrictions
225-
226-
**URLs not opening:**
227-
- Test URLs in a web browser
228-
- Ensure URLs use proper protocols (https://, ts3server://, etc.)
229-
- Check client-side security settings
230-
231-
### Debugging
232-
233-
Enable debug logging to troubleshoot link registration:
234-
235-
```json
236-
{
237-
"debug": {
238-
"log-link-registration": true
239-
}
240-
}
241-
```
242-
243-
## Examples
244-
245-
### Gaming Community Setup
246-
247-
```json
248-
{
249-
"social": {
250-
"add-link-commands": true,
251-
"add-server-links": true,
252-
"website": true,
253-
"discord": true,
254-
"forum": true,
255-
"guidelines": true,
256-
"support": true,
257-
"youtube": false,
258-
"x": false
259-
},
260-
"links": {
261-
"website": "https://craftinglegends.com",
262-
"discord": "https://discord.gg/craftinglegends",
263-
"forum": "https://forum.craftinglegends.com",
264-
"guidelines": "https://craftinglegends.com/rules",
265-
"support": "https://support.craftinglegends.com"
266-
}
267-
}
268-
```
269-
270-
### Content Creator Server
271-
272-
```json
273-
{
274-
"social": {
275-
"add-link-commands": true,
276-
"add-server-links": true,
277-
"website": true,
278-
"discord": true,
279-
"youtube": true,
280-
"twitch": true,
281-
"x": true,
282-
"support": true
283-
},
284-
"links": {
285-
"website": "https://streamcraft.tv",
286-
"discord": "https://discord.gg/streamcraft",
287-
"youtube": "https://youtube.com/c/StreamCraft",
288-
"twitch": "https://twitch.tv/streamcraft",
289-
"x": "https://x.com/StreamCraftMC",
290-
"support": "https://streamcraft.tv/support"
291-
}
292-
}
293-
```
114+
3. **Seamless Experience**: No need for players to remember commands or URLs

0 commit comments

Comments
 (0)