RELEASE

CHANGELOG.md

@@ -1,4 +1,61 @@
 # Changelog
+## Account and config command
+➕ Added discord `/account` command<br>
+➕ Added discord `/config` command for administrators
+
+---
+
+## Help Command & Event Listeners
+➕ Added a help command for discord with nice buttons<br>
+➕ Added Event Listeners for the events:
+
+- Server starts/stops (plugin is loaded/unloaded)
+- Player joins/leaves the Server
+- Player gets an advancement
+- Player dies
+
+---
+
+## Tab Completions
+### v0.11.0-beta
+➕ Added Tab Completion to all Minecraft commands
+
+---
+
+## Slash Commands Update
+### v0.10.0
+➕ Added Slash Commands!<br>
+↳ Now use discord commands by using a slash (/) instead of the old discordCommandPrefix Entry in the config file <br><br>
+
+**⚠️ Information about slash commands⚠️**<br>
+ - It can take **up to** an hour until the slash commands are registered
+   - This is a caching limitation put in place by discord.
+ - If you do not see any slash commands after this hour, please see your console log for a link!
+ - You **CAN NOT** use normal message commands like `.setup` anymore. Use `/setup` instead, if you are the discord server **owner** and/or the bot owner.
+<br>
+🚫 Removed the old discord commands, that could be used in messages.
+
+---
+
+## BIG Account update
+### v0.9.0
+➕ Added Accounts! <br>
+↳ Place an account Tag in your minecraft message, and it will be replaced with a discord ping (if the user has a linked account)! <br>
+↳ Added a new minecraft command `/link`: Link your minecraft and discord accounts! <br>
+↳ Added a new minecraft command `/unlink`: Unlink your minecraft and discord accounts! <br>
+↳ Added a new minecraft command `/account`: Manage your accounts! <br>
+↳ Added a new minecraft command `/whisper`: Whisper to a friend on discord! <br>
+↳ Added a new minecraft command `/dcmsg`: Whisper to a friend on discord! <br>
+↳ Added a new discord command `<prefix>link`: Link your discord to your minecraft! <br>
+↳ Added a new discord command `<prefix>whisper`: Whisper your message to a minecraft player! <br>
+↳ Added a new discord command `<prefix>mcmsg`: Whisper your message to a minecraft player! <br>
+➕ Added some more toggles: <br>
+↳ The bot **can** send message with server commands and player commands to all the channels. <br>
+↳ Toggle, if the footer should be displayed. <br>
+↳ Toggle, if discord command messages should be deleted b the bot. <br>
+
+---
+
 ## Small bug fixes
 ### v0.8.4-beta
 ➕ Added Error message, when then bot does not have the required permissions, to create Channels or/and roles (See issue [29](https://github.com/MaFeLP/MCDC/issues/29)). <br>
@@ -157,7 +214,7 @@
 ## v0.3.1-beta
 ### 🏁 Commenting update!
 ➕ Added building instructions with Java 8 <br>
-➕ Added full Javadoc documentation in [doc](./doc) <br>
+➕ Added full Javadoc documentation in [doc](https://mafelp.github.io/MCDC/doc/development/index.html) <br>
 ➕ Added full commentary to the full code base<br>
 ➕ Added [RoleAdmin.java](./src/main/java/com/github/mafelp/discord/RoleAdmin.java) to prepare for Role management in coming builds
 

README.md

@@ -1,19 +1,29 @@
+![Java Version](https://img.shields.io/badge/Java%20Version-17-blue)
+
 # MCDC
 A [Minecraft](https://www.minecraft.net) plugin for [paper servers](https://papermc.io).
 
-## Functions
+## Features
 The bot can currently do all the checked items, unchecked will be implemented in the future.
  - [X] Display discord messages in the minecraft chat
     - [X] Discord messages can be sent to the bot via direct message
     - [X] Discord messages can be sent to any server channel the bot is present on
  - [X] Display minecraft messages in a discord chat
  - [X] managing a "#mincraft-server" channel on a specific discord server
-   - [ ] this includes that only members with a role can see this channel and write in it
- <br><br>
- - [ ] whisper between a discord user and a minecraft user
- - [ ] linking between a discord and a minecraft account
-<div class="alert alert-danger" role="alert">Remember that this plugin is currently in its beta phase!<br>
-All the functionalities will be added in the future!</div>
+   - [X] this includes that only members with a role can see this channel and write in it
+ - [X] whisper between a discord user and a minecraft user
+ - [X] linking between a discord and a minecraft account
+ - [X] Toggle-able: Sending minecraft commands to the discord chats.
+ - [X] Slash Commands: use slash commands in the discord chat.
+ - [X] Tab completion in Minecraft
+<br><br>
+ - [ ] A message in a channel that displays all online Members.
+ - [ ] Migrate more slash commands to discord
+   - [ ] `/account`
+   - [ ] `/config`
+ - [ ] Add a new command: `/help`
+   - [X] `/help` in minecraft
+   - [ ] `/help` in discord
 
 ## Installation
 1. Download the latest [release](https://github.com/MaFeLP/MCDC/releases/) and put it into `<your server directory>/plugins`.
@@ -60,12 +70,52 @@ apiToken: 'Your API Token goes here!'
 # Allowed values: any String
 discordCommandPrefix: '.'
 
+# Selects if messages that are commands should be deleted after execution.
+# Allowed values: <true|false>
+deleteDiscordCommandMessages: false
+
 # Discord Channel IDs to broadcast messages to.
 channelIDs:
    - 1234
 
+# Enables accounts and linking.
+# Allowed values <true|false>
+enableLinking: true
+
+# Allow players to list all the accounts.
+# Allowed values <true|false>
+allowListAllAccounts: true
+
+# Decides, if the config value 'serverName' should be displayed in the footer of discord messages.
+# Allowed values <true|false>
+showFooterInMessages: true
+
+# The value that should be displayed below the name
+activity:
+   # If the bot should have an activity.
+   enabled: true
+   # The type of the message, aka. the first word:
+   # can be set to custom, competing, listening, watching, streaming or playing
+   type: listening
+   # The text that should be displayed.
+   message: "your messages 👀"
+
+# If the bot should send a message to the listening channels, if a command was executed by ...
+sendCommandToDiscord:
+   # ... a player.
+   player: false
+   # ... the server.
+   server: false
+
 # Permission section for setting permission levels
 permission:
+   # The permissions on linking and editing accounts.
+   accountEdit:
+      # The OP level needed to remove accounts of players.
+      level: 3
+      # A list of UUIDs of Players who have a wildcard to use this command.
+      allowedUserUUIDs:
+         - a unique ID
 
    # Permission for minecraft command /config
    configEdit:

bash-scripts/package.sh

@@ -0,0 +1,141 @@
+#!/usr/bin/env bash
+
+if [ -z "$2" ]
+then
+  cat <<EOF
+  Packaging Script for MCDC
+
+  Options:
+  --------
+
+  Arguments:
+  ----------
+  1. Path to Minecraft folder (example: "$HOME/.minecraft")
+  2. Version to package (example: "0.12.0-beta")
+
+  Example:
+  --------
+  bash-scripts/package.sh "$HOME/.minecraft" "0.12.0-beta"
+EOF
+  exit 1
+fi
+
+echo ":: Building plugin with maven..."
+mvn clean package verify
+
+echo ":: Creating packaging directories"
+mkdir -pv /tmp/package/plugins/mcdc
+echo "==> Directory '/tmp/package/plugins/mcdc' and parents has been created!"
+echo ":: Copying files"
+cp -v defaultConfiguration.yml /tmp/package/plugins/mcdc/config.yml
+cp -v LICENSE /tmp/package/plugins/mcdc/LICENSE
+cp -v "target/mcdc-$2.jar" /tmp/package/plugins/
+
+# Create the config file for the advancements
+(
+  echo ":: Generating advancements.json file"
+  echo "==> Using Minecraft directory $1"
+  echo "==> Using Minecraft version 1.18"
+  echo "==> Using language: en_gb"
+  cd "$1/assets/" || exit 1
+  HASH=$(jq -r '.objects."minecraft/lang/en_gb.json".hash' < "indexes/1.18.json")
+  DIRECTORY=$(echo "$HASH" | cut -c '-2')
+  echo "==> Hash for file is: $HASH"
+  echo "==> Directory of Hash file is: $DIRECTORY"
+  echo "==> Extracting all advancements from the file..."
+  echo -n "{" > /tmp/advancements.json
+  grep '    "advancements.' < "objects/$DIRECTORY/$HASH" | sed -e 's/    "advancements./"/g' | tr '\n' ' ' | tr '\n' ' ' >> /tmp/advancements.json
+  echo "}" >> /tmp/advancements.json
+  sed -i 's/, }/}/g' /tmp/advancements.json
+  jq > "/tmp/advancements_new.json" < "/tmp/advancements.json"
+  mv "/tmp/advancements_new.json" "/tmp/package/plugins/mcdc/advancements.json"
+  echo "==> Advancement configuration created at '/tmp/package/plugins/mcdc/advancements.json'"
+)
+
+# Create the packages
+(
+  cd /tmp/package/ || exit 1
+  echo ":: Creating packages"
+  echo "==> Creating zip package"
+  zip -r -9 "mcdc-$2-package.zip" plugins
+  echo "==> Creating tar.gz package"
+  tar czfv "mcdc-$2-package.tar.gz" plugins
+  echo ":: Creating checksums"
+  cat > "ReleaseMessage.md" <<EOF
+## What's Changed
+- 🐞
+- ➡️
+- ➕
+
+## Which files do I have to download?
+It depends. If you want it easy, download either \`mcdc-$2-package.tar.gz\` (for Linux and MacOS
+or \`mcdc-$2-package.zip\` (for Windows). Unzip this file into your server directory.
+If you want to install everything manually, download the files needed. The jar is the plugin, the config contains
+default values and in the \`advancements.json\` there are default translationf or Minecraft\'s advancements.
+
+## Installation
+See [GitHub Pages](https://mafelp.github.io/MCDC/installation)
+
+## Configuration
+See [GitHub Pages](https://mafelp.github.io/MCDC/configuration)
+
+## Commands
+- Minecraft
+  - \`/link\`
+  - \`/token\`
+  - \`/config\`
+  - \`/account\`
+  - \`/unlink\`
+  - \`/whisper\`
+    - \`/dcmsg\`
+- Discord
+  - \`/help\`
+  - \`/createChannel\`
+  - \`/createRole\`
+  - \`/link\`
+  - \`/setup\`
+  - \`/unlink\`
+  - \`/whisper\`
+    - \`/mcmsg\`
+
+<!--TODO Add old tag-->
+## Changes
+- See the included Changelog
+- **Full Changelog**: https://github.com/MaFeLP/MCDC/compare/vX.XX.X-beta...v$2
+
+## Checksums:
+<details>
+<summary>Click to expand</summary>
+
+- mcdc-$2-package.tar.gz
+  - MD5: \`$(md5sum "mcdc-$2-package.tar.gz" | cut -d ' ' -f1)\`
+  - SHA1: \`$(sha1sum "mcdc-$2-package.tar.gz" | cut -d ' ' -f1)\`
+  - SHA256: \`$(sha256sum "mcdc-$2-package.tar.gz" | cut -d ' ' -f1)\`
+  - SHA512: \`$(sha512sum "mcdc-$2-package.tar.gz" | cut -d ' ' -f1)\`
+- mcdc-$2-package.zip
+  - MD5: \`$(md5sum "mcdc-$2-package.zip" | cut -d ' ' -f1)\`
+  - SHA1: \`$(sha1sum "mcdc-$2-package.zip" | cut -d ' ' -f1)\`
+  - SHA256: \`$(sha256sum "mcdc-$2-package.zip" | cut -d ' ' -f1)\`
+  - SHA512: \`$(sha512sum "mcdc-$2-package.zip" | cut -d ' ' -f1)\`
+- mcdc-$2.jar
+  - MD5: \`$(md5sum "plugins/mcdc-$2.jar" | cut -d ' ' -f1)\`
+  - SHA1: \`$(sha1sum "plugins/mcdc-$2.jar" | cut -d ' ' -f1)\`
+  - SHA256: \`$(sha256sum "plugins/mcdc-$2.jar" | cut -d ' ' -f1)\`
+  - SHA512: \`$(sha512sum "plugins/mcdc-$2.jar" | cut -d ' ' -f1)\`
+
+</details>
+EOF
+  if [ -z "$EDITOR" ]
+  then
+    nano "ReleaseMessage.md"
+  else
+    "$EDITOR" "ReleaseMessage.md"
+  fi
+  echo "Done!"
+)
+
+gh release view "$2"
+echo ":: Uploading assets to GitHub"
+gh release upload "v$2" "/tmp/package/plugins/mcdc/advancements.json" "/tmp/package/plugins/mcdc/config.yml" "/tmp/package/plugins/mcdc/LICENSE" "/tmp/package/plugins/mcdc-$2.jar" "/tmp/package/mcdc-0.12.0-beta-package.tar.gz" "/tmp/package/mcdc-0.12.0-beta-package.zip"
+echo "Printing final Release Message:"
+cat "/tmp/package/ReleaseMessage.md"

defaultConfiguration.yml

@@ -25,13 +25,65 @@ apiToken: 'Your API Token goes here!'
 # Allowed values: any String
 discordCommandPrefix: '.'
 
+# Selects if messages that are commands should be deleted after execution.
+# Allowed values: <true|false>
+deleteDiscordCommandMessages: false
+
 # Discord Channel IDs to broadcast messages to.
 channelIDs:
   - 1234
 
+# Discord Role IDs that hav permission to use slash commands
+roleIDs:
+  - 1234
+
+# Enables accounts and linking.
+# Allowed values <true|false>
+enableLinking: true
+
+# Allow players to list all the accounts.
+# Allowed values <true|false>
+allowListAllAccounts: true
+
+# Decides, if the config value 'serverName' should be displayed in the footer of discord messages.
+# Allowed values <true|false>
+showFooterInMessages: true
+
+# The value that should be displayed below the name
+activity:
+  # If the bot should have an activity.
+  enabled: true
+  # The type of the message, aka. the first word:
+  # can be set to custom, competing, listening, watching, streaming or playing
+  type: listening
+  # The text that should be displayed.
+  message: "your messages 👀"
+
+# If the bot should send a message to the listening channels, if a command was executed by ...
+sendCommandToDiscord:
+  # ... a player.
+  player: false
+  # ... the server.
+  server: false
+
+# Server events that will trigger a message in discord
+events:
+  - JoinEvent # When a player joins the Server
+  - LeaveEvent # When a player leaves the Server
+  - PlayerAdvancementEvent # When a player gets a new Advancement
+  - PlayerDeathEvent # When a Player dies
+  - ServerStartupEvent # When the minecraft server starts
+  - ServerShutdownEvent # When the minecraft server stops
 
 # Permission section for setting permission levels
 permission:
+  # The permissions on linking and editing accounts.
+  accountEdit:
+    # The OP level needed to remove accounts of players.
+    level: 3
+    # A list of UUIDs of Players who have a wildcard to use this command.
+    allowedUserUUIDs:
+      - a unique ID
 
   # Permission for minecraft command /config
   configEdit: