/PerWorldChatPlus

PerWorldChatPlus is a Bukkit plugin that makes chat per world, handles other chat functions, and serves as an API for developers.

Primary LanguageJava

#PerWorldChatPlus

##About PerWorldChatPlus is a Bukkit plugin that makes chat per world, handles various other chat functions and servers as an API for developers.
PWCP handles chat in a unique way. Funnelling it through many validators, placeholders and filters, PWCP is able to make chat per world (or grouped), detect and block swears, spam, and ads, and more!

##Current Features

  • Per world chat (can be disabled)
  • Automatic update checker and automatic update downloader (if enabled via config.yml).
  • Chat sharing across worlds. Link worlds together so they share their chat.
  • Chat bypass to make your chat global.
  • Timed Global chat. Make chat global for a limited period of time.
  • Alert System (add a word to your list and get notified of when it is said in chat).
  • Mention system (get a notice when you are mentioned in chat).
  • Integrated ChatColor support. Make your messages colorful without needing to use codes every time!
  • Along with the integrated ChatColor support, PerWorldChatPlus supports a GUI selector for ChatColors!
  • Anti-Swear system. Block those bad words!
  • Anti-Ad System. Block all the unwanted advertisements!
  • And much much more!

##Planned Features (in order of importance)

  • PerWorldChatPlus as standalone chat provider.
  • More variables in format.
  • Improvement to the developer API.
  • Anti-spam (WIP).
  • Better detection of IP Addresses.
  • Better detection of websites.
  • And more!!

##Issues Should you find an issue with PerWorldChatPlus, please create a new issue in the Issues pages on this repository or via Dev Bukkit with a proper ticket.

##For Developers PerWorldChatPlus also functions as a versatile API!
To use this API within your own Bukkit plugin, please follow the directions below:
NOTE: This only applies to Maven projects currently.

  1. In your pom.xml insert the following repository and depend, where version is the target version (API only exists in 5.0.0 and higher):
<repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
    <dependency>
        <groupId>com.github.NovaFox161</groupId>
        <artifactId>PerWorldChatPlus</artifactId>
        <version>VERSION</version>
    </dependency>
  1. Use the javadoc provided here: http://novafox161.github.io/PerWorldChatPlus/
  2. In your main class, in #OnEnable add this code (extra code shown for extra help):
   public class Main extends JavaPlugin {
       public void onEnable() {
           //Do stuff...
           
           //Add this code:
           Plugin pwcp = plugin.getServer().getPluginManager().getPlugin("PerWorldChatPlus");
           if (pwcp != null) {
               //Check version and do anything else here
           }
           //Do stuff...
       }
   }
  1. And now you can start using PWCP in your plugin. Just check the Javadoc for extra help!

Contributing

  1. Fork this repo and make changes in your own copy
  2. Add a test if applicable and run the existing tests with mvn clean test to make sure they pass
  3. Commit your changes and push to your fork git push origin master
  4. Create a new pull request and submit it back to us!

    NOTE: Please do not build. PWCP has resources that are not committed to GitHub and will fail if not present.
    x NOTE: We will never claim ownership or responsibility for something we did not make. You will be given full credit for your contributions.