https://github.com/tommyettinger/libgdx-library-template

A template for libraries that work with libGDX and Gradle 8.x (or 7.x)
https://github.com/tommyettinger/libgdx-library-template

gradle libgdx library template

Last synced: 20 days ago
JSON representation

A template for libraries that work with libGDX and Gradle 8.x (or 7.x)

• Host: GitHub
• URL: https://github.com/tommyettinger/libgdx-library-template
• Owner: tommyettinger
• License: cc0-1.0
• Created: 2021-09-21T23:52:44.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-17T08:00:50.000Z (about 1 month ago)
• Last Synced: 2024-10-19T10:48:05.347Z (29 days ago)
• Topics: gradle, libgdx, library, template
• Homepage:
• Size: 459 KB
• Stars: 13
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-libgdx - libgdx-library-template - A skeleton project for making new libraries, since they need different config. (Resources / Setup and Deployment)

README

        
# Library Template using libGDX and Gradle 8.x

Change this to fit your library!

You'll want to edit gradle.properties to match your library's name, description, author, license, and so on.

You probably also want to edit build.gradle to match the projectName and group to what you want to use.

You should "Find in Files" and search for any places that use the word "template" in order to find anything

you will want to replace. The search should be case-insensitive.

This includes some extra configuration so that you can deploy more easily to [JitPack](https://jitpack.io). If you're

testing a specific commit and don't want to push a release to GitHub or Maven Central just to test (especially

if testing by seeing if a user can build with your library), then JitPack is a great option. It can also be an

excellent way of making GitHub releases available via Maven or Gradle dependencies. The `jitpack.yml` file this

includes defaults to Java 21; you can potentially raise this as high as 23, though that might cause problems

with Kotlin or libraries like Kryo, or as low as 11 (the minimum for the publishing plugin this uses). JDK 21

may warn if you target Java 8, though this is only a warning. It has better generated JavaDocs than earlier

versions, though, so using 21 seems good.

Regardless of which JDK version JitPack uses to build, the default sourceCompatibility, targetCompatibility, and

release are set to JDK 8, which supports many of the most convenient recent Java features, but not all. You can

increase those to a higher version to get features like `var`, records, pattern matching, etc. but that typically

will limit your library to being used by desktop builds (LWJGL 2 or 3, server, or headless). Using the language

level of Java 8 is generally safe, but specific APIs added in Java 8 generally aren't available in RoboVM, GWT,

or some versions of Android. You can go up to compatibility with 11 to get access to `var`, but then you lose

all compatibility with RoboVM.

The test code, which goes in `src/test/java/`, uses compatibility with Java 8 by default, so you can use LWJGL3

in tests out-of-the-box.

This currently uses Gradle 8.x; if you want an earlier version that uses 7.x,

[here you go](https://github.com/tommyettinger/libgdx-library-template/releases/tag/v7.6)!

Gradle 8.x seems to be fine for library code, and since approximately the middle of 2023, the tooling seems

to have finally become capable of handling Gradle 8.x and Android/RoboVM projects. Your Android Gradle Plugin

version should probably be 8.1.4 at this point; it may be able to go up soon as IDEA gets more support.