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.
81 Commits
1 Branch
0 Tags
604 KiB
 
Tree: 5756c29660
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5756c29660'
${ noResults }
Abe Pazos 5756c29660
Update json, xml and csv libraries (#28) 		2 years ago
.github/workflows Add jpackageZip and Github actions for publishing binaries 5 years ago
data Add cheeta image for easy guide example usage 4 years ago
gradle/wrapper Upgrade to Gradle 7.4.1, OPENRNDR 0.4.0-rc.7, ORX 0.4.0-rc.8, Jackson 2.13.2. Add orx-minim 3 years ago
src/main Upgrade to Kotlin 1.6.0, Gradle 7.3 3 years ago
.gitattributes Update gradle to 6.8 (#15) 4 years ago
.gitignore Update .gitignore 3 years ago
README.md Fix broken link in README (#26) 2 years ago
build.gradle.kts Upgrade to Gradle 7.4.1, OPENRNDR 0.4.0-rc.7, ORX 0.4.0-rc.8, Jackson 2.13.2. Add orx-minim 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.kts Update json, xml and csv libraries (#28) 2 years ago

README.md

OPENRNDR template project

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.

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.*.