Merge pull request #31 from Jannyboy11/paper-lifecycle-events

Paper lifecycle events setup

Author: Jannyboy11

Dependencies/pom.xml

@@ -12,11 +12,6 @@
 
     <artifactId>Dependencies</artifactId>
 
-    <properties>
-        <minecraft.version>1.21.4</minecraft.version>
-        <paper.version>${minecraft.version}-R0.1-SNAPSHOT</paper.version>
-    </properties>
-
     <repositories>
         <repository>
             <id>papermc</id>
@@ -45,6 +40,7 @@
                 </executions>
             </plugin>
 
+            <!-- Paper dependency copied from: https://github.com/stonar96/RayTraceAntiXray/blob/main/Libs/pom.xml -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-dependency-plugin</artifactId>

JavaExample/src/main/java/xyz/janboerman/scalaloader/example/java/ExamplePlugin.java

@@ -26,14 +26,17 @@
 
 @CustomScala(@Version(value = "2.13.0",
         scalaLibraryUrl = "https://search.maven.org/remotecontent?filepath=org/scala-lang/scala-library/2.13.0/scala-library-2.13.0.jar",
-        scalaReflectUrl = "https://search.maven.org/remotecontent?filepath=org/scala-lang/scala-reflect/2.13.0/scala-reflect-2.13.0.jar"))
+        scalaLibrarySha1 = "e988ea597113786768900f1c260c694a2ae32a42",
+        scalaReflectUrl = "https://search.maven.org/remotecontent?filepath=org/scala-lang/scala-reflect/2.13.0/scala-reflect-2.13.0.jar",
+        scalaReflectSha1 = "2dbe07b0369dbf00a098b7925b2afca016f124b0"
+))
 @Api(ApiVersion.v1_19)
 public class ExamplePlugin extends ScalaPlugin {
 
     private final Random random = new Random();
 
     public ExamplePlugin() {
-        super(new ScalaPluginDescription("JavaExample", "0.18.15-SNAPSHOT").addHardDepend("Scala2Example"));
+        super(new ScalaPluginDescription("JavaExample", "0.18.16-SNAPSHOT").addHardDepend("Scala2Example"));
     }
 
     public static ExamplePlugin getInstance() {

JavaExample/src/main/resources/plugin.yml

@@ -1,6 +1,6 @@
 name: JavaExample                                             #Ignored!
 main: xyz.janboerman.scalaloader.example.java.ExamplePlugin   #Ignored!
-version: 0.18.15-SNAPSHOT                                     #Ignored!
+version: 0.18.16-SNAPSHOT                                     #Ignored!
 api-version: 1.13
 
 commands:

Scala2Example/src/main/scala/xyz/janboerman/scalaloader/example/scala/ExamplePlugin.scala

@@ -17,7 +17,7 @@ object Permissions {
 @Scala(version = ScalaVersion.v2_13_15)
 @Api(ApiVersion.v1_21)
 object ExamplePlugin
-    extends ScalaPlugin(new ScalaPluginDescription("Scala2Example", "0.18.15-SNAPSHOT")
+    extends ScalaPlugin(new ScalaPluginDescription("Scala2Example", "0.18.16-SNAPSHOT")
         .addCommand(new SPCommand("foo").permission(fooPermission))
         .addCommand(new SPCommand("home").permission(homePermission).usage("/home set|tp"))
         .permissions(homePermission)) {

Scala3Example/pom.xml

@@ -37,12 +37,13 @@
             <plugin>
                 <groupId>net.alchim31.maven</groupId>
                 <artifactId>scala-maven-plugin</artifactId>
-                <version>4.7.2</version>
+                <version>4.9.2</version>
                 <configuration>
                     <args>
 <!--                        <arg>-rewrite</arg><arg>-indent</arg>-->
                         <arg>-rewrite</arg><arg>-new-syntax</arg>
                     </args>
+                    <scalaVersion>${scala.version}</scalaVersion>
                 </configuration>
                 <executions>
                     <execution>
@@ -72,8 +73,8 @@
 
     <repositories>
         <repository>
-            <id>spigotmc-repo</id>
-            <url>https://hub.spigotmc.org/nexus/content/groups/public/</url>
+            <id>papermc-repo</id>
+            <url>https://repo.papermc.io/repository/maven-public/</url>
         </repository>
     </repositories>
 
@@ -107,9 +108,19 @@
         </dependency>
 
         <dependency>
-            <groupId>org.spigotmc</groupId>
-            <artifactId>spigot-api</artifactId>
-            <version>1.21.4-R0.1-SNAPSHOT</version>
+            <groupId>io.papermc.paper</groupId>
+            <artifactId>paper-api</artifactId>
+            <version>${paper.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <!-- TODO make it so that we don't need the paper server dependency. -->
+        <!-- TODO this is caused by the fact ScalaPlugin exposes some getters for types which inherit from some classes in the Paper-Server dependency. -->
+        <!-- TODO once we fix our APIs, we also need to add some bytecode migration for compatibility. -->
+        <dependency>
+            <groupId>io.papermc.paper</groupId>
+            <artifactId>paper-server</artifactId>
+            <version>${paper.version}</version>
+            <classifier>mojang-mapped</classifier>
             <scope>provided</scope>
         </dependency>
     </dependencies>

Scala3Example/src/main/resources/paper-plugin.yml

@@ -0,0 +1,24 @@
+name: Scala3Example
+version: ${project.version}
+api-version: "1.21.4"
+folia-supported: true
+load: STARTUP
+
+bootstrapper: xyz.janboerman.scalaloader.example.scala3.ExampleBootstrap
+
+dependencies:
+  bootstrap:
+    ScalaLoader:
+      load: BEFORE
+      required: true
+      join-classpath: true
+  server:
+    ScalaLoader:
+      load: BEFORE
+      required: true
+      join-classpath: true
+
+permissions:
+  scala3.yolo:
+    description: Swag
+    default: true

Scala3Example/src/main/resources/plugin.yml

@@ -0,0 +1,32 @@
+package xyz.janboerman.scalaloader.example.scala3
+
+import com.mojang.brigadier.Command
+import io.papermc.paper.command.brigadier.Commands
+import io.papermc.paper.plugin.bootstrap.BootstrapContext
+import io.papermc.paper.plugin.lifecycle.event.types.LifecycleEvents
+import xyz.janboerman.scalaloader.paper.plugin.ScalaPluginBootstrap
+
+import java.util.Collections
+
+class ExampleBootstrap extends ScalaPluginBootstrap {
+
+    override def bootstrap(context: BootstrapContext): Unit = {
+        super.bootstrap(context)
+
+        // Code adapted from test-plugin in Paper repository.
+
+        val lifecycleEventManager = context.getLifecycleManager
+        lifecycleEventManager.registerEventHandler(LifecycleEvents.COMMANDS, event => {
+            val commands = event.registrar
+
+            commands.register(
+                Commands.literal("bootstraptest")
+                    .executes(commandContext => Command.SINGLE_SUCCESS)
+                    .build(),
+                null,
+                Collections.emptyList()
+            )
+        })
+    }
+
+}

Scala3Example/src/main/scala/xyz/janboerman/scalaloader/example/scala3/ExampleBootstrap.scala

@@ -1,7 +1,7 @@
 package xyz.janboerman.scalaloader.example.scala3
 
 import xyz.janboerman.scalaloader.plugin.description.{Scala, ScalaVersion}
-import xyz.janboerman.scalaloader.plugin.ScalaPlugin
+import xyz.janboerman.scalaloader.paper.plugin.ScalaPlugin
 
 @Scala(version = ScalaVersion.v3_6_2)
 object ExamplePlugin extends ScalaPlugin {

Scala3Example/src/main/scala/xyz/janboerman/scalaloader/example/scala3/ExamplePlugin.scala

@@ -143,6 +143,7 @@ void setEnabled(boolean enabled) {
      * @deprecated This method *WILL NOT EXIST* at runtime when running your plugin on Paper. Use {@link #classLoader()} instead.
      */
     @Deprecated //TODO at the next deprecation clean up spree, make this method protected and final.
+    // TODO consider also using MainClassCallerMigrator in bytecode transformations in ScalaLoader-Bukkit.
     public ScalaPluginClassLoader getClassLoader() {
         return classLoader();
     }
@@ -232,7 +233,7 @@ public final String getDeclaredApiVersion() {
             return yamlDefinedApi.toString();
         }
 
-        return ApiVersion.latest().getVersionString();
+        return ApiVersion.latestVersionString();
     }
 
     /**