RyanMood Docs
  • RyanMood Docs
  • Gamemode Change
    • Installation
    • Configuration Files
    • Commands & Permissions
  • PrivateChats
    • Installation
    • Configuration Files
      • Default Configs
      • chats.yml
      • events.yml
    • Supported Events
    • Commands & Permissions
    • Placeholders
    • API
    • PrivateDiscord
      • Configuration Files
        • Default Configs
      • Setup Discord Channels
Powered by GitBook
On this page

Was this helpful?

  1. PrivateChats

API

PreviousPlaceholdersNextPrivateDiscord

Last updated 1 year ago

Was this helpful?

The PrivateChats API is a work-in-progress.

Setup

1. Download the latest API release from .

2. Add the API jar as a dependency in your projects.

3. Don't package or shade the API into your plugin jar, it must remain seperate. PrivateChats includes the API.

4. Add PrivateChats as a depend or softdepend in your plugin. For example for Bukkit/Spigot plugin.yml: softdepend: [PrivateChats].

5. The API is now ready to be used in your project.

  1. Add the repository to your pom.xml

<repository>
  <id>ryanmood-repo</id>
  <url>https://repo.ryanmood.me/releases</url>
</repository>
  1. Add the dependency to your pom.xml, ensuring that <scope> is always provided.

<dependency>
  <groupId>me.ryanmood</groupId>
  <artifactId>PrivateChatsAPI</artifactId>
  <version>BETA-0.1</version>
  <scope>provided</scope>
</dependency>
  1. Add PrivateChats as a depend or softdepend in your plugin. For example for Bukkit/Spigot plugin.yml: softdepend: [PrivateChats].

  2. The API is now ready to be used.

  1. Add the repository:

repositories {
    mavenCentral()
    maven("https://repo.ryanmood.me/releases/")
}
  1. Add the dependency (compileOnly is required to ensure that the API isn't packaged into your plugin):

dependencies {
    implementation("me.ryanmood", "PrivateChatsAPI", "BETA-0.1", "compileOnly")
}
  1. Add PrivateChats as a depend or softdepend in your plugin. For example for Bukkit/Spigot plugin.yml: softdepend: [PrivateChats].

  2. Ensure that PrivateChat's package is excluded from any shading plugins.

  3. The API is now ready to be used.

the repo
Reposilite - JavaDoc
Java Docs for the API.
https://github.com/RyanMoodGAMING/PrivateChatsAPIgithub.com
GitHub Repository for the API
LogoRyanMood RepositoryRyanMood Repository
The Repo for the API.