raeleus / stripe

A collection of Scene2D widgets and utilities for libGDX.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

github readme

A collection of custom Scene2D widgets and utilities for libGDX.

About

Stripe is a companion to Skin Composer, the renowned UI Skin editor and visual layout utility. This library provides new Scene2D widgets, the capability of loading FreeType fonts from JSON, and the Scene Composer Stage Builder. Please see the wiki for documentation.

How to Include Stripe Widgets in your Project

Typical of most libGDX projects, Stripe requires the Gradle setup to be included your project.

Core Dependency

Add the following to your root build.gradle:

allprojects {
    repositories {
	...
	maven { url 'https://jitpack.io' }
    }
}

Add the dependency to your core project:

dependencies {
    ...
    implementation 'com.github.raeleus.stripe:stripe:1.4.5'
}

HTML5 Dependency

Add the dependency to your html project of your root build.gradle if you want HTML5/GWT support:

project(":html") {
    apply plugin: "gwt"
    apply plugin: "war"

    dependencies {
        ...
        implementation 'com.github.raeleus.stripe:stripe:1.4.5:sources'
    }
}

Add the following inherits line to your GdxDefinition.gwt.xml in the html project:
<inherits name="com.ray3k.stripe" />

How to Include PopColorPicker in your Project

PopColorPicker has been moved into a separate project to allow users to use the core Stripe Widgets without forcing them to import the TenPatchDrawable class and TextraTypist.

Core Dependency

Add the following to your root build.gradle:

allprojects {
    repositories {
	...
	maven { url 'https://jitpack.io' }
    }
}

Add the dependency to your core project:

dependencies {
    ...
    implementation 'com.github.raeleus.stripe:colorpicker:1.4.5'
}

HTML5 Dependency

Add the dependency to your html project of your root build.gradle if you want HTML5/GWT support:

project(":html") {
    apply plugin: "gwt"
    apply plugin: "war"

    dependencies {
        ...
        implementation 'com.github.raeleus.stripe:colorpicker:1.4.5:sources'
        implementation "com.github.tommyettinger:textratypist:0.8.0:sources"
        implementation "com.github.tommyettinger:regexodus:0.1.13:sources"
    }
}

Add the following inherits line to your GdxDefinition.gwt.xml in the html project:
<inherits name="com.ray3k.stripe" />

How to Include FreeTypeSkin in your Project

FreeTypeSkin has been moved into a separate project to allow users to use the Stripe Widgets without forcing them to import the GDX FreeType classes.

Core Dependency

Add the following to your root build.gradle:

allprojects {
    repositories {
	...
	maven { url 'https://jitpack.io' }
    }
}

Add the dependency to your core project:

dependencies {
    ...
    implementation 'com.github.raeleus.stripe:freetype:1.4.5'
}

Ensure that you have FreeType implemented in your project. Please refer to the libGDX wiki.

HTML5 Dependency

Add the dependency to your html project of your root build.gradle if you want HTML5/GWT support:

project(":html") {
    apply plugin: "gwt"
    apply plugin: "war"

    dependencies {
        ...
        implementation 'com.github.raeleus.stripe:freetype:1.4.5:sources'
    }
}

Add the following inherits line to your GdxDefinition.gwt.xml in the html project:
<inherits name="com.ray3k.stripe" />

Then follow the instructions to activate gdx-freetype-gwt.

How to use

Stripe meets a variety of needs, so its implementation is dependent on what utilities you plan to use. Please refer to the wiki:

Stripe Widgets
FreeType Skin Loader
Scene Composer Stage Builder

About

A collection of Scene2D widgets and utilities for libGDX.

License:MIT License


Languages

Language:Java 100.0%