Skip to content

About

This open source Minecraft plugin is intended to allow players to view relevant links with simple commands.

Topics

Resources

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

Easy Links

Creating two links, listing them and viewing one with /el view

Real in-game output from Easy Links 0.6.3 on a local throwaway Paper 1.21.11 test server: the commands were typed by a scripted bot client, and the chat it received is drawn as Minecraft-style chat (typed commands appear in the input bars; grey lines say what happened between commands).

Description

Easy Links is a Spigot plugin that lets server administrators save named URLs so that players can look them up in-game with a short command, instead of having long links pasted into chat. Every successful lookup is counted, and /el stats reports how many links exist, how often they have been viewed in total, and which one is the most popular.

Links are stored in plugins/EasyLinks/links.json. They are written there as soon as they are created or deleted, and their use counts are written when the server shuts down, so both survive a restart.

Supported Minecraft Versions

This plugin is supported on the Minecraft versions listed in minecraft-versions.json: currently 1.19.4, 1.21.11, 26.2 and 26.3 (Spigot and its forks). Every stable release is booted on a real server of each of these versions before it is published, and every build checks that the plugin only uses Bukkit API that exists on all of them. Other versions from 1.19.4 onwards are expected to work but are not tested. To support another version, add it to the file: both checks pick it up.

Installation

  1. Download the latest Easy-Links-<version>.jar from SpigotMC or the Releases page.
  2. Once downloaded, place the jar in the plugins folder of your server files.
  3. Restart your server.

A config.yml is generated in plugins/EasyLinks/ on first run. See the Configuration Guide for the options it contains.

Usage

An operator saves a link, and anyone can then look it up:

/el create "discord" "https://discord.gg/xXtuAQ2"
/el view "discord"
/el list

Link names and URLs must be wrapped in double quotes. Without them the command is rejected with its usage message.

Creating and deleting links is restricted to operators by default (el.create and el.delete); viewing, listing and statistics are available to everyone.

Documentation

Support

You can find the support discord server here.

Experiencing a bug?

Please open an issue here.

Usage reporting

Usage reporting is on by default: each time the plugin is enabled, and each time one of its commands is run, it sends its name, its version and the command's name to the author's trace server at https://trace.danielstephenson.dev, so it is known which plugins are actually in use. Nothing about players, worlds or IP addresses is sent, and nothing typed after a command is.

Each event also carries a random server ID (the server-id line in plugins/trace/config.yml) so servers can be counted rather than events. It identifies no person, account or IP address; delete the line to get a new one.

To turn it off:

  • for this plugin: set usage-reporting.enabled: false in plugins/EasyLinks/config.yml
  • for every plugin on the server that reports to trace: set enabled: false in plugins/trace/config.yml (written on first start)
  • for the whole server process: set the environment variable TRACE_USAGE_REPORTING=off (or DO_NOT_TRACK=1)

The plugin says on every start whether reporting is on. Details: https://danielstephenson.dev/usage-reporting

Contributing

About

This open source Minecraft plugin is intended to allow players to view relevant links with simple commands.

Topics

Resources

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Releases

Contributors

Languages