Skip to content

Latest commit

 

History

History
63 lines (48 loc) · 1.82 KB

README.md

File metadata and controls

63 lines (48 loc) · 1.82 KB
Raw

Template

Template Application for the Artifact Game Engine.

Setup

Requirements:

Java (JVM & JDK (Version 17+))
Kotlin
IntelliJ (Or any other IDE that supports kotlin & java)
Artifact Engine

The folder structure should look like this:

<root folder> (e.g. IdeaProjects)
 - Artifact
  - src
  - gradle
 - <ProjectName>
  - src
  - gradle

The first thing you should do is rename your project. This is done by going to settings.gradle.kts and then setting rootProject.name to your project name. You may also need to rename the IntelliJ module. To do this go to File -> Project Structure -> Project. There will be a text box called "Name".

Start

Running the project requires creating a run configuration like this:

runConfiguration in intellij

Make sure that "Use classpath of module" is set to <Project Name>.main and the Configuration is of type 'Kotlin' not 'Application'.

To get debug logs, add the following line to your VM options:

-Dorg.slf4j.simpleLogger.defaultLogLevel=debug

Export

To export your project, you just need to execute the export gradle task:

./gradlew export

Note

You may want to use ArtifactDebug for easier development.

Using ArtifactDebug

To use ArtifactDebug you need to download it and place the downloaded directory in the same parent directory as your project (e.g. IdeaProjects).

Then add this line to your settings.gradle.kts:

includeFlat("ArtifactDebug")

Then, add the following to your build.gradle.kts:

implementation(project(":ArtifactDebug"))

License

GPLv3