feature/java json api

.github/ISSUE_TEMPLATE/change_request.yml

@@ -0,0 +1,33 @@
+name: Change Request
+description: Request a feature or change
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: request
+    attributes:
+      label: Change request
+      description: What are you requesting?
+    validations:
+      required: true
+  - type: textarea
+    id: relevance
+    attributes:
+      label: Relevance
+      description: Is this change relevant to the greater community?
+    validations:
+      required: true
+  - type: textarea
+    id: plugin
+    attributes:
+      label: Could this be a plugin instead?
+      description: Make your case as to whether this needs to be part of Lavalink itself.
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      options:
+      - label: I have checked for duplicate issues
+        required: true
+      - label: I have checked for existing plugins
+        required: true

.github/workflows/build.yml

@@ -3,7 +3,11 @@ name: Build
 on:
   push:
     branches: [ '**' ]
-    paths-ignore: [ '**.md' ]
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+      - '.github/workflows/docs-pr.yml'
   workflow_call:
     secrets:
       DOCKER_USERNAME:
@@ -18,6 +22,14 @@ on:
         required: false
       MAVEN_PASSWORD:
         required: false
+      ORG_GRADLE_PROJECT_mavenCentralPassword:
+        required: false
+      ORG_GRADLE_PROJECT_mavenCentralUsername:
+        required: false
+      ORG_GRADLE_PROJECT_signingInMemoryKey:
+        required: false
+      ORG_GRADLE_PROJECT_signingInMemoryKeyPassword:
+        required: false
 
 jobs:
   build:
@@ -29,6 +41,10 @@ jobs:
       DOCKER_IMAGE: ${{ secrets.DOCKER_IMAGE }}
       MAVEN_USERNAME: ${{ vars.MAVEN_USERNAME }}
       MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
+      ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.ORG_GRADLE_PROJECT_MAVENCENTRALPASSWORD }}
+      ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.ORG_GRADLE_PROJECT_MAVENCENTRALUSERNAME }}
+      ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.ORG_GRADLE_PROJECT_SIGNINGINMEMORYKEY }}
+      ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.ORG_GRADLE_PROJECT_SIGNINGINMEMORYKEYPASSWORD }}
     steps:
       - name: Checkout
         uses: actions/checkout@v3

.github/workflows/docs-pr.yml

@@ -0,0 +1,49 @@
+name: Docs PR
+
+on:
+  pull_request_target:
+    branches: [ '**' ]
+    paths:
+      - 'docs/**'
+
+concurrency:
+    group: pages
+    cancel-in-progress: true
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      deployments: write
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: "${{ github.event.pull_request.merge_commit_sha }}"
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install -r requirements.txt
+        working-directory: docs
+#      - run: mkdocs build --verbose --strict
+      - run: mkdocs build --verbose
+        working-directory: docs
+      - uses: actions/upload-pages-artifact@v1
+        with:
+          path: 'site'
+      - uses: cloudflare/pages-action@v1
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          projectName: ${{ vars.CLOUDFLARE_PROJECT_NAME }}
+          directory: site
+          branch: pr-${{ github.event.pull_request.number }}
+          gitHubToken: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/docs.yml

@@ -0,0 +1,49 @@
+name: Docs Push
+
+on:
+  push:
+    branches: [ '**' ]
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+
+concurrency:
+    group: pages-${{ github.ref }}
+    cancel-in-progress: true
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      deployments: write
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install -r requirements.txt
+        working-directory: docs
+#      - run: mkdocs build --verbose --strict
+      - run: mkdocs build --verbose
+        working-directory: docs
+      - uses: actions/upload-pages-artifact@v1
+        with:
+          path: 'site'
+      - uses: cloudflare/pages-action@v1
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          projectName: ${{ vars.CLOUDFLARE_PROJECT_NAME }}
+          directory: site
+          gitHubToken: ${{ secrets.GITHUB_TOKEN }}
+          wranglerVersion: '3'

.github/workflows/release.yml

