Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ready for Release v0.0.0 #1

Merged
merged 23 commits into from
Feb 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ Fixes # (issue)
- CPU:
- GPU:
- RAM:
* JDK: Java OpenJDK 11
* JDK: Java OpenJDK 17

---

## Checklist

- [ ] This pull request has been linked to the appropriate issue on GitHub. (Use the development section on the right.)
- [ ] The code follows the style [guidelines](https://github.com/Plyblox-Network/ProxyChat/blob/master/CONTRIBUTING.md).
- [ ] The code follows the style [guidelines](https://github.com/beanbeanjuice/SimpleProxyChat/blob/master/CONTRIBUTING.md).
- [ ] A self-review of the code was performed on GitHub.
- [ ] Appropriate comments and javadocs were added in your code.
- [ ] Appropriate changes have been made to the documentation.
Expand All @@ -49,4 +49,4 @@ Fixes # (issue)
- [ ] New and existing Maven CI tests have passed.
- [ ] The pull request is properly merging into the correct branch.
- [ ] All existing local code has been pushed to the GitHub repository.
- [ ] Changes have been documented in the current draft [ProxyChat Releases](https://github.com/Plyblox-Network/ProxyChat/releases) update.
- [ ] Changes have been documented in the current draft [ProxyChat Releases](https://github.com/beanbeanjuice/SimpleProxyChat/releases) update.
4 changes: 2 additions & 2 deletions .github/workflows/codeql-maven-workflow.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ jobs:
uses: actions/checkout@v4

- name: Set up JDK 17
uses: actions/setup-java@v3
uses: actions/setup-java@v4
with:
java-version: '17'
distribution: 'openjdk'
distribution: 'oracle'
cache: maven
- name: Build and Test with Maven
run: mvn test
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Please note we have a code of conduct, please follow it in all your interactions

## Branching

Now, make sure you are forking off of/branching off of the `integration` branch located [here](https://github.com/Plyblox-Network/ProxyChat/tree/integration). This allows new and upcoming changes to be pushed to a "working" directory rather than straight to the main, production directory. For example, this is how you may contribute.
Now, make sure you are forking off of/branching off of the `integration` branch located [here](https://github.com/beanbeanjuice/SimpleProxyChat/tree/integration). This allows new and upcoming changes to be pushed to a "working" directory rather than straight to the main, production directory. For example, this is how you may contribute.

Create a fork of the repository, and run the following commands in git CLI.

Expand Down
54 changes: 50 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,52 @@
# ProxyChat
# ProxyChat (BungeeCord/Waterfall/Velocity)

A simple plugin to send chat messages to other servers on the network.

Java Version
> JDK 17
A simple plugin to send chat messages to/from all servers on the network. This also includes to/from a Discord server.

---

## Setup Information
1) Go to discord.com/developers and select **New Application**. You can select *any* name you want.
1) Go to the **OAuth2** section.
1) Go to the **OAuth2 URL Generator** and give it the **bot** scope.
1) Under **bot permissions** select;
- Manage Channels (**REQUIRED**: General Permissions)
- Send Messages (**REQUIRED**: Text Permissions)
- Manage Messages (**REQUIRED**: Text Permissions)
- Read Message History (**REQUIRED**: Text Permissions)
- *+ Any others that you want to add...*
1) Copy the **Generated URL** at the bottom.
1) Paste the generated URL into a web browser.
1) Invite the bot to your server.
1) Go back to discord.com/developers.
1) Select your bot.
1) Click on **bot**.
1) Click **Reset Token** and copy the token somewhere safe.
1) Scroll down to **Privileged Gateway Intents**.
1) Select **SERVER MEMBER INTENT** and **MESSAGE CONTENT INTENT**.
1) Place the plugin in the `plugins` folder on **Bungeecord/Velocity**.
1) Start your server once *fully*, then stop it. There *will* be errors, this is normal.
1) In the generated `ProxyChat/config.yml` file, paste your **Bot Token** and choose the appropriate channel you want messages being sent to.
1) Restart your server!

---

## Requirements

* Java Version: 17+ (**REQUIRED**)
* PremiumVanish (**OPTIONAL**)
* SuperVanish (**OPTIONAL**)

---

## Caveats
As of right now, vanish support is only available on *BungeeCord/Waterfall*. The plugin will still function as normal, but if you go into vanish then it won't send a fake join/leave message.

---

## Statistics
### BungeeCord/Waterfall Graph
![alt text](https://bstats.org/signatures/bungeecord/SimpleProxyChat.svg)

### Velocity Graph
![alt text](https://bstats.org/signatures/velocity/SimpleProxyChat.svg)
110 changes: 110 additions & 0 deletions dependency-reduced-pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.beanbeanjuice</groupId>
<artifactId>SimpleProxyChat</artifactId>
<name>SimpleProxyChat</name>
<version>0.0.0</version>
<description>A simple plugin to send chat messages between servers as well as to Discord.</description>
<build>
<defaultGoal>clean package</defaultGoal>
<resources>
<resource>
<filtering>true</filtering>
<directory>src/main/resources</directory>
</resource>
</resources>
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>${java.version}</source>
<target>${java.version}</target>
</configuration>
</plugin>
<plugin>
<artifactId>maven-shade-plugin</artifactId>
<version>3.4.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
</execution>
</executions>
<configuration>
<filters>
<filter>
<artifact>*:*</artifact>
<excludes>
<exclude>META-INF/*.MF</exclude>
</excludes>
</filter>
</filters>
<relocations>
<relocation>
<pattern>dev.dejvokep.boostedyaml</pattern>
<shadedPattern>com.beanbeanjuice.simpleproxychat.libs</shadedPattern>
</relocation>
<relocation>
<pattern>net.dv8tion.jda</pattern>
<shadedPattern>com.beanbeanjuice.simpleproxychat.libs</shadedPattern>
</relocation>
<relocation>
<pattern>org.bstats</pattern>
<shadedPattern>com.beanbeanjuice.simpleproxychat.libs</shadedPattern>
</relocation>
</relocations>
</configuration>
</plugin>
</plugins>
</build>
<repositories>
<repository>
<id>sonatype</id>
<url>https://oss.sonatype.org/content/groups/public/</url>
</repository>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
<repository>
<id>papermc-repo</id>
<url>https://repo.papermc.io/repository/maven-public/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>net.md-5</groupId>
<artifactId>bungeecord-api</artifactId>
<version>1.20-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.velocitypowered</groupId>
<artifactId>velocity-api</artifactId>
<version>3.3.0-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.github.LeonMangler</groupId>
<artifactId>PremiumVanishAPI</artifactId>
<version>2.9.0-4</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>RELEASE</version>
<scope>provided</scope>
</dependency>
</dependencies>
<properties>
<maven.compiler.target>17</maven.compiler.target>
<java.version>17</java.version>
<maven.compiler.source>17</maven.compiler.source>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
</project>
Loading
Loading