ChatSentry Wiki
Permissions
Commands
Module config guides
Plugin files
Search…
ChatSentry
Features
Compatibility details
Module list & info
FAQ
Perms & Cmds
Bypass & misc. permissions
Commands (and their permissions)
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
Lang file guide
contact
Get support, talk with other cs users, make suggestions, etc.
Plugin Files
Default plugin configs & other files
Misc info and resources
Preset word lists for the word and phrase filter
ChatSentry's SpigotMC Page
API
About
Accessing the API
API Documentation
Development
v5 Changelog
Legacy Changelogs
legal
Terms of Use Agreement
Powered By
GitBook
Accessing the API
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
https://chatsentry.xyz/api-download
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
1
name
:
ACoolPlugin
2
version
:
0.0.1
3
author
:
epic
-
programmer
4
main
:
main.path
5
depend
:
[
ChatSentry
]
Copied!
API - Previous
About
Next - API
API Documentation
Last modified
1yr ago
Copy link
Contents
Getting started
Importing with IntelliJ
Importing with Eclipse
Setting up your plugin