1. Getting Started

Introduction

This section is the first step in your journey to learn more about the Pixel Framework! For practical reasons, the project is availble as a Maven dependency and can quickly be added to your project with simple steps.

Pre-requisites

• JDK >= 11
• An IDE or text editor of choice (we recommend IntelliJ Idea)

Importing Pixel core dependency

The pixel-core is the base module (required). The artifacts are available on the https://s01.oss.sonatype.org/content/repositories/releases/ Maven repository (examples bellow).

Gradle

repositories {
  maven { url 'https://s01.oss.sonatype.org/content/repositories/releases/' }
}

dependencies {
  implementation 'io.github.joafalves:pixel-core:latest.release'
}

Modify the latest.release tag if you wish to use a specific version of Pixel.

Maven POM

<repository>
  <id>s01.oss.sonatype.org</id>
  <url>https://s01.oss.sonatype.org/content/repositories/releases/</url>
</repository>

<dependency>
  <groupId>io.github.joafalves</groupId>
  <artifactId>pixel-core</artifactId>
  <version>$version</version>
</dependency>

Notice that you might want to import more modules (or extensions) depending on what you want to do. Please check the extensions section for more details.

Learning

At the current time the two main sources of information to learn Pixel are the following:

• Continue reading the Wiki :) The following sections present technical guidelines on utilizing the key features available on the Pixel Framework.
• Take a look our learning code examples.
• Check the demo concepts! There are many details of the framework that are not directly included in the learning sections that are very helpful during the development process (for example the pixel-math module classes and their fancy functions).