Git Product home page Git Product logo

lavalink-plugin-template's Introduction

lavalink-plugin-template

This is a template for creating a plugin for Lavalink. It is written in java, but you can also use kotlin (version 1.8.22) if you want.

How to use this template

  1. Clone this repository
  2. Rename the package com.example.plugin to your package name
  3. Rename the class ExamplePlugin to your plugin name
  4. Rename the file ExamplePlugin.java to your plugin name
  5. fill in the lavalinkPlugin in build.gradle.kts
  6. Write your plugin

How to test your plugin

  1. Place a application.yml file in the root directory (see here for an example)
  2. Run ./gradlew runLavalink (for windows: ./gradlew.bat runLavalink) in the root directory
  3. The plugin will be loaded
  4. You can now test your plugin
  5. If you change something in the plugin, you can just run ./gradlew runLavalink again

How to build your plugin

  1. Run ./gradlew build (for windows: ./gradlew.bat build) in the root directory
  2. The jar file will be in build/libs/

How to publish your plugin

This template uses jitpack to publish the plugin. You just need to push your changes to github and jitpack will build the plugin for you.

How to use your plugin

Go to jitpack and paste the link to your repository. There you can find the version you want to use.

lavalink:
  plugins:
    - dependency: com.github.lavalink:lavalink-plugin-template:{VERSION} # replace {VERSION} with the version you want to use from jitpack
      repository: https://jitpack.io

How to get help

If you need help, you can join the Lavalink Discord Server and ask in the #plugin-dev channel.

lavalink-plugin-template's People

Contributors

devoxin avatar drschlaubi avatar freyacodes avatar topi314 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.