Skip to content

Commit

Permalink
Reorganize README
Browse files Browse the repository at this point in the history
  • Loading branch information
jyhsu2000 committed Feb 23, 2024
1 parent 210c17e commit da0e859
Show file tree
Hide file tree
Showing 2 changed files with 107 additions and 141 deletions.
128 changes: 55 additions & 73 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,104 +6,86 @@
[![bStats Servers](https://img.shields.io/bstats/servers/383?label=bStats%20servers)](https://bstats.org/plugin/bukkit/BannerMaker)
[![bStats Players](https://img.shields.io/bstats/players/383?label=bStats%20players)](https://bstats.org/plugin/bukkit/BannerMaker)

## Link
[![changelog](https://img.shields.io/badge/changelog-en-green)](CHANGELOG.md)
[![contributing](https://img.shields.io/badge/contributing-guide-green)](CONTRIBUTING.md)
[![contributors](https://img.shields.io/badge/contributors-5d5d5d)](CONTRIBUTORS.md)

* [BukkitDev](https://dev.bukkit.org/projects/bannermaker)
* [Spigot Resource](http://www.spigotmc.org/resources/bannermaker.4380/)
* [巴哈小屋](http://home.gamer.com.tw/creationDetail.php?sn=2760067)
* [MCBBS](http://www.mcbbs.net/thread-415289-1-1.html)

Feel banner is fun but you don't know how to craft?
It's too hard to craft so you make wrong usually?
You must try this plugin.
External Links:
[[BukkitDev]](https://dev.bukkit.org/projects/bannermaker)
[[Spigot Resource]](http://www.spigotmc.org/resources/bannermaker.4380/)
[[巴哈小屋]](http://home.gamer.com.tw/creationDetail.php?sn=2760067)
[[MCBBS]](http://www.mcbbs.net/thread-415289-1-1.html)

*Read this in other languages: [English](README.md), [正體中文](README.zh-tw.md).*

Feel banner is fun, but you don't know how to craft?
It's too hard to craft, so you make wrong usually?
You must try this plugin.

## Description

Using just one command, you can use GUI of this plugin to design any kind of banner.
You don't need to know how to craft. All you need to know is how it will looks like.
You don't need to know how to craft. All you need to know is how it will look like.

## Features

* Design and save banner
* Look up recipe of banner
* Support UUID
* Multi language support (Setting in config.yml)
* English(en)
* Traditional Chinese(zh_TW)
* Simplified Chinese(zh_CN)
* German(de)
* French(fr)
* Russian(ru)
* Portuguese(pt_BR)
* Dutch(nl)
* Spanish(es)
* Hungarian(hu)
* Polish(pl)
* Italian(it)
* Economic support (need Vault)
* Material estimates
* Craft banner by using materials
- Design and save banners
- Look up recipe of banners
- Multi-language support (Setting in `config.yml`)
- English (`en`)
- Traditional Chinese (`zh_TW`)
- Simplified Chinese (`zh_CN`)
- German (`de`)
- French (`fr`)
- Russian (`ru`)
- Portuguese (`pt_BR`)
- Dutch (`nl`)
- Spanish (`es`)
- Hungarian (`hu`)
- Polish (`pl`)
- Italian (`it`)
- Economic support (require Vault installed)
- Material estimates
- Craft banner by using materials
- Show your banners to others

## How to use

* Look at pictures at bottom of page
1. Run command `/bm` to open GUI
2. Enjoy it

## Commands

| **Command** | **Description** | **Permission** |
|-------------|--------------------------------------------------|--------------------|
| /bm | Open main gui | BannerMaker.use |
| /bm help | Command list | |
| /bm hand | Show banner info of the banner in hand | BannerMaker.hand |
| /bm see | Show banner info of the banner you're looking at | BannerMaker.see |
| /bm reload | Reload config | BannerMaker.reload |
| **Command** | **Description** | **Permission** |
|----------------|--------------------------------------------------|----------------------|
| `/bm` | Open GUI | `BannerMaker.use` |
| `/bm help` | Command list | |
| `/bm hand` | View banner info of the banner in hand | `BannerMaker.hand` |
| `/bm see` | View banner info of the banner you're looking at | `BannerMaker.see` |
| `/bm view ...` | View banner info of the banner command | `BannerMaker.view` |
| `/bm reload` | Reload config | `BannerMaker.reload` |

## Other Permissions

| **Permission** | **Description** |
|-------------------------------------|-----------------------------------------------------------------|
| BannerMaker.* | Whole permission |
| BannerMaker.getBanner | Get banners from GUI |
| BannerMaker.getBanner.complex-craft | Bypass 6-patterns limit when getting banner (Enabled in config) |
| BannerMaker.getBanner.free | Get banners for free |
## Major Permission Sets

## Installation
| **Permission** | **Description** | **Default** |
|----------------------|--------------------------------|-------------|
| `BannerMaker.player` | Permissions for normal players | True |
| `BannerMaker.admin` | Whole permission | OP |
| `BannerMaker.show` | Show banner info to players | OP |

1. Shutdown the server
2. Put the .jar into the plugins folder
3. Start the server
## Other Permissions

## Change Logs
| **Permission** | **Description** | **Default** |
|---------------------------------------|-----------------------------------------------------------------|-------------|
| `BannerMaker.getBanner` | Get banners from GUI | OP |
| `BannerMaker.getBanner.complex-craft` | Bypass 6-patterns limit when getting banner (Enabled in config) | OP |
| `BannerMaker.getBanner.free` | Get banners for free | OP |

*Read in [CHANGELOG.md](CHANGELOG.md)*
*All detailed permissions can be found in [plugin.yml](src/main/resources/plugin.yml)*

## Pictures

![Main menu](http://i.imgur.com/rMTTfsE.png)
![Create banner](http://i.imgur.com/HB6Dhm3.png)
![Banner info](http://i.imgur.com/Xydmcbj.png)
![Alphabet & Number](http://i.imgur.com/tGHmakp.png)

## Contributing

Pull requests are welcome.
For major changes, please open an issue first to discuss what you would like to change.
For language packs, you can also use [Crowdin](https://crowdin.com/project/bannermaker) for updating or request for new
languages.

### Contributors

Translators:
[Marrarus](https://github.com/Marrarus) (German),
[RedNesto](https://github.com/RedNesto) (French),
[sdir01](https://www.spigotmc.org/members/sdir01.238854/) (Russian),
[maz1lovo](https://github.com/authorless) (Russian),
[Rhander](https://www.spigotmc.org/members/rhander.103119/) (Portuguese),
[DeTrollers](https://www.spigotmc.org/members/detrollers.174265/) (Dutch),
[stevejone1997](https://www.spigotmc.org/members/stevejone1997.432373/) (Spanish),
[C4BR3R4](https://www.spigotmc.org/members/c4br3r4.26779/) (Spanish),
[montlikadani](https://www.spigotmc.org/members/toldi.251100/) (Hungarian),
[ziemniok99](https://www.spigotmc.org/members/ziemniok99.596334/) (Polish),
[Leomixer17](https://www.spigotmc.org/members/leomixer17.140367/) (Italian).
120 changes: 52 additions & 68 deletions README.zh-tw.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,102 +6,86 @@
[![bStats Servers](https://img.shields.io/bstats/servers/383?label=bStats%20servers)](https://bstats.org/plugin/bukkit/BannerMaker)
[![bStats Players](https://img.shields.io/bstats/players/383?label=bStats%20players)](https://bstats.org/plugin/bukkit/BannerMaker)

## Link
[![changelog](https://img.shields.io/badge/changelog-zh--tw-green)](CHANGELOG.zh-tw.md)
[![contributing](https://img.shields.io/badge/contributing-guide-green)](CONTRIBUTING.md)
[![contributors](https://img.shields.io/badge/contributors-5d5d5d)](CONTRIBUTORS.md)

* [BukkitDev](https://dev.bukkit.org/projects/bannermaker)
* [Spigot Resource](http://www.spigotmc.org/resources/bannermaker.4380/)
* [巴哈小屋](http://home.gamer.com.tw/creationDetail.php?sn=2760067)
* [MCBBS](http://www.mcbbs.net/thread-415289-1-1.html)
外部連結:
[[BukkitDev]](https://dev.bukkit.org/projects/bannermaker)
[[Spigot Resource]](http://www.spigotmc.org/resources/bannermaker.4380/)
[[巴哈小屋]](http://home.gamer.com.tw/creationDetail.php?sn=2760067)
[[MCBBS]](http://www.mcbbs.net/thread-415289-1-1.html)

*Read this in other languages: [English](README.md), [正體中文](README.zh-tw.md).*

覺得旗幟很有趣,但又不知道該如何合成?
合成公式太複雜,以致於常常出錯?
你一定要試試這個這個插件

*Read this in other languages: [English](README.md), [正體中文](README.zh-tw.md).*

## 描述

只要一個指令,你將能透過這插件的介面,設計無數種旗幟。
不需要瞭解旗幟合成方式,只要知道你希望旗幟長怎樣。

## 功能

* 設計並儲存旗幟
* 查詢旗幟合成表
* 支援UUID
* 多國語言(在config.yml設定
* 英文(en)
* 正體中文(zh_TW)
* 簡體中文(zh_CN)
* 德文(de)
* 法文(fr)
* 俄文(ru)
* 葡萄牙文(pt_BR)
* 荷蘭文(nl)
* 西班牙文(es)
* 匈牙利文(hu)
* 波蘭文(pl)
* 義大利文(it)
* 支援經濟功能(需要Vault)
* 材料估算
* 使用材料合成旗幟
- 設計並儲存旗幟
- 查詢旗幟合成表
- 多國語言(在 `config.yml` 設定)
- 英文(`en`
- 正體中文(`zh_TW`
- 簡體中文(`zh_CN`
- 德文(`de`
- 法文(`fr`
- 俄文(`ru`
- 葡萄牙文(`pt_BR`
- 荷蘭文(`nl`
- 西班牙文(`es`
- 匈牙利文(`hu`
- 波蘭文(`pl`
- 義大利文(`it`
- 支援經濟功能(需安裝 Vault)
- 材料估算
- 使用材料合成旗幟
- 向其他人展示你的旗幟

## 使用方法

* 請見最下方圖片
1. 使用指令 `/bm` 來開啟界面
2. 享受其中吧

## 指令

| **指令** | **描述** | **權限** |
|------------|--------------|--------------------|
| /bm | 開啟主要介面 | BannerMaker.use |
| /bm help | 指令清單 | |
| /bm hand | 顯示手上持有的旗幟的資訊 | BannerMaker.hand |
| /bm see | 顯示看著的旗幟的資訊 | BannerMaker.see |
| /bm reload | 重新載入設定檔 | BannerMaker.reload |
| **指令** | **描述** | **權限** |
|----------------|--------------|----------------------|
| `/bm` | 開啟主要介面 | `BannerMaker.use` |
| `/bm help` | 指令清單 | |
| `/bm hand` | 檢視手上持有的旗幟的資訊 | `BannerMaker.hand` |
| `/bm see` | 檢視看著的旗幟的資訊 | `BannerMaker.see` |
| `/bm view ...` | 檢視指令附帶的旗幟的資訊 | `BannerMaker.view` |
| `/bm reload` | 重新載入設定檔 | `BannerMaker.reload` |

## 其他權限

| **權限** | **描述** |
|-------------------------------------|----------------------------|
| BannerMaker.* | 完整權限 |
| BannerMaker.getBanner | 從介面取得旗幟 |
| BannerMaker.getBanner.complex-craft | 取得旗幟時,忽略 6 種樣式的限制(於設定檔中啟用) |
| BannerMaker.getBanner.free | 免費取得旗幟 |
## 主要權限集合

## 安裝
| **權限** | **描述** | **預設值** |
|----------------------|-----------|---------|
| `BannerMaker.player` | 一般玩家的權限 | True |
| `BannerMaker.admin` | 完整權限 | OP |
| `BannerMaker.show` | 向其他玩家展示旗幟 | OP |

1. 關閉伺服器
2. 將 .jar 放入 plugins 資料夾
3. 啟動伺服器
## 其他權限

## 更新紀錄
| **Permission** | **Description** | **Default** |
|---------------------------------------|----------------------------|-------------|
| `BannerMaker.getBanner` | 從介面取得旗幟 | OP |
| `BannerMaker.getBanner.complex-craft` | 取得旗幟時,忽略 6 種樣式的限制(於設定檔中啟用) | OP |
| `BannerMaker.getBanner.free` | 免費取得旗幟 | OP |

*請參閱 [CHANGELOG.zh-tw.md](CHANGELOG.zh-tw.md)*
*您可以在 [plugin.yml](src/main/resources/plugin.yml) 中找到所有細部權限*

## 圖片

![Main menu](http://i.imgur.com/rMTTfsE.png)
![Create banner](http://i.imgur.com/HB6Dhm3.png)
![Banner info](http://i.imgur.com/Xydmcbj.png)
![Alphabet & Number](http://i.imgur.com/tGHmakp.png)

## 貢獻

歡迎提交 Pull Request。 對於較大的改動,請先建立 Issue 來讓我們討論一下你想做些什麼。
對於語言包,你也可以使用 [Crowdin](https://crowdin.com/project/bannermaker)
來更新或請求新語言。

### 貢獻者

翻譯者:
[Marrarus](https://github.com/Marrarus) (德文)、
[RedNesto](https://github.com/RedNesto) (法文)、
[sdir01](https://www.spigotmc.org/members/sdir01.238854/) (俄文)、
[Rhander](https://www.spigotmc.org/members/rhander.103119/) (葡萄牙文)、
[DeTrollers](https://www.spigotmc.org/members/detrollers.174265/) (荷蘭文)、
[stevejone1997](https://www.spigotmc.org/members/stevejone1997.432373/) (西班牙文)、
[C4BR3R4](https://www.spigotmc.org/members/c4br3r4.26779/) (西班牙文)、
[montlikadani](https://www.spigotmc.org/members/toldi.251100/) (匈牙利文)、
[ziemniok99](https://www.spigotmc.org/members/ziemniok99.596334/) (波蘭文)、
[Leomixer17](https://www.spigotmc.org/members/leomixer17.140367/) (義大利文)

0 comments on commit da0e859

Please sign in to comment.