Odin Support for IntelliJ

This plugin provides support for the Odin programming language in IntelliJ IDEA. You can add the plugin to your JetBrains IDE via the "Plugin" settings panel or by visiting the Odin Plugin Page.

This table summarizes the features supported by the Odin IntelliJ Plugin across various JetBrains IDEs, including debugging, project creation, auto-completion, and free usage options.

* Requires installing the free plugin "Native Debugging Support" (see section Debugger Settings).

** Full auto-completion features added for "Rider" in plugin version >= 0.12.0. Rider >= 2025.2 no longer supports debugging

To begin, ensure you have installed the plugin using the steps mentioned above.

Download the Odin SDK here or build it from source by following the instructions on the official Odin Install page.

Toolchains are configured once at the application level and can be reused across multiple projects. A toolchain contains the Odin compiler, libraries, and optional debugger configuration.

1. Open the IDE settings and navigate to Languages & Frameworks > Odin > Odin Toolchains.
2. Click Add and give the toolchain a descriptive name.
3. Set Odin executable to the odin executable (odin.exe on Windows).
4. Set Odin libraries to the Odin SDK directory that contains the base, core, and vendor collections.
5. Optionally select and configure a debugger.
6. Click Apply to save the toolchain.

Use the "New Project..." wizard in IntelliJ to create a blank Odin project. The default project structure will look like this:

| - bin
| - src
| -- main.odin

If you are importing an existing Odin project, refer to the Advanced Settings section below for additional configuration steps.

After adding a toolchain, assign it to the project:

1. Open the IDE settings and navigate to Languages & Frameworks > Odin > Project Settings.
2. Select the desired Toolchain. You can also click Add... to create one without leaving the project settings.
3. Optionally set Checker arguments. These command-line arguments control the warnings and errors displayed in the editor. Run odin check --help for a list of available options.
4. Click Apply.

Debugger support is available in IntelliJ IDEA Ultimate, GoLand, CLion, PyCharm Professional, and RustRover. If debugger options are not available for your toolchain, install the Native Debugging Support plugin from the JetBrains marketplace.

Debugger installations are managed under Languages & Frameworks > Odin > Debuggers. Reusable toolchains combine one managed Odin SDK with one managed debugger under Languages & Frameworks > Odin > Toolchains. Changing a toolchain applies to every project using it.

The following sections outline the setup for various debuggers.

To set up LLDB-DAP:

1. Download the LLVM 18.1.x binaries for your platform
2. In Debuggers, add LLDB-DAP and choose the lldb-dap executable from the bin directory.
3. Select that debugger in the appropriate Toolchain.

To set up the Windows debugger, click the Download button. Once the download completes, the path to the debugger will be configured automatically.

On Linux and macOS, LLDB works out-of-the-box without additional configuration.

To unlock the full feature set of this plugin, you must configure Source Directories (mandatory) and Collection Directories (optional).

Source directories define the root of your project's source code. These settings are essential for code auto-completion and other IDE features. To mark a directory as a source root:

1. Right-click the directory in the project view.
2. Select Mark Directory as > Odin Sources Root.

This directory should contain your Odin file with the main procedure and your package structure. You can have multiple source roots, but one source root must not be a subdirectory of another.

Odin supports custom collections, which are comparable to library dependencies. To use packages within custom collections, you must mark the directory as a Collection Source Root.

After marking a directory as a Collection Source Root, you can reference the packages it contains using the collection’s name.

In the screenshot above, the collection name is the same as the directory name. However, you can rename the collection via the Rename Refactoring option, and the corresponding references in your code will update automatically.

In the project view, the collection name will appear next to the directory:

If you have previously used ols, you might have an ols.json file containing your LSP settings. You can import a subset of these settings into your IntelliJ project by:

1. Right-clicking the ols.json file.
2. Selecting Import OLS Config.

Example:

After the import, settings like checker arguments (checker_args), checker paths (checker_paths), and collections will be applied to your IntelliJ project.

You can define foldable code regions in Odin source files using line comments:

//region Initialization
// Your code here
//endregion

Everything between //region and //endregion is treated as a single foldable block by the IDE, as long as they don't overlap with other folding regions, such as structs, enums, if-blocks etc. In that case, the latter will take precedence.

The text following //region is used as the region name.

• Region markers must use line comments (//).
• Regions may span any number of lines.
• Nested regions are supported if properly balanced.
• Code regions affect editor folding only and have no impact on compilation or runtime behavior.

Odin is under continuous development. Stay updated with the latest news and features on the Odin Website.

While creating the BNF rules for Odin, inspiration was drawn from the Go programming language.

• Go Language Resources:
  • Grammar-Kit Grammar for Go
  • ANTLR4 Grammar for Go

For more details on using JetBrain's Grammar-Kit to create custom language plugins, refer to the official Grammar-Kit documentation.

This plugin is not an official Odin project. It is neither affiliated with nor endorsed by the Odin team. If you encounter issues with this plugin, please report them using the GitHub issue tracker for this repository, and not to the Odin team directly.