cailean
/
openrndr-template
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
a template for openrndr project
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
61 Commits
1 Branch
0 Tags
604 KiB
 
Tree: df1782f317
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'df1782f317'
${ noResults }
Edwin Jakobs df1782f317
Prepare template for OPENRNDR 0.4 		3 years ago
.github/workflows Add jpackageZip and Github actions for publishing binaries 4 years ago
data Add cheeta image for easy guide example usage 4 years ago
gradle/wrapper Prepare template for OPENRNDR 0.4 3 years ago
src/main Prepare template for OPENRNDR 0.4 3 years ago
.gitattributes Update gradle to 6.8 (#15) 4 years ago
.gitignore Upgrade to OPENRNDR 0.3.40, ORX 0.3.50 5 years ago
README.md Prepare template for OPENRNDR 0.4 3 years ago
build.gradle.kts Prepare template for OPENRNDR 0.4 3 years ago
gradle.properties New gradle/kts based OPENRNDR program template 5 years ago
gradlew Update gradle to 6.8 (#15) 4 years ago
gradlew.bat Update gradle to 6.8 (#15) 4 years ago
settings.gradle New gradle/kts based OPENRNDR program template 5 years ago

README.md

OPENRNDR template project

Attention: you are using a template for OPENRNDR 0.4, which is currently not been released yet. This template assumes that you have build and published OPENRNDR-0.5.1-SNAPSHOT and ORX-0.5.1-SNAPSHOT to your local maven repository.

A feature rich template for creating OPENRNDR programs based on Gradle/Kts

The template consists of a configuration for Gradle and an example OPENRNDR program. The Gradle configuration should serve as the go-to starting point for writing OPENRNDR-based software.

If you are looking at this from IntelliJ IDEA you can start by expanding the project tab on the left. You will find a template program in src/main/kotlin/TemplateProgram.kt

You will find some basic instructions in the OPENRNDR guide

Gradle tasks

  • run runs the TemplateProgram
  • jar creates an executable platform specific jar file with all dependencies
  • zipDistribution creates a zip file containing the application jar and the data folder
  • jpackageZip creates a zip with a stand-alone executable for the current platform (works with Java 14 only)

Cross builds

To create runnable jars for a platform different from the platform you use to build one uses ./gradlew jar --PtargetPlatform=<platform>. The supported platforms are windows, macos, linux-x64 and linux-arm64. Note that the linux-arm64 platform will only work with OPENRNDR snapshot builds from master and OPENRNDR 0.3.39 (a future version).

Github Actions

This repository contains a number of Github Actions in ./github/workflows. The actions enable a basic build run on commit, plus publication actions that are executed when a commit is tagged with a version number like v0.* or v1.*.