initial commit

Author: lucasstarsz

.gitignore

@@ -0,0 +1,49 @@
+# Ignore Gradle project-specific cache directory
+.gradle/
+
+# Ignore build output directories
+build/
+out/
+
+# Ignore metadata
+meta/
+
+# Ignore sandbox testing grounds
+sandbox/
+
+# Ignore project files
+.idea/
+
+# Ignore important information
+gradle.properties
+
+# The next part was created by: https://www.toptal.com/developers/gitignore/api/java
+
+### Java ###
+# Compiled class file
+*.class
+
+# Log files
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files
+*.jar
+# except gradle-wrapper
+!gradle-wrapper.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+

README.md

@@ -0,0 +1,41 @@
+# FastJ Java Template Program
+
+## How to Access
+
+- Clone the repository `git clone https://github.com/lucasstarsz/fastj-java-template`
+- Or download from https://github.com/lucasstarsz/fastj-java-template/releases/latest
+
+
+## Running the Program
+
+1. Build the program:
+    ```bash
+    ./gradlew build
+    ```
+2. Run the template program:
+    ```bash
+    ./gradlew run
+    ```
+
+
+## Distributing as Executable
+
+1. Build the program:
+    ```bash
+    ./gradlew build
+    ```
+2. Create the executable:
+    ```bash
+   ./gradlew jpackage 
+   ```
+
+_Having trouble using `gradlew`? Read [this][Terminals Are Different]._
+
+
+## Configuring the Project Variables
+
+Please view the [build.gradle](build.gradle) file -- it contains general instructions for modifying the base example.
+
+
+[Terminals Are Different]: https://gist.github.com/lucasstarsz/9bbc306f8655b916367d557043e498ad "Terminals Access Files Differently"
+

build.gradle

@@ -0,0 +1,93 @@
+/*
+ * FastJ Java Template Build Script
+ *
+ * Thank you for choosing FastJ! This is a Gradle-based build script that will help you manage your
+ * project with ease. */
+
+plugins {
+    /* To begin with, Gradle needs the 'java' plugin so that it knows this is a Java project. */
+    id 'java'
+    /* This template is for an application -- we'll need this plugin to make sure Gradle knows
+     * this, too. */
+    id 'application'
+    /* To create distributable files for your game, we use this jlink plugin. */
+    id 'org.beryx.jlink' version '2.24.0'
+}
+
+/* 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'. */
+group('io.github.yourgithubusername')
+
+/* Your project's version.
+ * When you want to distribute a new version of your project, always make sure to update the
+ * project version. */
+version('0.0.1')
+
+/* Your project's description.
+ * Give a one or two sentence description of your project -- if you publish it somewhere, you'll be
+ * able to use it. */
+description('A Java Template for FastJ.')
+
+/* Here, we specify where the main entrypoint of the project.
+ * Feel free to change these as needed. */
+application.getMainClass().set('tech.fastj.template.Game')
+application.mainModule.set('fastj.templategame')
+
+
+/* When you add a dependency on another project (like FastJ), you need to add specify where the
+ * dependencies are coming from!
+ * FastJ is hosted on Maven Central, so we'll add it here. */
+repositories.maven {
+    url('https://oss.sonatype.org/content/repositories/snapshots/')
+}
+repositories.mavenCentral()
+
+/* The dependency for FastJ, the game engine this template depends on. */
+dependencies.implementation('io.github.lucasstarsz.fastj:fastj-library:1.5.0-SNAPSHOT')
+
+
+/* JLink is used to configure the executables and other distributions for your project. */
+jlink {
+
+    options.addAll(
+            '--strip-debug',
+            '--compress', '2',
+            '--no-header-files',
+            '--no-man-pages'
+    )
+
+    launcher {
+        name = project.name
+        noConsole = true
+    }
+
+    jpackage {
+
+        /* Use this to define the path of the icons for your project. */
+        def iconPath = 'project-resources/fastj_icon'
+        def currentOs = org.gradle.internal.os.OperatingSystem.current()
+
+        installerOptions += [
+                '--description', project.description,
+                '--vendor', project.group,
+                '--app-version', project.version
+        ]
+
+
+        if (currentOs.windows) {
+            installerType = 'msi'
+            icon = "${iconPath}.ico"
+            installerOptions += ['--win-per-user-install', '--win-dir-chooser', '--win-shortcut']
+        } else if (currentOs.linux) {
+            installerType = 'deb'
+            icon = "${iconPath}.png"
+            installerOptions += ['--linux-shortcut']
+        } else if (currentOs.macOsX) {
+            installerType = 'pkg'
+            icon = "${iconPath}.icns"
+            installerOptions += ['--mac-package-name', project.name]
+        }
+    }
+}
+

gradle/wrapper/gradle-wrapper.jar

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