version 0.3.4-beta | testing ➡️ master

MaFeLP · Mar 17, 2021 · ea0d86c · ea0d86c
2 parents 6fd6c4e + 0205baa
commit ea0d86c
Show file tree

Hide file tree

Showing 80 changed files with 7,594 additions and 51 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,69 @@
+# Changelog
+## v0.3.4-beta
+### Changelog fixes
+🛠 Fixed some rendering bugs in the [changelog](./CHANGELOG.md).
+
+---
+
+## v0.3.3-beta
+### The changelog is here!
+➕ Added this changelog<br>
+➕ Added all features prior this release into this.
+
+---
+
+## v0.3.2-beta
+### 🐞 Bug fix
+🐞 Fixed bug in [DiscordMain.init()](./src/main/java/com/github/mafelp/discord/DiscordMain.java) where no token would cause an exception to trigger. It now returns, and the plugin doesn't crash anymore.
+
+---
+
+## v0.3.1-beta
+### 🏁 Commenting update!
+➕ Added building instructions with Java 8 <br>
+➕ Added full Javadoc documentation in [doc](./doc) <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
+
+---
+
+## v0.3-beta
+### 🏁 MCDC working 
+➕ Functions now represents the current status of the project.<br>
+➕ Added broadcasting of messages to discord channels defined in `<your sever folder>/plugins/MCDC/config.yml` For more information refer to the [README](./README.md)<br>
+➕ Added safety to Discord Messages: when this bot sends a message, it is being ignored.
+
+---
+
+## v0.2.1-beta
+### DC to MC now stable
+➕ Added configuration File support<br>
+➕ added CommandExecutor for /token in [Token.java](./src/main/java/com/github/mafelp/minecraft/commands/Token.java) <br>
+➕ you can use `/token <Token>` as OP or `token <token>` in the console to set your Discord bot API Token. This can be found on https://discord.com/developer/applications <br>
+🐞 Fixed Bug in [Main.onEnable()](./src/main/java/com/github/mafelp/minecraft/Main.java): Server was not able to fetch token from config.yml
+
+---
+
+## v0.2-beta
+### README, building from source and config files!
+🐞 Fixed bug, where the config would not be read, which caused the plugin to crash.<br>
+➕ Fixed Issues in/Added [README.md](./README.md) and [bash-scripts/build.sh](./bash-scripts/build.sh) <br>
+🖥 Replaced static version strings with variable in Settings.version<br>
+🖥 Added non-static API-Token support<br>
+➕ added CommandExecutor for `/token` in [Token.java](./src/main/java/com/github/mafelp/minecraft/commands/Token.java) <br>
+🖱️ you can use `/token <Token>` as OP or `token <token>` in the console to set your Discord bot API Token. This can be found on  https://discord.com/developer/applications <br>
+➕ Added configuration File support
+
+---
+
+## v0.1-beta
+🗡 Added plugin capability<br>
+🗡️ Members of a discord server, where the bot is invited can send messages to a text channel. These are getting broadcast to every online player.<br>
+🔊 The plugin connects as discord bot<br>
+🔊 You can send messages to any channel and that appear on the server<br>
+
+---
+
+What are you looking for, down here?<br>
+There was no version prior to [v0.1-beta](#v01-beta)...<br>
+[Go back up. Fast! You better use the latest version 😉](#changelog)
diff --git a/README.md b/README.md
@@ -6,8 +6,8 @@ The bot can currently do all the checked items, unchecked will be implemented in
  - [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
-    <br><br>
- - [ ] Display minecraft messages in a discord chat
+ - [X] Display minecraft messages in a discord chat
+ <br><br>
  - [ ] whisper between a discord user and a minecraft user
  - [ ] linking between a discord and a minecraft account
  - [ ] managing a "#mincraft-server" channel on a specific discord server
@@ -32,17 +32,28 @@ All the functionalities will be added in the future!</div>
 ### \<server directory\>/plugins/MCDC/config.yml:
 #### Default config:
 ```yaml
-apiToken: <Your API Token goes here. See Installation>  # string
-useShortMsgFormat: true                                 # boolean
+apiToken: <Your API Token goes here. See Installation>      # string
+useShortMsgFormat: true                                     # boolean
+pluginPrefix: <Formatted Plugin Prefix for console>         # String, optional 
+serverName: <A name for your server, displayed in Messages> # String
+channelIDs:                                                 # long list
+  - <ID of your first channel>                              # long
+  - <ID of your second channel>                             # long
+  - ...
 ```
-<div class="alert alert-info" role="alert">Coming in version beta 0.2!</div>
+
+### Get the ID of a text channel:
+1. In your discord app open the user settings (next to your mute buttons)
+2. Go to the tab `Appearence`
+3. Scroll down and in the tab `Advanced` check the box `Developer Mode`
+4. Close the settings and right click on a text channel. Then click `Copy ID`
 
 ---
 
 ## Building from source
 1. Install the following dependencies:
    - [maven](https://maven.apache.org/download.cgi)
-   - [JavaSE 16](https://www.oracle.com/java/technologies/javase-downloads.html)
+   - [JavaSE 15](https://www.oracle.com/java/technologies/javase-downloads.html)
    - or [java 8](https://java.com/en/download/) (Needs further configuration. See use with java8)
    - [git](https://git-scm.com/downloads)
 2. Open a shell and paste the following command in
@@ -51,6 +62,29 @@ git clone https://github.com/MaFeLP/MCDC.git
 cd MCDC/
 ```
 
+#### Using custom java version Java 8:
+In pom.xml edit the value for `<java.version>`:
+##### Normal:
+```xml
+<project>
+    <properties>
+        <java.version>15</java.version>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+   ...
+</project>
+```
+##### Using java 8:
+```xml
+<project>
+    <properties>
+        <java.version>1.8</java.version>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+   ...
+</project>
+```
+
 3. In this shell run:
 ### Automated in macOS and Linux:
 ```bash

diff --git a/doc/allclasses-index.html b/doc/allclasses-index.html
@@ -0,0 +1,169 @@
+<!DOCTYPE HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (15) on Wed Mar 17 20:30:16 CET 2021 -->
+<title>All Classes</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="dc.created" content="2021-03-17">
+<meta name="description" content="class index">
+<meta name="generator" content="javadoc/AllClassesIndexWriter">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
+<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="script-dir/jquery-3.5.1.min.js"></script>
+<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
+</head>
+<body class="all-classes-index-page">
+<script type="text/javascript">var pathtoroot = "./";
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<div class="flex-box">
+<header role="banner" class="flex-header">
+<nav role="navigation">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="top-nav" id="navbar.top">
+<div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<ul id="navbar.top.firstrow" class="nav-list" title="Navigation">
+<li><a href="index.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-files/index-1.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="sub-nav">
+<div class="nav-list-search"><label for="search">SEARCH:</label>
+<input type="text" id="search" value="search" disabled="disabled">
+<input type="reset" id="reset" value="reset" disabled="disabled">
+</div>
+</div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<span class="skip-nav" id="skip.navbar.top">
+<!--   -->
+</span></nav>
+</header>
+<div class="flex-content">
+<main role="main">
+<div class="header">
+<h1 title="All&amp;nbsp;Classes" class="title">All&nbsp;Classes</h1>
+</div>
+<div class="type-summary" id="all-classes-table">
+<table class="summary-table">
+<caption><span>Class Summary</span></caption>
+<thead>
+<tr>
+<th class="col-first" scope="col">Class</th>
+<th class="col-last" scope="col">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr class="alt-color" id="i0">
+<td class="col-first"><a href="com/github/mafelp/discord/ChannelAdmin.html" title="class in com.github.mafelp.discord">ChannelAdmin</a></td>
+<th class="col-last" scope="row">
+<div class="block">The class that manages the discord channels, whose messages are relayed to the
+ minecraft server and vise versa</div>
+</th>
+</tr>
+<tr class="row-color" id="i1">
+<td class="col-first"><a href="com/github/mafelp/discord/DiscordListener.html" title="class in com.github.mafelp.discord">DiscordListener</a></td>
+<th class="col-last" scope="row">
+<div class="block">Class that listens to all messages sent to a discord server
+ on which the bot is present on and can see the channels or
+ via direct message.</div>
+</th>
+</tr>
+<tr class="alt-color" id="i2">
+<td class="col-first"><a href="com/github/mafelp/discord/DiscordMain.html" title="class in com.github.mafelp.discord">DiscordMain</a></td>
+<th class="col-last" scope="row">
+<div class="block">The class that handles initiation and destruction of the discord bot instance(s)</div>
+</th>
+</tr>
+<tr class="row-color" id="i3">
+<td class="col-first"><a href="com/github/mafelp/minecraft/JoinListener.html" title="class in com.github.mafelp.minecraft">JoinListener</a></td>
+<th class="col-last" scope="row">
+<div class="block">Class handling Join events of players joining the server</div>
+</th>
+</tr>
+<tr class="alt-color" id="i4">
+<td class="col-first"><a href="com/github/mafelp/minecraft/commands/Link.html" title="class in com.github.mafelp.minecraft.commands">Link</a></td>
+<th class="col-last" scope="row">
+<div class="block">Class handling the linking of minecraft and discord accounts -
+
+ Warning This class in currently not implemented.</div>
+</th>
+</tr>
+<tr class="row-color" id="i5">
+<td class="col-first"><a href="com/github/mafelp/minecraft/Main.html" title="class in com.github.mafelp.minecraft">Main</a></td>
+<th class="col-last" scope="row">
+<div class="block">The main class which includes enable and
+ disable methods called by the server on startup
+ and shutdown or on reload.</div>
+</th>
+</tr>
+<tr class="alt-color" id="i6">
+<td class="col-first"><a href="com/github/mafelp/minecraft/MinecraftChatListener.html" title="class in com.github.mafelp.minecraft">MinecraftChatListener</a></td>
+<th class="col-last" scope="row">
+<div class="block">Class that reacts to chat messages sent on the minecraft server.</div>
+</th>
+</tr>
+<tr class="row-color" id="i7">
+<td class="col-first"><a href="com/github/mafelp/discord/RoleAdmin.html" title="class in com.github.mafelp.discord">RoleAdmin</a></td>
+<th class="col-last" scope="row">
+<div class="block">Class to manage the role that allows users to see the channel,
+ specified in ChannelAdmin
+
+ Warning This class in currently not implemented.</div>
+</th>
+</tr>
+<tr class="alt-color" id="i8">
+<td class="col-first"><a href="com/github/mafelp/Settings.html" title="class in com.github.mafelp">Settings</a></td>
+<th class="col-last" scope="row">
+<div class="block">Class containing all settings:
+ [
+   Internal variables,
+   user defined values,
+   handling configuration files
+ ]</div>
+</th>
+</tr>
+<tr class="row-color" id="i9">
+<td class="col-first"><a href="com/github/mafelp/minecraft/commands/Token.html" title="class in com.github.mafelp.minecraft.commands">Token</a></td>
+<th class="col-last" scope="row">
+<div class="block">"/token" command - use: set the discord api token with a command,
+ instead of using the configuration file</div>
+</th>
+</tr>
+</tbody>
+</table>
+</div>
+</main>
+<footer role="contentinfo">
+<nav role="navigation">
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottom-nav" id="navbar.bottom">
+<div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<ul id="navbar.bottom.firstrow" class="nav-list" title="Navigation">
+<li><a href="index.html">Overview</a></li>
+<li>Package</li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-files/index-1.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<span class="skip-nav" id="skip.navbar.bottom">
+<!--   -->
+</span></nav>
+</footer>
+</div>
+</div>
+</body>
+</html>