An open API service indexing awesome lists of open source software.

https://github.com/badasintended/ravel

IntelliJ IDEA plugin for remapping sources
https://github.com/badasintended/ravel

fabricmc idea-plugin java kotlin mappings minecraft mixin

Last synced: 2 months ago
JSON representation

IntelliJ IDEA plugin for remapping sources

Awesome Lists containing this project

README

          

# Ravel Remapper Ravel Logo

[![Version](https://img.shields.io/jetbrains/plugin/v/28938-ravel-remapper.svg)](https://plugins.jetbrains.com/plugin/28938-ravel-remapper)
[![Downloads](https://img.shields.io/jetbrains/plugin/d/28938-ravel-remapper.svg)](https://plugins.jetbrains.com/plugin/28938-ravel-remapper)

[![GitHub Release](https://img.shields.io/github/v/release/badasintended/ravel?label=github%20release)](https://github.com/badasintended/ravel/releases)
[![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/badasintended/ravel/total)](https://github.com/badasintended/ravel/releases)

> **ravel** _[rav-uhl]_ verb
> _raveled, raveling, ravelled, ravelling_
> to disentangle or unravel the threads or fibers of (a woven or knitted fabric, rope, etc.).

Ravel is a plugin for IntelliJ IDEA to remap source files, based on
[PSI](https://plugins.jetbrains.com/docs/intellij/psi.html) and [Mapping-IO](https://github.com/FabricMC/mapping-io).

Install it from [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/28938-ravel-remapper)
or download it manually from [GitHub Release](https://github.com/badasintended/ravel/releases).

Supports remapping:

- [x] Java
- [x] Kotlin
- [x] [Mixin](https://github.com/FabricMC/Mixin) and [MixinExtras](https://github.com/LlamaLad7/MixinExtras)1
- [x] [Class Tweaker / Access Widener](https://github.com/FabricMC/fabric-tooling/tree/main/class-tweaker)

1MixinExtras [Expression](https://github.com/LlamaLad7/MixinExtras/wiki/Expressions) is not supported.

## Usage

### See the page at [Fabric Docs](https://docs.fabricmc.net/develop/migrating-mappings/ravel) for remapping Fabric Mods!

1. **Commit any changes before attempting to remap your sources!**

2. Right-click the code editor and go to **Refactor** - **Remap Using Ravel**
Right Click Action
You can also find it inside the **Refactor** menu at the top menu

3. Select the mappings to use and modules to remap
Remapper Dialog
Here, I want to remap Fabric API from Yarn to Mojang Mappings, as there is no direct
Yarn-to-Mojang mappings, I need to put both Yarn-merged TinyV2 mapping and Mojang ProGuard TXT
mapping as the input.
Select the source and destination namespace as you see fit.

4. Click OK and wait for the remapping to be done

5. Search for `TODO(Ravel)` for remapping errors and fix them manually
Search TODO