ChatSentry Wiki
  • ChatSentry
  • Features
  • Compatibility details
  • Module list & info
  • FAQ
  • Perms & Cmds
    • Bypass & misc. permissions
    • Commands (and their permissions)
      • In-game view
      • In depth command usages
  • guides
  • Plugin installation & configuring guide
  • Network bridge setup guide
  • In depth Word & Phrase Filter block list setup
  • In depth Chat Executor guide & entry examples
  • Config guides
    • Main/core config guide
    • Module config guides
      • Admin Notifier
      • Anti Chat Flood
      • Anti Command Prefix
      • Anti Join Flood
      • Anti Parrot
      • Anti Statue Spambot
      • Auto Grammar
      • Auto Punisher
      • Cap Limiter
      • Chat Cooldown
      • Chat Executor
      • Command Spy
      • Link & Ad Blocker
      • Spam Blocker
      • Unicode Remover
      • Word & Phrase Filter
    • Lang file guide
  • contact
  • Get support, talk with other cs users, make suggestions, etc.
  • Plugin Files
    • Default plugin configs & other files
      • /ChatSentry
        • config.yml
        • lang.yml
        • storage.yml
        • changelog.txt
      • /ChatSentry/Modules
        • admin-notifier.yml
        • anti-chat-flood.yml
        • anti-command-prefix.yml
        • anti-join-flood.yml
        • anti-parrot.yml
        • anti-statue-spambot.yml
        • auto-grammar.yml
        • auto-punisher.yml
        • cap-limiter.yml
        • chat-cooldown.yml
        • chat-executor.yml
        • command-spy.yml
        • link-and-ad-blocker.yml
        • spam-blocker.yml
        • unicode-remover.yml
        • word-and-phrase-filter.yml
  • Misc info and resources
    • Preset word lists for the word and phrase filter
    • ChatSentry's SpigotMC Page
  • API
    • About
    • Accessing the API
    • API Documentation
      • Events
      • Methods
  • Development
    • v5 Changelog
    • Legacy Changelogs
      • v4 Changelog
      • v3 Changelog
      • v2 Changelog
      • v1 Changelog
  • legal
    • Terms of Use Agreement
Powered by GitBook
On this page
  • Getting started
  • Importing with IntelliJ
  • Importing with Eclipse
  • Setting up your plugin

Was this helpful?

  1. API

Accessing the API

PreviousAboutNextAPI Documentation

Last updated 4 years ago

Was this helpful?

Getting started

In order to use the API you must download and import it into your project. Follow the steps below to do this before moving forward.

Download:

Go to to download the API jar

Importing with IntelliJ

  1. Click on File -> Project Structure (Ctrl + Alt + Shift + S on windows)

  2. Go to the Modules tab, then to the Dependencies subtab

  3. Click the + on the bottom left side and choose Library... -> Java (see below image)

  4. Choose your downloaded API jar

Importing with Eclipse

  1. Right-click your project and choose Properties -> Java Build Path

  2. Click on Add external jar and add your downloaded API jar

Setting up your plugin

The next step is to go to your plugin.yml and add ChatSentry as a depend or softdepend, depending on if it is optional or not for your plugin to work

softdepend is used if your plugin works without ChatSentry installed on the server

depend is used if your plugin requires ChatSentry to be installed on the server

Example plugin.yml
name: ACoolPlugin
version: 0.0.1
author: epic-programmer
main: main.path
depend: [ChatSentry]
https://chatsentry.xyz/api-download