From de95380457c4f5cf93288d7753578f27d1babed8 Mon Sep 17 00:00:00 2001 From: way-zer Date: Mon, 5 Aug 2019 11:03:03 +0800 Subject: [PATCH] Update README --- README.md | 24 ++++++++++++++++++++---- README.zh.md | 23 +++++++++++++++++++++-- 2 files changed, 41 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index da66b61..c302d39 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,29 @@ An extensible custom item minecraft plugin * every item is a class file(runtime load) * can write custom item feature * every item has Automatically generated detailed configuration(from name to potion effect) +* support **kotlin DSL** and **kotlin Script(alse Superitem.kts)** + (see wiki for example) +## First Glance +Save it as hello.superitem.kts in plugins/Superitem/items to use +```kotlin +require(ItemInfo(Material.NAME_TAG, + "&cHello SuperItem", + listOf("&aWelcome to use SuperItem", + "&a欢迎使用Superitem", + "&c This Item doesn't have other effect"))) +``` ## For More information -see [Wiki](https://github.com/way-zer/SuperItem/wiki) +see [Wiki] ## For Chinese see README.zh.md ## Thanks -* [LibraryManager](https://github.com/way-zer/LibraryManager) (shadowed) For runtime dependencies management -* [PowerNBT](https://github.com/steakteam/PowerNBT) (shadowed) For NBT support +* [LibraryManager] (shadowed) For runtime dependencies management +* [PowerNBT] (shadowed) For NBT support ## License -you should leave link to [this](https://github.com/way-zer/SuperItem/) and keep the author name in command help +you should leave link to [this] and keep the author name in command help feel free to fork and pull requests + +[this]: https://github.com/way-zer/SuperItem/ +[Wiki]: https://github.com/way-zer/SuperItem/wiki +[LibraryManager]: https://github.com/way-zer/LibraryManager +[PowerNBT]: https://github.com/steakteam/PowerNBT \ No newline at end of file diff --git a/README.zh.md b/README.zh.md index 960039f..e72fdbb 100644 --- a/README.zh.md +++ b/README.zh.md @@ -4,10 +4,29 @@ * 每个物品都是一个独立的class文件(运行时加载) * 可以自己编写Feature(见下方说明) * 每个物品都可以自动生成详细的配置文件(从名字到药水效果,取决于Feature) - +* 支持**kotlin DSL** 和 **kotlin Script(也称 Superitem.kts)**(例子详见[Wiki]) ## 授权 -保留[本站](https://github.com/way-zer/SuperItem/)链接并保留指令帮助页的作者信息 +保留[本站]链接并保留指令帮助页的作者信息 欢迎fork并提出pull请求,有任何疑问请提出issue +## 举个栗子 +保存为 hello.superitem.kts 于plugins/Superitem/items, 使用 +```kotlin +require(ItemInfo(Material.NAME_TAG, + "&cHello SuperItem", + listOf("&aWelcome to use SuperItem", + "&a欢迎使用Superitem", + "&c This Item doesn't have other effect"))) +``` +## 感谢 +* [LibraryManager] (shadowed) 提供运行依赖管理 +* [PowerNBT] (shadowed) 提供NBT修改支持 + +[本站]: https://github.com/way-zer/SuperItem/ +[Wiki]: https://github.com/way-zer/SuperItem/wiki +[LibraryManager]: https://github.com/way-zer/LibraryManager +[PowerNBT]: https://github.com/steakteam/PowerNBT + +# ------------过期内容(详见[Wiki])--------------- ## 怎样写一个item ```kotlin package cf.wayzer.example