A template for getting started with libgdx, with errorprone, spotbugs and checkstyle included
- Java 95%
- Nix 4.2%
- Just 0.8%
| assets | ||
| config/checkstyle | ||
| core | ||
| gradle | ||
| lwjgl3 | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| build.gradle | ||
| devenv.lock | ||
| devenv.nix | ||
| devenv.yaml | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| Justfile | ||
| README.md | ||
| settings.gradle | ||
Template
A libGDX project generated with gdx-liftoff.
This project was generated with a template including simple application launchers and an ApplicationAdapter extension that draws libGDX logo.
Platforms
core: Main module with the application logic shared by all platforms.lwjgl3: Primary desktop platform using LWJGL3; was called 'desktop' in older docs.
Gradle
This project uses Gradle to manage dependencies.
The Gradle wrapper was included, so you can run Gradle tasks using gradlew.bat or ./gradlew commands.
Useful Gradle tasks and flags:
--continue: when using this flag, errors will not stop the tasks from running.--daemon: thanks to this flag, Gradle daemon will be used to run chosen tasks.--offline: when using this flag, cached dependency archives will be used.--refresh-dependencies: this flag forces validation of all dependencies. Useful for snapshot versions.build: builds sources and archives of every project.cleanEclipse: removes Eclipse project data.cleanIdea: removes IntelliJ project data.clean: removesbuildfolders, which store compiled classes and built archives.eclipse: generates Eclipse project data.idea: generates IntelliJ project data.lwjgl3:jar: builds application's runnable jar, which can be found atlwjgl3/build/libs.lwjgl3:run: starts the application.test: runs unit tests (if any).
Note that most tasks that are not specific to a single project can be run with name: prefix, where the name should be replaced with the ID of a specific project.
For example, core:clean removes build folder only from the core project.
Devenv & Just
Run
devenv shell
to jump into a shell with all dependencies configured.
Run
just run
just format
just lint
to run, format or lint the project.