Nickname Request - Speedgot

Nickname Request -----

A simple Nickname Request System - Making nicknaming easier!

Nickname Request Lite
Nicknames made easy.
Version v0.10

Attention: This Plugin is Alpha, Expect possible bugs!
But don't worry, I'm running this on a busy server, most
issues will be worked out pretty quickly.

ATTENTION!
Want to support development of this plugin?
Donate to PayPal to help me out!
You can find the donate button at the bottom of this description!

What is this plugin?
Nickname Request is a standalone nickname system that allows users to have custom names in servers, It works with all plugins that use the standard Spigot Player Method getDisplayName() which most do.

On Servers with a moderate amount of players staff may be constantly having to change nicknames for users upon request.

Users simply request a nickname regardless of staff being online, When staff next join and approve/deny the nickname the user will be notified when they next join or instantly if they're online still.

What makes it better than say, Essentials?
Essentials has the basic /nick command for manually setting nicks, Not to mention its not possible to have the nickname "Off" without Essentials simply removing your nickname.

This system allows setting a nickname to 'off', You don't require Essentials just for nicknames. Staff don't have to labouriously type out a nickname, colourcodes and all. Nicknames are shown to staff as they would appear in chat. Great for people who try and hide abuse or the Obfuscation formatting code among other colourcodes and letters.

How do I configure this plugin?
There's nothing much to configure. When you've changed your config restart your server. (Avoid /reload!)

nick-format - What format should nicknames take internally, This is to emulate the format Essentials has where the prefix of the players group is added. See the config for all placeholders.

What are the commands?
All the commands have their respective permissions to control access to them, The commands are as follows:

/nick request - Request a nickname
/nick accept username - Accept a users nickname request.
/nick deny username - Deny a users nickname request.
/nick status - Check the status of your pending nickname request.
/nick set [username] nickname - Change a users nickname or your own.
/nick remove [username] - Remove a users nickname or your own.
/nick cancel - Cancel your pending nickname request
/nick list - List all pending nickname requests.
/nick restrict username [time] - Restricts a users ability to request a nick
/nick unrestrict username - Unrestricts a users ability to request a nick
/nick info [username] - Checks nick info for yourself or another player

What are the permissions?
Here are the permissions and what they do:

nicknamerequest.request
Access to /nick request

nicknamerequest.accept
Access to /nick accept

nicknamerequest.deny
Access to /nick deny

nicknamerequest.status
Access to /nick status

nicknamerequest.set
Access to /nick set

nicknamerequest.remove.self
Remove your own nickname via /nick remove

nicknamerequest.remove.others
Remove other users nicknames.

nicknamerequest.cancel
Cancel your pending nickname request.

nicknamerequest.list
Access to /nick list

nicknamerequest.notify
Anyone with this perm is alerted to new requests as well as accepted/denied requests.

nicknamerequest.restrict
Allows access to /nick restrict and /nick unrestrict which enable or disable a users access to request a nickname

nicknamerequest.info
Allows you to check your nick info, what nickname you have, if you've requested a nickname and if you're allowed to request a nickname

nicknamerequest.info.others
Allows you to check other players nick info

Formatting permissions:
They're pretty easy to understand, refer to [this] wiki page for the actual colours the names belong to. All users by default are not allowed formatting. Add the formatting for each colour or formatting type you wish them to have.

General Formatting:
nicknamerequest.allow.bold
nicknamerequest.allow.italic
nicknamerequest.allow.underline
nicknamerequest.allow.strikethrough
nicknamerequest.allow.obfuscated

General Colours:
nicknamerequest.allow.dark_blue
nicknamerequest.allow.dark_green
nicknamerequest.allow.dark_aqua
nicknamerequest.allow.dark_red
nicknamerequest.allow.dark_purple
nicknamerequest.allow.dark_gray
nicknamerequest.allow.black
nicknamerequest.allow.gold
nicknamerequest.allow.gray
nicknamerequest.allow.blue
nicknamerequest.allow.green
nicknamerequest.allow.aqua
nicknamerequest.allow.red
nicknamerequest.allow.yellow
nicknamerequest.allow.white
nicknamerequest.allow.light_purple

Extra formatting:
nicknamerequest.allow.spaces (Allows users to have spaces in nicknames)

Known Bugs:
Quite a handful probably, I'll be sure to update this list and patch them if they're brought to my attention

When permissions are modified Nicknames/Displaynames will not update to reflect group changes, prefix/suffix changes. The user must reconnect for this to be reapplied.
Unable to set another players nickname to a nickname with spaces via "/nick set username some nick" this results in the player taking the first word of the nick. For example "some" in this case.

Existing Integration's:

StaleAPI (https://www.spigotmc.org/resources/staleapi.7706/)
If StaleAPI is installed on your server nicknames and pending requests will auto expire upon StaleAPI's command.

Current Features:

- Nickname Requests
- Permission based formatting (control what a user can use)
- Request cooldowns
- Request restriction (Individually deny access, Timed if needed)
- Custom language strings
- MySQL and Flatfile support with data migration
- Vault Support
- StaleAPI Support
- Interactive chat, accept/deny without a single command.

Planned Features:

Better command syntax and messages about lacking permissions.

Using alongside Essentials:
Doing the following steps will disable Essentials' nicknames, this will also disable saved nicknames for users. They won't be lost. Essentials simply won't apply them.

Open your Essentials configuration 'config.yml'
Find "change-displayname" and set to false.
Find "add-prefix-suffix" and set to false.
Find "disabled-commands" and uncomment/add "- nick"

Done, This will stop Essentials from modifying users names, allowing Nickname Request to deal with this.

To further disable Essentials responding to nicknames, Open up commands.yml for Spigot/Paper/Bukkit and add

nick:
- nicknamerequest:nick $1-

Similar to this:
[IMG]

Towny, TownyChat and Essentials:
If you run a Towny server with TownyChat and Essentials but you use {modplayername} for the users Group Prefix and Nickname in the "ChatConfig.yml" you'll want to add {permprefix} or/and {permsuffix} accordingly.

Additionally:
Feel free to leave suggestions, bug reports, error reports and such below or in the plugin discussion. I'll do my best to reply!

But please don't forget,
Nickname Request is currently in Alpha.
Although its rather stable and contains the bare essentials for such a system, a lot more will be added as well as bug fixes and other patches.

If you've made a plugin with the same name as this plugin, released before 12th May 2015, Please contact me and I'll willingly change my plugins name. Enjoy!

Networks/Servers using NicknameRequest:
Want your server name here?
Drop your server name and its web address in the plugin discussion forum and I'll add it!