Skip to content

Commit c7ae51d

Browse files
committed
docs: Update documentation tooling/templates and re-generate
1 parent 80571c2 commit c7ae51d

11 files changed

Lines changed: 87 additions & 53 deletions

File tree

authme-core/src/test/java/tools/docs/commands/commands.tpl.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
<!-- {gen_warning} -->
2-
<!-- File auto-generated on {gen_date}. See docs/commands/commands.tpl.md -->
2+
<!-- File auto-generated on {gen_date}. See authme-core/src/test/java/tools/docs/commands/commands.tpl.md -->
33

44
## AuthMe Commands
55
You can use the following commands to use the features of AuthMe. Mandatory arguments are marked with `< >`
66
brackets; optional arguments are enclosed in square brackets (`[ ]`).
77

8+
The command tree is shared across the current Spigot Legacy, Spigot 1.21, and Paper 1.21 builds.
9+
810
[#commands]
911
- **{command}**{arguments}: {description}[permissions]
1012
<br />Requires `{permissions}`[/permissions]

authme-core/src/test/java/tools/docs/config/config.tpl.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
<!-- {gen_warning} -->
2-
<!-- File auto-generated on {gen_date}. See docs/config/config.tpl.md -->
2+
<!-- File auto-generated on {gen_date}. See authme-core/src/test/java/tools/docs/config/config.tpl.md -->
33

44
## AuthMe Configuration
55
The first time you run AuthMe it will create a config.yml file in the plugins/AuthMe folder,
66
with which you can configure various settings. The following is the initial contents of
77
the generated config.yml file.
88

9+
This configuration is generated from the shared `authme-core` module. It applies to the
10+
current Spigot Legacy, Spigot 1.21, and Paper 1.21 builds unless a setting comment says otherwise.
11+
912
```yml
1013
{config}
1114
```

authme-core/src/test/java/tools/docs/hashmethods/hash_algorithms.tpl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- {gen_warning} -->
2-
<!-- File auto-generated on {gen_date}. See docs/hashmethods/hash_algorithms.tpl.md -->
2+
<!-- File auto-generated on {gen_date}. See authme-core/src/test/java/tools/docs/hashmethods/hash_algorithms.tpl.md -->
33

44
## Hash Algorithms
55
AuthMe supports the following hash algorithms for storing your passwords safely.

authme-core/src/test/java/tools/docs/permissions/permission_nodes.tpl.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
<!-- {gen_warning} -->
2-
<!-- File auto-generated on {gen_date}. See docs/permissions/permission_nodes.tpl.md -->
2+
<!-- File auto-generated on {gen_date}. See authme-core/src/test/java/tools/docs/permissions/permission_nodes.tpl.md -->
33

44
## AuthMe Permission Nodes
55
The following are the permission nodes that are currently supported by the latest dev builds.
66

7+
Unless noted otherwise, these nodes are available across the current Spigot Legacy, Spigot 1.21,
8+
and Paper 1.21 builds.
9+
710
[#nodes]
811
- **{node}** – {description}
912
[/#nodes]
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- {gen_warning} -->
2-
<!-- File auto-generated on {gen_date}. See docs/translations/translations.tpl.md -->
2+
<!-- File auto-generated on {gen_date}. See authme-core/src/test/java/tools/docs/translations/translations.tpl.md -->
33

44
# AuthMe Translations
55
The following translations are available in AuthMe. Set `messagesLanguage` to the language code
@@ -8,7 +8,7 @@ in your config.yml to use the language, or use another language code to start a
88
Code | Language | Translated | &nbsp;
99
---- | -------- | ---------: | ------
1010
[#languages]
11-
[{code}](https://github.com/AuthMe/AuthMeReloaded/blob/master/src/main/resources/messages/messages_{code}.yml) | {name} | {percentage}% | <img src="https://via.placeholder.com/{percentage}x7/{color}?text=%20" alt="{percentage}" />
11+
[{code}](https://github.com/AuthMe/AuthMeReloaded/blob/master/authme-core/src/main/resources/messages/messages_{code}.yml) | {name} | {percentage}% | <img src="https://via.placeholder.com/{percentage}x7/{color}?text=%20" alt="{percentage}" />
1212
[/#languages]
1313

1414
{gen_footer}

authme-core/src/test/java/tools/utils/ToolsConstants.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ public final class ToolsConstants {
1111

1212
public static final String TOOLS_SOURCE_ROOT = "src/test/java/tools/";
1313

14-
public static final String DOCS_FOLDER = "docs/";
14+
// Docs are published at the repository root, while the tools run from the authme-core module.
15+
public static final String DOCS_FOLDER = "../docs/";
1516

1617
public static final String DOCS_FOLDER_URL = "https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/";
1718

docs/commands.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
<!-- AUTO-GENERATED FILE! Do not edit this directly -->
2-
<!-- File auto-generated on Sun Apr 04 21:31:42 CEST 2021. See docs/commands/commands.tpl.md -->
2+
<!-- File auto-generated on Mon Apr 20 11:07:34 CEST 2026. See authme-core/src/test/java/tools/docs/commands/commands.tpl.md -->
33

44
## AuthMe Commands
55
You can use the following commands to use the features of AuthMe. Mandatory arguments are marked with `< >`
66
brackets; optional arguments are enclosed in square brackets (`[ ]`).
77

8+
The command tree is shared across the current Spigot Legacy, Spigot 1.21, and Paper 1.21 builds.
9+
810
- **/authme**: The main AuthMeReloaded command. The root for all admin commands.
911
- **/authme register** &lt;player> &lt;password>: Register the specified player with the specified password.
1012
<br />Requires `authme.admin.register`
@@ -108,4 +110,4 @@ brackets; optional arguments are enclosed in square brackets (`[ ]`).
108110

109111
---
110112

111-
This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Sun Apr 04 21:31:42 CEST 2021
113+
This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Mon Apr 20 11:07:34 CEST 2026

docs/config.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
<!-- AUTO-GENERATED FILE! Do not edit this directly -->
2-
<!-- File auto-generated on Thu Jul 28 18:11:22 CEST 2022. See docs/config/config.tpl.md -->
2+
<!-- File auto-generated on Mon Apr 20 11:07:35 CEST 2026. See authme-core/src/test/java/tools/docs/config/config.tpl.md -->
33

44
## AuthMe Configuration
55
The first time you run AuthMe it will create a config.yml file in the plugins/AuthMe folder,
66
with which you can configure various settings. The following is the initial contents of
77
the generated config.yml file.
88

9+
This configuration is generated from the shared `authme-core` module. It applies to the
10+
current Spigot Legacy, Spigot 1.21, and Paper 1.21 builds unless a setting comment says otherwise.
11+
912
```yml
1013
DataSource:
1114
# What type of database do you want to use?
@@ -251,7 +254,7 @@ settings:
251254
# Maximum length of password
252255
passwordMaxLength: 30
253256
# Possible values: SHA256, BCRYPT, BCRYPT2Y, PBKDF2, SALTEDSHA512,
254-
# MYBB, IPB3, PHPBB, PHPFUSION, SMF, XENFORO, XAUTH, JOOMLA, WBB3, WBB4, MD5VB,
257+
# MYBB, IPB3, PHPBB, PHPFUSION, SMF, XENFORO, JOOMLA, WBB3, WBB4, MD5VB,
255258
# PBKDF2DJANGO, WORDPRESS, ROYALAUTH, ARGON2, CUSTOM (for developers only). See full list at
256259
# https://github.com/AuthMe/AuthMeReloaded/blob/master/docs/hash_algorithms.md
257260
# If you use ARGON2, check that you have the argon2 c library on your system
@@ -304,6 +307,10 @@ settings:
304307
forceKickAfterRegister: false
305308
# Does AuthMe need to enforce a /login after a successful registration?
306309
forceLoginAfterRegister: false
310+
# Show a graphical dialog UI for login/register instead of chat messages.
311+
# Requires Minecraft 1.21.6+ on Spigot, or 1.21.11+ on Paper.
312+
# On older server versions, this option is automatically ignored.
313+
useDialogUi: true
307314
# Enable to display the welcome message (welcome.txt) after a login
308315
# You can use colors in this welcome.txt + some replaced strings:
309316
# {PLAYER}: player name, {ONLINE}: display number of online players,
@@ -355,9 +362,15 @@ GroupOptions:
355362
Email:
356363
# Email SMTP server host
357364
mailSMTP: smtp.gmail.com
358-
# Email SMTP server port
365+
# Email SMTP server port. The port determines the encryption mode:
366+
# 25 -> plain SMTP; optional STARTTLS via 'useTls' (see below)
367+
# 465 -> implicit SSL/TLS (SMTPS); 'useTls' is ignored
368+
# 587 -> STARTTLS required (submission); 'useTls' is ignored
369+
# other -> STARTTLS required; 'useTls' is ignored
359370
mailPort: 465
360-
# Only affects port 25: enable TLS/STARTTLS?
371+
# Only applies to port 25: enable STARTTLS on the plain SMTP connection?
372+
# Has no effect when using port 465 (SSL) or 587 (STARTTLS), which enforce
373+
# their own encryption and cannot be overridden by this setting.
361374
useTls: true
362375
# Email account which sends the mails
363376
mailAccount: ''
@@ -386,6 +399,13 @@ Email:
386399
generateImage: false
387400
# The OAuth2 token
388401
emailOauth2Token: ''
402+
# Verify the SSL/TLS server certificate hostname?
403+
# Only applies when an SSL/TLS connection is active (port 465, port 587,
404+
# port 25 with useTls=true, or any other port).
405+
# Set to false only if your SMTP server uses a self-signed certificate.
406+
# Note: if you previously used port 465, this check was not enforced;
407+
# set to false to restore the old behavior with a self-signed certificate.
408+
sslCheckServerIdentity: true
389409
Hooks:
390410
# Do we need to hook with multiverse for spawn checking?
391411
multiverse: true
@@ -590,4 +610,4 @@ To change settings on a running server, save your changes to config.yml and use
590610

591611
---
592612

593-
This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Thu Jul 28 18:11:22 CEST 2022
613+
This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Mon Apr 20 11:07:35 CEST 2026

docs/hash_algorithms.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- AUTO-GENERATED FILE! Do not edit this directly -->
2-
<!-- File auto-generated on Sun Apr 04 21:31:44 CEST 2021. See docs/hashmethods/hash_algorithms.tpl.md -->
2+
<!-- File auto-generated on Mon Apr 20 11:07:36 CEST 2026. See authme-core/src/test/java/tools/docs/hashmethods/hash_algorithms.tpl.md -->
33

44
## Hash Algorithms
55
AuthMe supports the following hash algorithms for storing your passwords safely.
@@ -79,4 +79,4 @@ or bad.
7979

8080
---
8181

82-
This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Sun Apr 04 21:31:44 CEST 2021
82+
This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Mon Apr 20 11:07:36 CEST 2026

docs/permission_nodes.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
<!-- AUTO-GENERATED FILE! Do not edit this directly -->
2-
<!-- File auto-generated on Sun Apr 04 21:31:44 CEST 2021. See docs/permissions/permission_nodes.tpl.md -->
2+
<!-- File auto-generated on Mon Apr 20 11:07:36 CEST 2026. See authme-core/src/test/java/tools/docs/permissions/permission_nodes.tpl.md -->
33

44
## AuthMe Permission Nodes
55
The following are the permission nodes that are currently supported by the latest dev builds.
66

7+
Unless noted otherwise, these nodes are available across the current Spigot Legacy, Spigot 1.21,
8+
and Paper 1.21 builds.
9+
710
- **authme.admin.*** – Give access to all admin commands.
811
- **authme.admin.accounts** – Administrator command to see all accounts associated with a user.
912
- **authme.admin.antibotmessages** – Permission to see Antibot messages.
@@ -73,4 +76,4 @@ The following are the permission nodes that are currently supported by the lates
7376

7477
---
7578

76-
This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Sun Apr 04 21:31:44 CEST 2021
79+
This page was automatically generated on the [AuthMe/AuthMeReloaded repository](https://github.com/AuthMe/AuthMeReloaded/tree/master/docs/) on Mon Apr 20 11:07:36 CEST 2026

0 commit comments

Comments
 (0)