Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TheRedMagic committed Dec 25, 2024
1 parent 7739efd commit ae5d71c
Showing 1 changed file with 2 additions and 41 deletions.
43 changes: 2 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,45 +2,6 @@

This gradle plugin is made to be able to remap you NMS project to a different mappings. This is mainly used for mojang remapped to spigot mapped

## Imports
To import the remapped you will need to add this to your build.gradle.kts
```
id("com.undefinedcreation.mapper") version "0.0.2"
```
## Documentation
[Documentation](https://docs.undefinedcreation.com/)

## Setup
The base setup of the plugin is very easy (See below).
```
remap {
# Your minecraft version
mcVersion.set("1.21")
}
```

## Configuration
There are multiple configurations that you can use (See below).
```
remap {
// This sets the minecraft version
mcVersion.set("1.21")
// This sets the input task it will remap
// Default : jar
inputTask.set("shadowJar")
// This sets the remap type
// Default : MOJANG_TO_SPIGOT
action.set(RemapTask.Action.MOJANG_TO_SPIGOT)
// If this is set to true it will create a new file with the remap else it will override the default file
// Default : false
createNewJar.set(true)
}
```

## Multi Module
Using this in a multi module setup is very simple make sure that the module using the mapper has the plugin installed and the correct version selected. Then in your main build.gradle.kts add you standard implementation of the module.

## Questions
If you have any questions or need help using this plugin please join the [discord server](https://discord.gg/NtWa9e3vv3)

0 comments on commit ae5d71c

Please sign in to comment.