Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
way-zer committed Aug 5, 2019
1 parent 60e91b9 commit de95380
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 6 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
23 changes: 21 additions & 2 deletions README.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit de95380

Please sign in to comment.