Skip to content

IntegerLimit/GroovyScriptPlugin

Repository files navigation

GroovyScript

Build Version Downloads

This IntelliJ-based Plugin provides auto-completion, signature hints, inlay support and some live templates for the Minecraft 1.12 Mod GroovyScript. This is similar to the corresponding VS Code Plugin, found on the marketplace.

You must enable the GroovyScript Language Server in your instance. See the GroovyScript Docs for how to do this.

This plugin utilizes the Language Server Protocol to provide this support, through the LSP4IJ plugin.

LSP4IJ is a hard dependency of this Plugin. IntelliJ's own support has not been used due to limited feature sets and support being restricted to Ultimate versions.

Using the Plugin

  1. Install the Plugin
  2. Open a .groovy file. You should see a small GS status icon on the bottom left of your screen.
  3. You can use the status icon to control the status of the language server, as well as to access the main settings page.
  4. If using GrS versions pre-1.2.0: In the main settings page, you can enable the Disable texture inlays? (for GroovyScript versions pre 1.2.0) checkbox.

This plugin is still in development. Future planned features are in the roadmap.

Installation

  • Using the IDE built-in plugin system:

    Settings/Preferences > Plugins > Marketplace > Search for "GroovyScriptPlugin" > Install

  • Using JetBrains Marketplace:

    Go to JetBrains Marketplace and install it by clicking the Install to ... button in case your IDE is running.

    You can also download the latest release from JetBrains Marketplace and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

  • Manually:

    Download the latest release or the latest nightly build and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...


Plugin based on the IntelliJ Platform Plugin Template.

Roadmap

Textures

  • Texture display
  • Texture tooltips
  • Texture settings: Improve preview

Other

  • Allow localization
  • Improve handling of server status, especially after failure to connect or instance being closed
  • Fix completion removing quotes before
  • Fix completion not working with object mappers on normal input (maybe see if IntelliJ's Typescript support can help as a base, it provides completion for object keys)
  • Improve completion sorting
  • Add (more) shortcut snippets (crafting shapeless, etc.)
  • Fix bad error highlighting
  • Inspections (e.g. favoring item('rl', meta) over item('rl:meta') or formatting from item to metaitem)
    • Add to GrS's LSP?
  • Look at sources, check for groovyblacklist annotation
  • Preview of texture inlay hint in inlay hint settings

About

A IntelliJ IDEA Plugin to support the Minecraft 1.12 Mod GroovyScript

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages