mojang-spigot-remapper

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #golang #android #machine-learning #rust #java #windows #cli #kubernetes #awesome-list #pytorch #mcp

mojang-spigot-remapper

(★ 31)

No description available.

mojang-spigot-remapper Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Mojang -> Spigot Remapper

---

[![](https://img.shields.io/gradle-plugin-portal/v/io.github.patrick.remapper?style=for-the-badge)](https://plugins.gradle.org/plugin/io.github.patrick.remapper)

### Description

Gradle plugin for remapping mojang-mapped artifact to spigot-mapped

Uses [SpecialSource](https://github.com/md-5/SpecialSource) for remapping.

---

### Note

For those seeking for nms & stable remapper, try using `userdev` from [PaperMC/paperweight](https://github.com/PaperMC/paperweight) project.

I will not (can not) provide any additional help for additional non-spigot features (incl. support for specific spigot fork)

There could be some methods that do not remap properly, so it is required to find some workarounds for those methods.

---

### Applying plugin

#### Kotlin

Using the [plugins DSL](https://docs.gradle.org/current/userguide/plugins.html#sec:plugins_block):

```kotlin
plugins {
    id("io.github.patrick.remapper") version "1.4.3"
}
```

Using [legacy plugin application](https://docs.gradle.org/current/userguide/plugins.html#sec:old_plugin_application):
<details><summary>Click to View</summary>

```kotlin
buildscript {
    repositories {
        maven {
            url = uri("https://plugins.gradle.org/m2/")
        }
    }
    dependencies {
        classpath("io.github.patrick-choe:mojang-spigot-remapper:1.4.3")
    }
}

apply(plugin = "io.github.patrick.remapper")
```
</details>

#### Groovy

Using the [plugins DSL](https://docs.gradle.org/current/userguide/plugins.html#sec:plugins_block):

```groovy
plugins {
    id "io.github.patrick.remapper" version "1.4.3"
}
```

Using [legacy plugin application](https://docs.gradle.org/current/userguide/plugins.html#sec:old_plugin_application):
<details><summary>Click to View</summary>

```groovy
buildscript {
    repositories {
        maven {
            url "https://plugins.gradle.org/m2/"
        }
    }
    dependencies {
        classpath "io.github.patrick-choe:mojang-spigot-remapper:1.4.3"
    }
}

apply plugin: "io.github.patrick.remapper"
```
</details>

---

### How to use

- Prerequisite: Run BuildTools with `--remapped` option.
- Setup by applying the plugin to the project. See above for more details.
    - This will add `remap` task to the project.
- Configure `remap` task. Advanced configuration option is available in the below section.
    - Example:
       ```kotlin
       tasks {
           remap {
               version.set("1.20.5")
           }
       }
       ```
- Run `remap` task to remap mojang-mapped jar artifact to spigot-mapped.

---

### Advanced configuration option

```kotlin
tasks {
    remap {
        // Required
        // Specify minecraft (spigot) version of your project.
        // Specifying snapshot revision is also allowed (e.g. "1.21.11-R0.2-SNAPSHOT")
        // TODO: Auto-detect library version by default
        version.set("1.20.5")

// Use this option to change remapping action.
        // Defaults to `RemapTask.Action.MOJANG_TO_SPIGOT`.
        action.set(RemapTask.Action.MOJANG_TO_SPIGOT)

// If this option is set to true, the entire task would be skipped.
        skip.set(true)

// Use this option to explicitly set the input task.
        // Defaults to `jar` task.
        inputTask.set(jar)

// If this option is used, instead of overwriting an existing artifact,
        // the remap output would be available at file named as `archiveName`.
        // Note that `archiveName` has higher priority over `archiveClassifier`. 
        archiveName.set("${project.name}-${project.version}-remapped.jar")

// If this option is used, instead of overwriting an existing artifact,
        // the remap output would be available at "${archiveBaseName}-${archiveVersion}-${archiveClassifier}.jar"
        // Note that `archiveName` has higher priority over `archiveClassifier`. 
        archiveClassifier.set("remapped")

// Use this option to set output directory of remapped archive file.
        // Defaults to output directory of input task.
        archiveDirectory.set(File(projectDir, "output"))
    }
}
```

---

### Additional information

All contributions are welcome!

If you encounter any problems, or have suggestions, [please leave an issue](https://github.com/patrick-choe/mojang-spigot-remapper/issues)!

Contact me at

- Discord: patrickkr
- Email: mailpatrickkr [@] gmail.com

---

### Changelog

#### 1.4.3

- Update library versions
- Support versions with specific snapshot revision
- Remove signing & maven central publishing

- Remove transitive dependency inheritance
- Remove unnecessary error suppressing

</details>

- Update library versions
- Fix deprecated gradle features (Thanks to [@gmitch215](https://github.com/gmitch215))

</details>

- Update library versions
- Modify buildscript
- Change type of `archiveDirectory` option to `DirectoryProperty` (Thanks to [@AlexProgrammerDE](https://github.com/AlexProgrammerDE))
- Change visibility of `ActualProcedure` to `internal`

</details>

- Update library versions
- Add archiveDirectory option

</details>

- Fix internal implementation of remapping
- Change configuration options

</details>

- Fix publication error from v1.1.1

</details>

- Update library versions
- Add note about `userdev`

</details>

- Add archiveName, archiveClassifier option

</details>

- Initial release

</details>

---

mojang-spigot-remapper

mojang-spigot-remapper Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

mojang-spigot-remapper

mojang-spigot-remapper Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README