Using the API

Step 1. Connect the plugin to your project.

// Maven
<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

<dependency>
    <groupId>com.github.Enc0urager</groupId>
    <artifactId>GreatCombat</artifactId>
    <version>{version}</version>
    <scope>provided</scope>
</dependency>

// Gradle
dependencyResolutionManagement {
	repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
	repositories {
		mavenCentral()
		maven { url 'https://jitpack.io' }
	}
}

dependencies {
        implementation 'com.github.Enc0urager:GreatCombat:{version}'
}

You can check the current version here - https://jitpack.io/#Enc0urager/GreatCombat

Step 2. Add the plugin to the dependencies in plugin.yml

# If we want to make the dependency mandatory.
depend:
  - GreatCombat
  
# If we want to make the dependency optional
softdepend:
  - GreatCombat

Step 3. Using the API.

Brief explanations of functionality are present above all classes and methods. Below are several examples of working with the plugin's key functionality.

Example 1. Using CombatManager and User

Step 1. Get an instance of CombatManager

private CombatManager combatManager;

@Override
public void onEnable() {
    if (getServer().getPluginManager().isPluginEnabled("GreatCombat")) {
        combatManager = GreatCombat.getInstance().getCombatManager();
    } else {
        Logger.warn("GreatCombat is missing!");
    }
}

public CombatManager getCombatManager() {
    return combatManager;
}

Step 2. Main methods of CombatManager

Check whether the player with the given UUID is in combat mode.
CombatManager#isInCombat(UUID uuid)

Start a fight between 2 players with calling CombatPreStartEvent if both players are not in combat
And an event inheriting CombatDamageEvent
CombatManager#startCombat(Player damager, Player target)

Start combat for a single player without calling events. PreStart checks will not occur.
CombatManager#startSingle(Player player)

Stops combat mode for a user by calling CombatEndEvent
CombatManager#stopCombat(User user)

Attempts to get a user from the list of users with active combat mode
If the user is not found, creates a new user and places them into the list
CombatManager#getOrCreateUser(UUID uuid)

Attempts to get a user from the list, if not found - returns null
CombatManager#getUser(UUID uuid)

Step 3. Main methods of User

Check whether users are opponents
User#containsOpponent(User user)
Add a user to opponents
User#addOpponent(User opponent)
Remove a user from opponents
User#removeOpponent(User opponent)
Restart the user's timer without calling prestart and start events
User#refresh(long start)

Example 2: Implementing your own ServerManager

Step 1. Create a class that implements the ServerManager interface

public class GreatEssentials implements ServerManager {
    private GreatEssentialsAPI essentials;

    @Override
    public void setup() {
        Logger.info("Connecting to GreatEssentials");
        long start = System.currentTimeMillis();
        try {
            essentials = GreatEssentialsAPI.getInstance();
            setupFlyPowerup();
            setupGodPowerup();
            setupGamemodePowerup();
            setupVanishPowerup();
            setupWalkspeedPowerup();
            Logger.info("GreatEssentials connected in " + (System.currentTimeMillis() - start) + " ms.");
        } catch (Exception e) {
            Logger.error("Unable to load GreatEssentials " + e);
        }
    }
    
    // Initialize all powerups

    private Powerup flyPowerup;

    private void setupFlyPowerup() {
        this.flyPowerup = new Powerup() {
            @Override
            public boolean hasPowerup(@NotNull Player player) {
                return player.isFlying();
            }

            @Override
            public void disablePowerup(@NotNull Player player) {
                player.setFlying(false);
                player.setAllowFlight(false);
            }
        };
    }

    @Override
    public Powerup flyPowerup() {
        return this.flyPowerup;
    }
}

Step 2. Initialize our implementation

@Override
public void onEnable() {
    GreatEssentials essentials = new GreatEssentials();
    essentials.setup();
    PowerupsManager.setServerManager(essentials);
    // Set references to Powerup for each PowerupType
    for (PowerupType type : PowerupType.values()) {
        type.initialize(serverManager);
    }
}

Need more examples, have questions? Write in the resource discussions.