Skip to content

fix(velocity): explicitly add the annotation processor in Maven #709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zlataovce merged 3 commits into from
Jan 19, 2026
+62 −1
Merged

fix(velocity): explicitly add the annotation processor in Maven #709

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9fcb829
fix(velocity): explicitly add the annotation processor in Maven
zlataovce Jan 3, 2026
8801c2b
fix: copy paste error
zlataovce Jan 3, 2026
ec07107
fix: split Maven versions
zlataovce Jan 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 62 additions & 1 deletion src/content/docs/velocity/dev/getting-started/creating-your-first-plugin.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,49 @@ system's documentation ([Gradle](https://docs.gradle.org/current/userguide/userg
}
```
</TabItem>
<TabItem label="Maven">
<TabItem label="Maven 4+">
:::caution

If you're using JDK 23 or later, you must add the annotation processor manually to your `pom.xml`, as described in the example.
See the [Maven documentation](https://maven.apache.org/plugins/maven-compiler-plugin-4.x/examples/annotation-processor.html) for more information.

:::

```xml title="pom.xml" replace
<project>
<repositories>
<repository>
<id>papermc</id>
<url>https://repo.papermc.io/repository/maven-public/</url>
</repository>
</repositories>

<dependencies>
<dependency>
<groupId>com.velocitypowered</groupId>
<artifactId>velocity-api</artifactId>
<version>\{LATEST_VELOCITY_RELEASE}</version>
<scope>provided</scope>
</dependency>
<!-- add the annotation processor -->
<dependency>
<groupId>com.velocitypowered</groupId>
<artifactId>velocity-api</artifactId>
<version>\{LATEST_VELOCITY_RELEASE}</version>
<type>processor</type>
</dependency>
</dependencies>
</project>
```
</TabItem>
<TabItem label="Maven 3">
:::caution

If you're using JDK 23 or later, you must add the annotation processor manually to your `pom.xml`, as described in the example.
See the [Maven documentation](https://maven.apache.org/plugins/maven-compiler-plugin-4.x/examples/annotation-processor.html) for more information.

:::

```xml title="pom.xml" replace
<project>
<repositories>
Expand All @@ -108,6 +150,25 @@ system's documentation ([Gradle](https://docs.gradle.org/current/userguide/userg
<scope>provided</scope>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<!-- add the annotation processor -->
<annotationProcessorPaths>
<path>
<groupId>com.velocitypowered</groupId>
<artifactId>velocity-api</artifactId>
<version>\{LATEST_VELOCITY_RELEASE}</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
</plugins>
</build>
</project>
```
</TabItem>
Expand Down