♟
API Examples
This page will help you understand how to install and use the SimpleClans API in your plugins.
There are two ways to do this: via Maven or locally.
We strongly recommend doing this via Maven.
Add the following lines to
pom.xml
:<repositories>
<repository>
<id>codemc-repo</id>
<url>https://repo.codemc.org/repository/maven-public</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>net.sacredlabyrinth.phaed.simpleclans</groupId>
<artifactId>SimpleClans</artifactId>
<version>2.15.2</version>
<!-- You can find out the latest available version in the note below -->
<scope>provided</scope>
</dependency>
</dependencies>
In this example, we will use the IntelliJ IDEA, but the following actions also work in other IDEs.
- 1.Open the structure of your project (
F4
) - 2.Select Libraries, click on the cross, select "New Project Library -> Java" in the window that appears and add SimpleClans.

Return to the project structure, then go to Project Settings - > Modules, set the compilation mode to "Provided".

- Congratulations, you have added the SimpleClans API to your project. 😃
- ClanPlayer is a class that represents a player object. This class contains information about the player, his clan, etc.
- Clan is a class that presents a clan object. It has methods for getting clan players, clan tag, allies, leaders, etc.
You can hook into SimpleClans plugin like so:
MyPlugin.class
Example.class
public class MyPlugin extends JavaPlugin {
private static MyPlugin instance;
private SimpleClans sc;
@Override
public void onEnable() {
instance = this;
Plugin plug = getServer().getPluginManager().getPlugin("SimpleClans");
if (plug != null) {
sc = (SimpleClans) plug;
}
}
public SimpleClans getSCPlugin() {
return sc;
}
public static getInstance() {
return instance;
}
}
public class Example {
public void doClanStuff(Player player) {
UUID playerUuid = player.getUniqueId();
// Get a ClanManager object
ClanManager cm = MyPlugin.getInstance().getSCPlugin().getClanManager();
// Get a ClanPlayer object
ClanPlayer cp = cm.getClanPlayer(playerUuid);
if (cp != null) {
Clan clan = cp.getClan();
} else {
// Player is not in a clan
}
// Get a clan from a clan tag
Clan clan = cm.getClan("staff");
if (clan != null) {
// Clan exists
}
}
}
If you don't want to specify a check for the presence of SimpleClans, you can always specify a dependency in
plugin.yml
:plugin.yml
depend:
- SimpleClans
Last modified 1yr ago