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.
These can be added to as we agree as a team on our way of working, but these 2 are a fairly universal starting point.
- Never commit directly to
main. Instead, so all work on a separate branch and create a Pull Request. - Do each distinct piece of work on a separate branch. This makes Pull Requests much more useful and manageable, rather than requesting to merge e.g. 5 distinct pieces of work in one go.
- Name your branches
[username]--[work-description], e.g.mikevaux--readme-setup. This way, it's clear who's responsible for which piece of work. (Ifwork-description-2depends onwork-description-1, then by all means branch off ofwork-description-1. It will still be clear because `work-description-1 can be merged first when ready.)
core: Main module with the application logic shared by all platforms.lwjgl3: Primary desktop platform using LWJGL3; was called 'desktop' in older docs.
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.