Dialogue

Dialogue is a Spigot API that completely revamps the Conversation API. This is not a plugin you put on your server.

Want to know what's currently being worked on? Check out the task board for this project

Installation

Maven

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

<dependency>
    <groupId>com.github.its-c10</groupId>
    <artifactId>dialogue</artifactId>
    <version>Tag</version>
</dependency>

Replace "Tag" with a release tag for Dialogue. You can see the latest version here.

IMPORTANT

If you are using Dialogue in multiple plugins that are being used on the same server, you will need to relocate the shaded Dialogue packages. If you do this correctly, your maven shade plugin should have a configuration that looks like this (<\relocation> block)

<configuration>
    <createDependencyReducedPom>false</createDependencyReducedPom>
    <relocations>
        <relocation>
            <pattern>com.nthbyte.dialogue</pattern>
            <shadedPattern>com.nthbyte.dialogue.insert-unique-phrase-here</shadedPattern>
        </relocation>
    </relocations>
</configuration>

Gradle

repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    implementation 'com.github.its-c10:dialogue:Tag'
}

Replace "Tag" with a release tag for Dialogue. You can see the latest version here.

IMPORTANT

Like in the maven section, you will need to relocate the dialogue packages if you plan to use this API in multiple plugins being used on the server.

Usage

Firstly, you want to hook into the API. Put this line in your main class.

DialogueAPI.hook(this);

All this does is register the dialogue listener and initializes DialogueManager.

From this point on, you can either look at this example plugin that uses this API or refer to the wiki

I strongly encourage you to look at the example plugin. The wiki may not always be up to date, but the example plugin will always be up to date since I use it to test out the changes within this API.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Support

Need help or have questions? Join my discord.