mmmika/libgdxplugin

An IntelliJ plugin for use with LibGDX

LibGDXPlugin

This unofficial plugin adds a number of LibGDX related tools and features to IntelliJ and Android Studio. You can install the plugin from the Jetbrains Plugin Repository.

For running and building the plugin from source, see FromSource.

This plugin needs a recent version of the official Kotlin plugin to be installed (even if you only use Java), so install and/or enable that plugin first.

Features

Inspections

LibGDXPlugin adds several inspections, which look for possible issues in a project. Code inspections support both Java and Kotlin. To disable or enable inspections go to Settings -> Editor -> Inspections -> LibGDX. The following inspections are included:

• Use of profiling code, like FPSLogger or GLProfiler
• Setting an overly verbose log level
• Causing flushing of a batch or renderer from inside a loop
• Missing flush() after changing Preferences
• Use of some commonly known test ids or dummy ids (ex. AdMob and MoPub)
• Use of ShapeRenderer with a release of LibGDX older than 1.9.2 (It crashes on 64bit devices. See Issue 3790) [1]
• Use of static resources (more info on the use of statics: here and here)
• Use of non-reentrant iterator methods of LibGDX collection classes
• Missing OpenGL declaration in AndroidManifest.xml [1]
• Missing WRITE_EXTERNAL_STORAGE permission in AndroidManifest.xml when using external files
• Using outdated versions of LibGDX and related libraries [1] [2]
• Declaring a combination of minSdkVersion, maxSdkVersion, targetSdkVersion and <support-screens> which excludes the App from being listed as "Designed for Tablets" in the Google Play Store [1]

[1]: These inspections assume the project uses a fairly standard setup, like those created by gdx-setup and gdx-setup.

[2]: Currently: Ashley, Autumn, Autumn MVC, Box2d, Box2dLights, Gdx AI, GDX Bullet, GDX Controllers, GDX FreeType, gdx-dialogs, gdx-facebook, gdx-lml, gdx-lml-vis, Gdx-Pay, Kiwi, KTX actors, KTX app, KTX assets, KTX collections, KTX i18n, KTX inject, KTX log, KTX math, KTX scene2d, KTX style, KTX vis, KTX vis-style, LibGDX, libgdx-utils, libgdx-utils-box2d, Overlap2D, Vis Runtime, VisUI, Web Sockets, Web Sockets Serialization

Color previews

When using a LibGDX color in Java or Kotlin code (e.g. Color.BLUE or Color.valueOf("#0000ff")) a preview of the the color is shown in the left gutter.

To disable color previews, go to Settings -> Editor -> LibGDXPlugin.

Color previews are also shown in the Debug Tool Window.

Skin JSON support

Files with the extension .skin are treated as Skin JSON files. For files with the extension .json which look like Skin files, you are asked whether they should be treated as Skin files (can be turned of in the settings). You can also mark and unmark files as Skin files using the context menu of a file.

Skin file support includes:

• Syntax highlighting (can be configured using Settings -> Editor -> Colors & Fonts -> LibGDX Skin)
• Color previews in the left gutter. Click on a color preview to open a color selector dialog
• Structure View
• Code completion for class names, property names, property values and, if an .atlas file with the same name as the Skin and in the same directory exists, drawable/texture names
• Folding
• Formatting/Code Style (Code Style can be configured using Settings -> Editor -> Code Style -> LibGDX Skin)
• Warnings when using classes which don't exist, using properties which don't correspond to a field in a given class or using malformed color strings
• Find usages of a defined resources within the Skin file [1]
• Crtl-B (⌘+B): Jump from the usage of a resource to it's definition [1]
• Crtl-B (⌘+B) with the caret on a class name jumps to the source of the class and Ctrl-B with the caret on a property name jumps to the corresponding field
• Crtl-B (⌘+B) on a bitmap font name jumps to the corresponding bitmap font file
• Renaming a resource with Shift-F6 also renames it's usages in the Skin files [2]
• (Un)commenting blocks of code with Ctrl-/
• Smart Enter
• With Shift pressed, hover over a Drawable/Texture name to view a preview of the Drawable

[2]: Usages of the resource in Java/Kotlin code are not automatically renamed, expect when using the @GDXAssets annotation (See below)

Atlas file support

Files with a .atlas or .pack extension are treated as Texture Atlas packfiles.

Atlas file support includes:

• Highlighting
• Structure View
• Folding
• With Shift pressed, hover over a Region to view a preview of the image

Bitmap Font file (.fnt) support

Files with a .fnt extension are treated as Bitmap Font Files, with:

• Highlighting
• Structure View
• Folding

Skin resources and Atlas region names in Java and Kotlin code

To get Code Completion (and Go To Definition, Find Usages, Rename Refactoring and image previews [1]) for Skin resource names and region names from Atlas files in Skin.get*() and TextureAtlas.get*() and related methods, use the @GDXAssets annotation to tell LibGDXPlugin which files to use.

First add the annotation to your build. In build.gradle:

repositories {
    // ...
    jcenter()
}

dependencies {
    // ...
    compile 'com.gmail.blueboxware:libgdxpluginannotations:1.0'
}

Then annotate Skin and TextureAtlas fields and properties where appropriate. Specify file names relative to the Project Root!

Java example:

        @GDXAssets(skinFiles = {"android/assets/ui.skin"})
        // or Windows style: @GDXAssets(skinFiles = {"android\\assets\\ui.skin"})
        Skin uiSkin = new Skin(Gdx.files.internal("ui.skin"));

        @GDXAssets(
                skinFiles = {"assets/default.skin", "assets/main.skin"},
                atlasFiles = {"assets/images.atlas"}
        )
        Skin skin = new Skin();
        skin.load(DEFAULT_SKIN);
        skin.load(MAIN_SKIN);
        skin.addRegions(ATLAS);

        @GDXAssets(atlasFiles = {"assets/images/images.pack"})
        TextureAtlas atlas = new TextureAtlas(Gdx.files.internal("images/images.pack"));

Kotlin example:

    @GDXAssets(skinFiles = arrayOf("android/assets/ui.skin"))
    // or Windows style: @GDXAssets(skinFiles = arrayOf("android\\assets\\ui.skin"))
    val uiSkin = Skin(Gdx.files.internal("ui.skin"))

    @GDXAssets(
            skinFiles = arrayOf("assets/default.skin", "assets/main.skin"),
            atlasFiles = arrayOf("assets/textures.atlas")
    )
    val skin = Skin()
    skin.load(DEFAULT_SKIN)
    skin.load(MAIN_SKIN)
    skin.addRegions(ATLAS)

    @GDXAssets(atlasFiles = arrayOf("assets/images/images.pack"))
    val atlas: TextureAtlas = TextureAtlas(Gdx.files.internal("images/images.pack"))

NOTES

• Specify file names relative to the Project Root!
• Multiple files can be specified for both the skinFiles and atlasFiles parameters
• When no atlasFiles are specified and a file with the same name as the specified Skin file and the ".atlas" extension exist, that file is used as Atlas files (just like the Skin class itself does). This also works if you specify multiple Skin files.
• Go To Definition and Find Usages are only available if the specified files are registered as Skin or Atlas file, not when they are registered as JSON or Text files.

[1]: With Shift pressed, hover over a Drawable name to get a preview.