Skip to content

A Kotlin-based template project for the FastJ Game Engine.

License

Notifications You must be signed in to change notification settings

fastjengine/fastj-kotlin-template

Repository files navigation

FastJ Kotlin Template Program

Requirements

Initial Setup

Download the Template

You have a few options for getting the 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 image

  2. Download your project from GitHub:

    • via terminal: git clone https://github.com/yourgithubusername/yourprojectname
    • or by downloading the ZIP file, specified under the "↓Code" button. image

Clone the template directly

  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-java-template/releases/latest

Running the Program

  1. Build the program:
    ./gradlew build
  2. Run the template program:
    ./gradlew run

General Usage

Generating Installer/Executable

  1. Build the program:
    ./gradlew build
  2. Create the executable:
    ./gradlew jpackage 
  3. The executable and installer files will be found in build/jpackage.

Having trouble using gradlew? Read this.

Learning FastJ

Check out the following links to learn how to use FastJ:

Configuring the Project Variables

Please view the build.gradle file -- it contains general instructions for modifying the base example.