Compatibility
Minecraft: Java Edition
1.21.3
1.21.1
1.20.1–1.20.2
1.19.4
1.16.5
1.15.2
Platforms
Paper
Supported environments
75% of ad revenue goes to creators
Support creators and Modrinth ad-free with Modrinth+Details
LoreEditor
Packet-level item lore modification for Spigot and its forks.
⚠️Warning
This plugin only supports versions listed in the Modrinth page. Other versions will NOT work.
Check your server version before downloading the plugin!
✨Features
- Add lore lines to items, without affecting an actual item.
📥Installation
You can download the latest version of LoreEditor from the Modrinth and then place it in your plugins
folder.
🔧Developer API
LoreEditor provides a simple API for developers to use.
💻Dependency
📝plugin.yml
To use LoreEditor in your plugin, you need to add the following to your plugin.yml
:
depend: [LoreEditor]
Maven
If you are using Maven, add the following to your <repositories>
tag in pom.xml
:
<repository>
<id>azisaba</id>
<url>https://repo.azisaba.net/repository/maven-public/</url>
</repository>
And add the following to your <dependencies>
tag in pom.xml
:
<dependency>
<groupId>net.azisaba.loreeditor</groupId>
<artifactId>api</artifactId>
<version>[version]</version>
<scope>provided</scope>
<classifier>all</classifier> <!-- don't forget "all" classifier -->
</dependency>
Gradle (Kotlin DSL)
repositories {
maven("https://repo.azisaba.net/repository/maven-public/")
}
dependencies {
compileOnly("net.azisaba.loreeditor:api:[version]:all") // don't forget "all" classifier
}
⌨️Usage
Add lore lines
import net.azisaba.loreeditor.api.event.EventBus;
import net.azisaba.loreeditor.api.event.ItemEvent;
import net.azisaba.loreeditor.libs.net.kyori.adventure.text.Component;
import org.bukkit.plugin.java.JavaPlugin;
public class TestPlugin extends JavaPlugin {
@Override
public void onEnable() {
// In LoreEditor, we use EventBus to listen for events.
// This example adds "Hello, world!" to the lore of the every item.
// Please note that blocking operations (such as file IO and database operations) should not be performed in the event listener.
EventBus.INSTANCE.register(this, ItemEvent.class, 0, e -> {
e.addLore(Component.text("Hello, world!"));
// more lore lines...
});
}
// we don't need to unregister the listener because LoreEditor will handle it.
}
📜License
LoreEditor is licensed under the GNU General Public License v3.0.