Skip to content

Commit

Permalink
Merge branch 'MajekDev:main' into folia
Browse files Browse the repository at this point in the history
  • Loading branch information
ewof authored Jul 26, 2023
2 parents 75b9ab1 + 86d70ab commit b405506
Show file tree
Hide file tree
Showing 10 changed files with 46 additions and 28 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Plugin Changelog

# 3.1.1 - Dependency Bumps

- Bumped dependencies.
- Officially added 1.20+ support (it worked already, but now I've tested it).

This is an optional update. You will likely see no difference in game.

# 3.1.0 - Hello Hikari

- Started using [HikariCP](https://github.com/brettwooldridge/HikariCP) for managing MySQL.
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/chat-formatting.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ slug: /chat-formatting
The built-in chat formatter allows HexNicks to control how your chat is formatted. If you would rather use a
different plugin to format your chat then HexNicks' chat formatter can always be disabled in the config. Modify
the chat format to your liking in the `chat-format` field of the config
[here](https://github.com/MajekDev/HexNicks/blob/57e09bd43cfd9df96d74263f192dea6c03f3fe6f/src/main/resources/config.yml#L22).
[here](https://github.com/MajekDev/HexNicks/blob/main/src/main/resources/config.yml#L22).

> Read about the config options [here](https://github.com/MajekDev/HexNicks/wiki/Configuration-Options).
> Read about the config options [here](https://hexnicks.majek.dev/config-options).
By default, the chat format is the same as vanilla Minecraft, with angle brackets around the display name (nickname).
This can be changed to whatever format you like, but please remember to maintain correct YAML syntax. Use a syntax checker
Expand Down
11 changes: 6 additions & 5 deletions docs/docs/color-formatting.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,20 @@ slug: /color-formatting
---

One of the most important parts of HexNicks is, of course, colors! With the addition of
[MiniMessage](https://github.com/KyoriPowered/adventure/tree/main/4/text-minimessage) there are now even more ways to
[MiniMessage](https://docs.advntr.dev/minimessage/index.html) there are now even more ways to
customize colors in your nickname. HexNicks can support legacy colors but supports, and encourages, MiniMessage colors.

## MiniMessage Colors
MiniMessage uses tags for colors and formatting. Tags have a start tag and an end tag. Start tags are mandatory
(obviously), end tags aren’t. `<yellow>Hello <blue>World<yellow>!` and `<yellow>Hello <blue>World</blue>!` and
even `<yellow>Hello </yellow><blue>World</blue><yellow>!</yellow>` all do the same. Read the full documentation
for MiniMessage [here](https://docs.adventure.kyori.net/minimessage/format).
for MiniMessage [here](https://docs.advntr.dev/minimessage/format.html).

## Legacy Colors
These are the color codes that a lot of people are still used to. Codes like `&a`, `&l`, `&x&r&r&g&g&b&b`.
These are called legacy codes because the Minecraft chat, and other things, does not use raw strings anymore.
By default, HexNicks will not parse these codes. If you want to use them in your nicknames you need to enable `legacy-support` in the config.
By default, HexNicks will not parse these codes. If you want to use them in your nicknames you need to
enable `legacy-support` in the config.

> See config documentation [here](https://hexnicks.majek.dev/config-options).
Expand All @@ -27,6 +28,6 @@ You will **not** receive support for issues with legacy color codes. You should

## Gradients
Everyone's favorite thing as of late, gradients! Gradients are parsed using MiniMessage, and you can read the
documentation for them [here](https://docs.adventure.kyori.net/minimessage/format#gradient).
documentation for them [here](https://docs.advntr.dev/minimessage/format.html#gradient).

> View nickname examples using gradients [here](https://docs.adventure.kyori.net/minimessage/format#gradient).
> View nickname examples using gradients [here](https://docs.advntr.dev/minimessage/format.html#gradient).
4 changes: 2 additions & 2 deletions docs/docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Usage: `/nick <nickname>`

This is the command players will use to change their nickname. It requires one argument (the nickname) and unless
you disable `require-alphanumeric` in the
[config](https://hexnicks.majek.dev/config-options#Require-Alphanumeric)
[config](https://hexnicks.majek.dev/config-options#require-alphanumeric)
then the nickname may only contain valid color codes, letters, and numbers. If you want nicknames with spaces, special
characters, etc. then go ahead and disable that config option.

Expand Down Expand Up @@ -81,7 +81,7 @@ This will either create a new link to the config file in pastebin or apply chang

1. First, execute `/hexnicks config-editor new` to create a new pastebin with your config. The command will give you the link.
2. Then, make all your desired changes to the config in the pastebin.
3. Make sure to press save in the upper left corner of the pastebin. You will get a new link. (It should copy to your clipboard automatically)
3. Make sure to press save in the upper left corner of the pastebin. You will get a new link (It should copy to your clipboard automatically).
4. Take your new link and execute `/hexnicks config-editor apply <link>` to apply your changes.
5. That's it! The plugin will automatically reload, and you're good to go.

Expand Down
10 changes: 10 additions & 0 deletions docs/docs/config-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@ slug: /config-options
HexNicks' [config](https://github.com/MajekDev/HexNicks/blob/main/src/main/resources/config.yml) is documented fairly
well but this page will try to explain some of the more confusing bits.

# Config File Editing
You are now able to edit the plugin config file in your browser. Steps:
1. First, execute `/hexnicks config-editor new` to create a new pastebin with your config. The command will give you the link.
2. Then, make all your desired changes to the config in the pastebin.
3. Make sure to press save in the upper left corner of the pastebin. You will get a new link (It should copy to your clipboard automatically).
4. Take your new link and execute `/hexnicks config-editor apply <link>` to apply your changes.
5. That's it! The plugin will automatically reload, and you're good to go.

# Options

## Require Alphanumeric

This config option requires all nicknames to contain nothing but characters a-z, lower and upper case,
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ HexNicks is hosted in Majekdor's Maven Repository [here](https://repo.majek.dev)
<dependency>
<groupId>dev.majek</groupId>
<artifactId>hexnicks</artifactId>
<version>3.1.0</version>
<version>3.1.1</version>
<scope>provided</scope>
</dependency>
</dependencies>
Expand All @@ -38,7 +38,7 @@ repositories {
}
dependencies {
compileOnly "dev.majek:hexnicks:3.1.0"
compileOnly "dev.majek:hexnicks:3.1.1"
}
```

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ There are only a few commands and permissions to limit what players use what com
for MySQL storage, it's mostly intended to be a simple nickname plugin for smaller Paper servers.

This documentation is a constant work in progress so if you feel something is missing feel free to open an issue.
The wiki is organized into different pages for things like commands, permissions, etc. If you have questions the wiki
doesn't cover, please either post in [discussions](https://github.com/Majekdor/HexNicks/discussions) or
The docs are organized into different pages for things like commands, permissions, etc. If you have questions the docs
don't cover, please either post in [discussions](https://github.com/Majekdor/HexNicks/discussions) or
join my [Discord](https://discord.majek.dev).

The HexNicks code lives on GitHub. If you have a bug report, or even a feature request, feel free to open an
Expand Down
18 changes: 9 additions & 9 deletions docs/docs/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,47 +8,47 @@ All permissions except `hexnicks.nick.other`, `hexnicks.nonick.other`, `hexnicks
`hexnicks.config-editor`, and `hexnicks.reload` are given to all players by default but can be negated by a permissions
manager like [LuckPerms](https://luckperms.net/). Learn how to do that [here](#how-to-negate-permissions-with-LuckPerms).

A lot of these permissions are tied to commands, read command documentation [here](https://github.com/Majekdor/HexNicks/wiki/Commands).
A lot of these permissions are tied to commands, read command documentation [here](https://hexnicks.majek.dev/commands).

## hexnicks.nick

This permission node allows players to use the command [/nick](https://github.com/Majekdor/HexNicks/wiki/Commands#nick)
This permission node allows players to use the command [/nick](https://hexnicks.majek.dev/commands#nick)
to change their nickname.

## hexnicks.nick.other

This permission node is intended for staff and allows them to use the command
[/nickother](https://github.com/Majekdor/HexNicks/wiki/Commands#nickother) to change the nickname of other players.
[/nickother](https://hexnicks.majek.dev/commands#nickother) to change the nickname of other players.

## hexnicks.nonick

This permission node allows players to use the command [/nonick](https://github.com/Majekdor/HexNicks/wiki/Commands#nonick)
This permission node allows players to use the command [/nonick](https://hexnicks.majek.dev/commands#nonick)
to remove their nickname.

## hexnicks.nonick.other

This permission node is intended for staff and allows them to remove the nickname of another player using
[/nonick](https://github.com/Majekdor/HexNicks/wiki/Commands#nonick).
[/nonick](https://hexnicks.majek.dev/commands#nonick).

## hexnicks.nickcolor

This permission node allows players to use [/nickcolor](https://github.com/Majekdor/HexNicks/wiki/Commands#nickcolor)
This permission node allows players to use [/nickcolor](https://hexnicks.majek.dev/commands#nickcolor)
to change just the color of their nickname.

## hexnicks.realname

This permission node allows players to use [/realname](https://github.com/Majekdor/HexNicks/wiki/Commands#realname)
This permission node allows players to use [/realname](https://hexnicks.majek.dev/commands#realname)
to view the name of a player using a certain nickname.

## hexnicks.config-editor

This permission node is intended for staff and allows them to edit the HexNicks config via
[pastebin](https://paste.majek.dev) using [/hexnicks config-editor](https://github.com/Majekdor/HexNicks/wiki/Commands#hexnicks).
[pastebin](https://paste.majek.dev) using [/hexnicks config-editor](https://hexnicks.majek.dev/commands#hexnicks).

## hexnicks.reload

This permission node is intended for staff and allows them to use
[/hexnicks reload](https://github.com/Majekdor/HexNicks/wiki/Commands#hexnicks) to reload the plugin.
[/hexnicks reload](https://hexnicks.majek.dev/commands#hexnicks) to reload the plugin.

## hexnicks.chat.advanced

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/version-3.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You are now able to edit the plugin config file in your browser. Steps:
1. Type `/hexnicks config-editor new` to get a link to the config file.
2. Follow the link and make all of your changes.
3. Save the file in paste bin and copy the link.
4. Type `/hexnicks config-editor apply <link>`, replacing `<link>` with the link you copied
4. Type `/hexnicks config-editor apply <link>`, replacing `<link>` with the link you copied.
5. That's it! Your config file is updated and reloaded automatically.

### New Placeholders
Expand Down
10 changes: 5 additions & 5 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<groupId>dev.majek</groupId>
<artifactId>hexnicks</artifactId>
<version>3.1.0</version>
<version>3.1.1</version>
<packaging>jar</packaging>

<name>HexNicks</name>
Expand Down Expand Up @@ -41,7 +41,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.10.1</version>
<version>3.11.0</version>
<configuration>
<source>17</source>
<target>17</target>
Expand All @@ -50,7 +50,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.4.1</version>
<version>3.5.0</version>
<executions>
<execution>
<id>attach-javadocs</id>
Expand Down Expand Up @@ -151,7 +151,7 @@
<dependency>
<groupId>org.jetbrains</groupId>
<artifactId>annotations</artifactId>
<version>24.0.0</version>
<version>24.0.1</version>
<scope>compile</scope>
</dependency>
<!-- PlaceholderAPI -->
Expand All @@ -165,7 +165,7 @@
<dependency>
<groupId>org.bstats</groupId>
<artifactId>bstats-bukkit</artifactId>
<version>3.0.0</version>
<version>3.0.1</version>
<scope>compile</scope>
</dependency>
<!-- Vault -->
Expand Down

0 comments on commit b405506

Please sign in to comment.