openrndr / openrndr-template

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

OPENRNDR

A Kotlin/JVM and Kotlin/JS library for creative coding, real-time and interactive graphics. Can currently be used on Windows, macOS and Linux/x64 to create standalone graphical applications.

Basics and use are further explained in the OPENRNDR guide.

Repository structure

module	description
openrndr-animatable	Tooling for interactive animations
openrndr-application	Application and Program classes
openrndr-binpack	Binpacking algorithm used for texture atlasses
openrndr-color	Color spaces
openrndr-dds	DirectDraw Surface file (.dds) loader
openrndr-demos	A collection of small in-repository demos
openrndr-draw	Drawing primitives
openrndr-event	Event classes
openrndr-extensions	Built-in OPENRNDR extensions
openrndr-filter	Built-in filters
openrndr-js	Kotlin/JS specific modules
openrndr-jvm	Kotlin/JVM specific modules
openrndr-math	Math functions and classes
openrndr-nullgl	Mock graphics back-end
openrndr-shape	Classes and functions for working with 2D shapes
openrndr-svg	Loading and saving SVG
openrndr-utils	Assorted utilities

Using OPENRNDR

You are advised to use the OPENRNDR template which provides a quick start to using the library.

OPENRNDR's Javascript/WebGL is still experimental and under development. However, if you feel like trying it you should use the OPENRNDR JS template.

Building OPENRNDR

After cloning the repository, make sure you have Java 11 or newer installed and run the following command:

./gradlew build

This should start the build process, which will take some time to complete.

Note that OPENRNDR does not depend on anything that is not on Maven Central, builds should be easy and predictable.

Installing OPENRNDR as Maven artifacts

In order to use the OPENRNDR build from your applications one has to install OPENRNDR's Maven artifacts in the local Maven repository.

./gradlew publishToMavenLocal snapshot

A more detailed walk-through of building, publishing to Maven local and contributing can be found in the wiki.

Community

Visit the OPENRNDR website for the latest news on OPENRNDR, showcases and events

Join us on the OPENRNDR forum for questions, tutorials and showcases.

Reach us more directly on the OPENRNDR Slack.

openrndr-template's Issues

Version tags might better be named

Hello! :-)
When I use this template (including the git history) as a starting point for my project,
it means that I have version tags in my history already, which I probably don't want.
A solution that I have also seen in the Java/JVM world, is to name the version tags, like so:
openrndr-template-v0.3.4, instead of just v0.3.4.

As it is now, I can locally delete the tags, but they get re-fetched every time I fetch from the template remote, which I might want to do, to merge in your latest version.

Turn this repo into a Github Template instead of a standard repo

It would be cool if you changed the repo type to a template so you don't have to fork the project, instead you could seed a new repo based on this one. https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-template-repository

"Unable to create primary window" issue

I get this error when I try to run the template :

Caused by: java.lang.IllegalStateException: primary window could not be created.

My procedure was :

• cloning the repository via version control.
• running "run" in the gradle tasks tab.

I tried this :

1. deleting the clone.
2. resetting IntelliJ IDEA to default settings.
3. going through the same steps again.

Build constantly cancelled

Hello RNDR team! I'm back to tinkering with OpenRNDR again after a long gap. Starting a new project from VCS using this git repo, I got this error: Caused by: org.gradle.internal.resolve.ModuleVersionResolveException: Could not resolve org.openrndr.extra:orx-git-archiver-gradle:0.4.1.

I removed orx-git-archiver from the plugins and orxFeatures and the template builds as normal again.

My setup:

• OS: Windows 20
• IntelliJ IDEA 2021.1.3
• JDK 15