Skip to content

Repository files navigation

Kore Assistant

Version

A Visual Studio Code extension providing powerful tools for working with Kore, a Kotlin library for creating Minecraft datapacks without writing JSON.

Features

  • Kore declaration discovery: Detects datapacks, functions, predicates, recipes, advancements, world-generation resources, and the other supported Kore DSL builders in Kotlin files
  • Gutter icons and hovers: Marks declarations in the editor and shows their resource location, generated output path, source location, and relevant Minecraft command
  • Kore Explorer: Browses declarations by datapack and resource kind, or groups them by source file
  • Navigation and copy actions: Reveals the declaration source and copies its resource location, output path, command, or name from the explorer
  • Sorting and grouping: Switch between file and type views, then sort declarations by source file or name
  • Snippets: Code snippets for quickly creating Kore elements with proper imports

Kore Explorer

Browse each datapack and its generated resources directly from the Activity Bar. Resource folders are grouped by their Kore declaration kind, and nested resource paths stay organized in the tree.

Kore Explorer showing a datapack and its resources

Declaration Details

Hover a gutter icon to inspect the declaration's generated resource location and output path without leaving the source file.

Kore declaration hover details

Installation

You can install this extension through the VS Code Marketplace:

  1. Open VS Code
  2. Go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X on macOS)
  3. Search for "Kore Assistant"
  4. Click Install

Alternatively, you can install it directly from the VS Code Marketplace.

About Kore

Kore is a modern Kotlin library that allows you to:

  • Create Minecraft datapacks using Kotlin instead of JSON
  • Write clean, type-safe code with full IDE support
  • Generate commands, recipes, advancements and other datapack components
  • Support for Minecraft 1.20 and later versions

Visit kore.ayfri.com for official documentation.

Requirements

Usage

  1. Open a Kotlin file containing Kore declarations, such as dataPack, function, predicate, or craftingShaped
  2. The extension will automatically detect and highlight them with gutter icons
  3. Use the Kore Explorer in the Activity Bar to browse declarations by datapack and resource kind
  4. Select a declaration to jump to its Kotlin source, or use its context menu to copy its generated value
  5. Configure grouping and sorting with the view toolbar buttons
  6. Use the snippets to quickly create new Kore elements (see snippets section below)

To refresh the icons manually, run the "Kore: Refresh Gutter Icons" command from the command palette.

Snippets

The extension provides the following snippets for Kotlin files:

  • dp - Creates a datapack declaration with automatic import
  • fn - Creates a function declaration with automatic import

Extension Settings

  • Group elements by file or type
  • Sort elements by name or file location

Feedback & Issues

Please file issues and feature requests on the project's repository.

License

This extension is licensed under the GNU General Public License v3.0.

Contributing

Contributions to the Kore Assistant extension are welcome!

  1. Fork the repository
  2. Create your feature branch: git checkout -b feature/amazing-feature
  3. Install dependencies: bun install
  4. Make your changes
  5. Build and test: bun run package
  6. Commit your changes: git commit -m 'Add some amazing feature'
  7. Push to the branch: git push origin feature/amazing-feature
  8. Open a Pull Request

Publishing

The extension is published to the VS Code Marketplace automatically when a new tag is pushed to the repository.

To publish a new version:

  1. Update the version in package.json
  2. Update the CHANGELOG.md file
  3. Update the version badge in README.md
  4. Commit your changes: git commit -m 'Release v0.x.x'
  5. Tag the release: git tag v0.x.x
  6. Push the changes: git push && git push --tags

GitHub Actions will automatically build and publish the extension.

About

A VSCode extension to assist you developing things with Kore.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages