update to FastJ 1.7.0-SNAPSHOT-1

- change to jlink plugin, use module-info
- improve jpackage speed by disabling installer generation
- bump gradle version to 7.5.1
- bump slf4j to 2.0.0-alpha7
- improve example game
- format readme
- update license

Author: lucasstarsz

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Andrew Dey
+Copyright (c) 2022 Andrew Dey
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,17 +1,20 @@
 # FastJ Kotlin Template Program
 
 ## Requirements
-- [Java 11 JDK or Higher][jdk-link]
-- Basic understanding of Kotlin
 
+- [Java 18 JDK or Higher][jdk-link]
+- Basic understanding of Java (and Kotlin)
 
 ## Initial Setup
 
 ### Download the Template
+
 You have a few options for getting the template:
 
-#### Create from Template
-1. Click the "Use This Template" button at the top of this project. Leave everything on the project creation screen as is, and hit "Create repository from template".
+#### Create from Template - Recommended for Beginners
+
+1. Click the "Use This Template" button at the top of this project. Leave everything on the project creation screen as
+   is, and hit "Create repository from template".
    ![image](https://user-images.githubusercontent.com/64715411/125542737-6eb23326-d07a-4a28-89af-dcacb4f01cac.png)
    ![image](https://user-images.githubusercontent.com/64715411/125543010-b960404a-ad40-431c-ab31-c097f52574bb.png)
 
@@ -21,13 +24,15 @@ You have a few options for getting the template:
      ![image](https://user-images.githubusercontent.com/64715411/125545310-c62610da-1eb5-4e80-86b3-352b1ea16612.png)
 
 #### Clone the template directly
-1. Clone the repository via terminal: `git clone https://github.com/lucasstarsz/fastj-kotlin-template`
+
+1. Clone the repository via terminal: `git clone https://github.com/lucasstarsz/fastj-java-template`
 
 #### Downloading the latest release
-Download the archive (.zip file, or tar.gz file) from https://github.com/lucasstarsz/fastj-kotlin-template/releases/latest
 
+Download the archive (.zip file, or tar.gz file) from https://github.com/lucasstarsz/fastj-java-template/releases/latest
 
 ### Running the Program
+
 1. Build the program:
     ```bash
     ./gradlew build
@@ -37,10 +42,10 @@ Download the archive (.zip file, or tar.gz file) from https://github.com/lucasst
     ./gradlew run
     ```
 
-
 ## General Usage
 
 ### Generating Installer/Executable
+
 1. Build the program:
     ```bash
     ./gradlew build
@@ -53,18 +58,23 @@ Download the archive (.zip file, or tar.gz file) from https://github.com/lucasst
 
 _Having trouble using `gradlew`? Read [this][Terminals Are Different]._
 
-
 ## Learning FastJ
+
 Check out the following links to learn how to use FastJ:
+
 - [Example Programs][example-programs-readme-link]
 - [FastJ Documentation][documentation-link]
 
-
 ## Configuring the Project Variables
-Please view the [build.gradle](build.gradle.kts) file -- it contains general instructions for modifying the base example.
+
+Please view the [build.gradle](build.gradle.kts) file -- it contains general instructions for modifying the base 
+example.
 
 
-[jdk-link]: https://adoptium.net/?variant=openjdk17 "Java JDK Download"
+[jdk-link]: https://adoptium.net/temurin/releases?version=18 "Java JDK Download"
+
 [Terminals Are Different]: https://gist.github.com/lucasstarsz/9bbc306f8655b916367d557043e498ad "Terminals Access Files Differently"
-[example-programs-readme-link]: http://fastj.me/tree/main/src/example "FastJ Examples"
-[documentation-link]: https://javadoc.io/doc/io.github.lucasstarsz.fastj/fastj-library "FastJ API Documentation"
+
+[example-programs-readme-link]: https://github.com/fastjengine/FastJ/tree/1.7.0-SNAPSHOT-1/examples "FastJ Examples"
+
+[documentation-link]: https://javadoc.io/doc/io.github.lucasstarsz.fastj/fastj-library/1.7.0-SNAPSHOT-1 "FastJ API Documentation"

build.gradle.kts

@@ -6,14 +6,18 @@
 
 plugins {
     /* To begin with, Gradle needs the "kotlin" plugin so that it knows this is a Kotlin project. */
-    kotlin("jvm") version "1.6.21"
+    kotlin("jvm") version "1.7.10"
     /* This template is for an application -- we"ll need this plugin to make sure Gradle knows
      * this, too. */
     application
-    /* To create distributable files for your game, we use this runtime plugin. */
-    id("org.beryx.runtime") version "1.12.7"
+    /* To create distributable files for your game, we use this jlink plugin. */
+    id("org.beryx.jlink") version "2.25.0"
 }
 
+val compileKotlin: org.jetbrains.kotlin.gradle.tasks.KotlinCompile by tasks
+val compileJava: JavaCompile by tasks
+compileJava.destinationDirectory.set(compileKotlin.destinationDirectory.get())
+
 /* Your project's group name goes here.
  * This should be a domain name you own.
  * If you don't own a domain, don"t worry! You can always set this to "io.github.yourgithubusername". */
@@ -31,6 +35,7 @@ description = "A Kotlin Template for FastJ."
 
 /* Here, we specify where the main entrypoint of the project.
  * Feel free to change this as needed. */
+application.mainModule.set("fastj.templategame")
 application.mainClass.set("tech.fastj.template.GameKt")
 
 
@@ -43,9 +48,9 @@ repositories.maven {
 repositories.mavenCentral()
 
 /* The dependency for FastJ, the game engine this template depends on. */
-dependencies.implementation("com.github.fastjengine:FastJ:1.6.0")
+dependencies.implementation("io.github.lucasstarsz.fastj:fastj-library:1.7.0-SNAPSHOT-1")
 /* We'll stick with the simplest logging option for now -- you can change it however you need. */
-dependencies.implementation("org.slf4j:slf4j-simple:2.0.0-alpha5")
+dependencies.implementation("org.slf4j:slf4j-simple:2.0.0-alpha7")
 
 /* To make Kotlin compile and run properly with Gradle, this adds your Kotlin code to the Java
  * source sets. */
@@ -56,7 +61,7 @@ sourceSets.main {
 
 /* The Runtime plugin is used to configure the executables and other distributions for your
  * project. */
-runtime {
+jlink {
 
     options.addAll(
         "--strip-debug",
@@ -66,47 +71,49 @@ runtime {
     )
 
     launcher {
+        name = project.name
         noConsole = true
     }
 
     jpackage {
+
         /* Use this to define the path of the icons for your project. */
         val iconPath = "project-resources/fastj_icon"
         val currentOs = org.gradle.internal.os.OperatingSystem.current()
 
-
         when {
-            currentOs.isWindows -> {
-                installerType = "msi"
-                imageOptions = listOf("--icon", "${iconPath}.ico")
-                installerOptions = listOf(
-                    "--description", project.description as String,
-                    "--vendor", project.group as String,
-                    "--app-version", project.version as String,
-                    "--win-per-user-install",
-                    "--win-dir-chooser",
-                    "--win-shortcut",
-                )
-            }
-            currentOs.isLinux -> {
-                installerType = "deb"
-                imageOptions = listOf("--icon", "${iconPath}.png")
-                installerOptions = listOf(
-                    "--description", project.description as String,
-                    "--vendor", project.group as String,
-                    "--app-version", project.version as String,
-                    "--linux-shortcut",
-                )
-            }
-            currentOs.isMacOsX -> {
-                installerType = "pkg"
-                imageOptions = listOf("--icon", "${iconPath}.icns")
-                installerOptions = listOf(
+            currentOs.isWindows -> imageOptions = listOf("--icon", "${iconPath}.ico")
+            currentOs.isLinux -> imageOptions = listOf("--icon", "${iconPath}.png")
+            currentOs.isMacOsX -> imageOptions = listOf("--icon", "${iconPath}.icns")
+        }
+
+        /* Comment the line below to create an installer for your application */
+        skipInstaller = true
+
+        if (!skipInstaller) {
+            installerOptions.addAll(
+                listOf(
                     "--description", project.description as String,
                     "--vendor", project.group as String,
-                    "--app-version", project.version as String,
-                    "--mac-package-name", project.name
+                    "--app-version", project.version as String
                 )
+            )
+
+            when {
+                currentOs.isWindows -> {
+                    installerType = "msi"
+                    installerOptions.addAll(listOf("--win-per-user-install", "--win-dir-chooser", "--win-shortcut"))
+                }
+
+                currentOs.isLinux -> {
+                    installerType = "deb"
+                    installerOptions.addAll(listOf("--linux-shortcut"))
+                }
+
+                currentOs.isMacOsX -> {
+                    installerType = "pkg"
+                    installerOptions.addAll(listOf("--mac-package-name", project.name))
+                }
             }
         }
     }

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

src/main/java/module-info.java

@@ -0,0 +1,6 @@
+module fastj.templategame {
+    requires kotlin.stdlib;
+    requires fastj.library;
+
+    exports tech.fastj.template;
+}

src/main/kotlin/tech/fastj/template/Game.kt

@@ -16,13 +16,13 @@ class Game : SimpleManager() {
         /* Some crispy anti-aliasing for the road. */
         canvas.modifyRenderSettings(RenderSettings.Antialiasing.Enable)
 
-        /* A very simple Text2D object, welcoming you to FastJ! */
-        val helloFastJText = Text2D.fromText("Hello, FastJ 1.6.0!")
-        helloFastJText.translate(canvas.canvasCenter)
-        drawableManager.addGameObject(helloFastJText)
-    }
+        val helloFastJ: Text2D = Text2D.fromText("Hello, FastJ 1.7.0-SNAPSHOT-1!")
+
+        /* Translate our hello text to the center of the screen */
+        helloFastJ.translation = canvas.canvasCenter.subtract((helloFastJ.width() / 2f), (helloFastJ.height() / 2f))
 
-    override fun update(canvas: FastJCanvas?) {
+        /* Render hello fastj text */
+        drawableManager().addGameObject(helloFastJ)
     }
 }