@@ -14,6 +14,10 @@ jobs:
       DOCKER_IMAGE: ${{ secrets.DOCKER_IMAGE }}
       MAVEN_USERNAME: ${{ vars.MAVEN_USERNAME }}
       MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }}
+      ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.ORG_GRADLE_PROJECT_MAVENCENTRALPASSWORD }}
+      ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.ORG_GRADLE_PROJECT_MAVENCENTRALUSERNAME }}
+      ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.ORG_GRADLE_PROJECT_SIGNINGINMEMORYKEY }}
+      ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.ORG_GRADLE_PROJECT_SIGNINGINMEMORYKEYPASSWORD }}
 
   release:
     needs: build

.gitignore

@@ -20,3 +20,5 @@ build/*
 gradle.properties
 application.yml
 LavalinkServer/plugins
+.cache/
+site/

CHANGELOG.md

@@ -3,6 +3,52 @@
 Each release usually includes various fixes and improvements.
 The most noteworthy of these, as well as any features and breaking changes, are listed here.
 
+## 4.0.0
+* Lavalink now requires Java 17 or higher to run
+* **Removal of all websocket messages sent by the client. Everything is now done via [REST](../api/rest.md)**
+* Remove default 4GB max heap allocation from docker image
+* Removal of all `/v3` endpoints except `/version`. All other endpoints are now under `/v4`
+* Reworked track loading result. For more info see [here](https://lavalink.dev/api/rest.md#track-loading-result)
+* Update docker ubuntu base image from focal(`20`) to jammy(`22`)
+* Update to Koe [`2.0.0-rc2`](https://github.com/KyokoBot/koe/releases/tag/2.0.0-rc2)
+* Update Lavaplayer to [`2.0.4`](https://github.com/lavalink-devs/lavaplayer/releases/tag/2.0.4), which includes native support for artwork urls and ISRCs in the track info
+* Update to the [Protocol Module](https://github.com/lavalink-devs/Lavalink/tree/master/protocol) to support Kotlin/JS
+* Allow setting user data on tracks in the REST API. For more info see [here](https://lavalink.dev/api/rest.html#update-player-track)
+* Added default plugin repository. Plugin devs can now request their plugin to be added to the default repository. For more info see [here](https://lavalink.dev/api/plugins.md#distributing-your-plugin)
+* Addition of full `Track` objects in following events: `TrackStartEvent`, `TrackEndEvent`, `TrackExceptionEvent`, `TrackStuckEvent`
+* Resuming a session now requires the `Session-Id` header instead of `Resume-Key` header
+* Add JDA-NAS support for musl (`x86-64`, `aarch64`) based systems (most notably `alpine`)
+* Add `Omissible#isPresent` & `Omissible#isOmitted` to the `protocol` module
+* New config option to specify the directory to load plugins from. `lavalink.pluginsDir` (defaults to `./plugins`)
+* Enable request logging by default
+* Fixed error when seeking and player is not playing anything in
+* Fixed null pointer when a playlist has no selected track
+
+> [!WARNING]
+> Lavalink previously set the `-Xmx` flag to `4G` in docker. This caused issues with some systems which had less than 4GB of RAM. We have now removed this flag and let the JVM decide the max heap allocation. The default is 1GB or 25% of total memory, whichever is lower.
+> On how to increase the max heap allocation, see [here](https://lavalink.dev/configuration/docker.html#docker).
+
+<details>
+<summary>v4.0.0 - Betas</summary>
+
+## 4.0.0-beta.5
+* Update lavaplayer to [`2.0.3`](https://github.com/lavalink-devs/lavaplayer/releases/tag/2.0.2) - Fixed YouTube access token errors
+* Added default plugin repository. Plugin devs can now request their plugin to be added to the default repository. For more info see [here](https://github.com/lavalink-devs/Lavalink/blob/master/PLUGINS.md#distributing-your-plugin)
+* Fixed error when seeking and player is not playing anything in 
+
+## 4.0.0-beta.4
+* Update lavaplayer to [`2.0.2`](https://github.com/lavalink-devs/lavaplayer/releases/tag/2.0.2) - Support MPEG 2.5 and fixed some requests not timing out
+* Add `Omissible#isPresent` & `Omissible#isOmitted` to the `protocol` module
+* Fix null pointer when a playlist has no selected track
+
+## 4.0.0-beta.3
+* Update lavaplayer to [`2.0.0`](https://github.com/lavalink-devs/lavaplayer/releases/tag/2.0.0) - Fixed YouTube 403 errors & YouTube access token errors
+
+## 4.0.0-beta.2
+* Update lavaplayer to [`08cfbc0`](https://github.com/Walkyst/lavaplayer-fork/commit/08cfbc05953128f3cf727ea3bcbe41dabcd1c7db) -  Fixed ogg streaming
+* Add JDA-NAS support for musl (`x86-64`, `aarch64`) based systems (most notably `alpine`)
+* New config option to specify the directory to load plugins from. `lavalink.pluginsDir` (defaults to `./plugins`)
+
 ## 4.0.0-beta.1
 * New Lavalink now requires Java 17 or higher to run
 * **Removal of all websocket messages sent by the client. Everything is now done via [REST](IMPLEMENTATION.md#rest-api)**
@@ -21,6 +67,23 @@ The most noteworthy of these, as well as any features and breaking changes, are
 Contributors:
 [@topi314](https://github.com/topi314), [@freyacodes](https://github.com/freyacodes), [@DRSchlaubi](https://github.com/DRSchlaubi) and [@melike2d](https://github.com/melike2d)
 
+</details>
+
+## v3.7.10
+* Update lavaplayer to [`1.5.2`](https://github.com/lavalink-devs/lavaplayer/releases/tag/1.5.2) - Fixed NPE on missing author in playlist tracks in YouTube
+
+## 3.7.9
+* Update lavaplayer to [`1.5.1`](https://github.com/lavalink-devs/lavaplayer/releases/tag/1.5.1) - Fixed YouTube access token errors
+* Fixed websocket crash when seeking and nothing is playing
+* Fixed error when seeking and player is not playing anything
+
+## 3.7.8
+* Fix YouTube 403 errors
+* Fix YouTube access token errors
+
+## 3.7.7
+* Add JDA-NAS support for musl (`x86-64`, `aarch64`) based systems (most notably `alpine`)
+
 ## 3.7.6
 * Update Lavaplayer to [`1.4.1`](https://github.com/Walkyst/lavaplayer-fork/releases/tag/1.4.1) & [`1.4.2`](https://github.com/Walkyst/lavaplayer-fork/releases/tag/1.4.2)
 * New support for `MUSL` based systems (most notably `alpine`)

LavalinkServer/application.yml.example

@@ -1,15 +1,20 @@
 server: # REST and WS server
   port: 2333
   address: 0.0.0.0
+  http2:
+    enabled: false # Whether to enable HTTP/2 support
 plugins:
 #  name: # Name of the plugin
 #    some_key: some_value # Some key-value pair for the plugin
 #    another_key: another_value
 lavalink:
   plugins:
-#    - dependency: "group:artifact:version"
-#      repository: "repository"
-  pluginsDir: "./plugins"
+#    - dependency: "com.github.example:example-plugin:1.0.0" # required, the coordinates of your plugin
+#      repository: "https://maven.example.com/releases" # optional, defaults to the Lavalink releases repository by default
+#      snapshot: false # optional, defaults to false, used to tell Lavalink to use the snapshot repository instead of the release repository
+#  pluginsDir: "./plugins" # optional, defaults to "./plugins"
+#  defaultPluginRepository: "https://maven.lavalink.dev/releases" # optional, defaults to the Lavalink release repository
+#  defaultPluginSnapshotRepository: "https://maven.lavalink.dev/snapshots" # optional, defaults to the Lavalink snapshot repository
   server:
     password: "youshallnotpass"
     sources: