readme

Author: link-fgfgui

.github/workflows/build.yml

@@ -48,6 +48,6 @@ jobs:
           name: Version ${{ github.ref_name }}
           tag_name: ${{ github.ref_name }}
           files: |
-            build/libs/build/libs/revivetoken-${{github.ref_name}}.jar
+            build/libs/revivetoken-${{github.ref_name}}.jar
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -0,0 +1,99 @@
+# ReviveToken
+
+[English](#english-version)
+
+复活币![coin](src/main/resources/assets/revivetoken/textures/item/coin.png)
+消耗 **1** 个**复活币**可以在当前位置原地复活,复活币不会掉落
+![DeathScreen](img/1.png)
+gif:
+![DeathScreenGIF](img/2.gif)
+
+## 新增内容
+
+- 物品:复活币![coin](src/main/resources/assets/revivetoken/textures/item/coin.png)
+  ![coin in creativeTab](img/3.png)
+- **交易**:
+  1. 图书管理员
+     ![trade1](img/4.png)
+  2. 流浪商人-一般交易
+     ![trade2](img/6.png)
+  3. 流浪商人-稀有交易
+     ![trade3](img/5.png)
+- "原地复活"按钮
+  ![DeathScreen](img/1.png)
+
+## 可自定义内容
+
+配置文件示例:
+
+```toml
+#Specify the Token item to consume
+token = "revivetoken:coin"
+#Specify the Item count to consume
+# Default: 1
+# Range: > 0
+cost = 1
+#Disable the trade recipes of Coin
+notrade = false
+```
+
+改变`token`可以改变复活时消耗什么物品(不掉落的物品也会随之改变)
+改变`cost`可以改变复活时消耗多少币
+将`notrade`改为`true`可以取消添加的交易配方
+
+## FAQ
+
+**Q: 为什么我背包里明明有币但是没有立即复活的按钮?**
+**A:** 币不够/币不符合你填的配置文件
+
+**Q: Fabric / Forge / 1.20.1?**
+**A:** 不会做,但欢迎 PR
+
+## English Version
+
+Revive Token - Coin ![coin](src/main/resources/assets/revivetoken/textures/item/coin.png)  
+Consuming **1** Revive Token allows you to respawn on the spot. Tokens will not drop on death.  
+![DeathScreen](img/1e.png)  
+gif:  
+![DeathScreenGIF](img/2e.gif)
+
+## New Features
+
+- Item: Revive Token ![coin](src/main/resources/assets/revivetoken/textures/item/coin.png)  
+  ![coin in creativeTab](img/3e.png)
+- **Trades**:
+  1. Librarian  
+     ![trade1](img/4e.png)
+  2. Wandering Trader – Common Trade  
+     ![trade2](img/6e.png)
+  3. Wandering Trader – Rare Trade  
+     ![trade3](img/5e.png)
+- "Revive" button  
+  ![DeathScreen](img/1e.png)
+
+## Customizable Settings
+
+Sample configuration file:
+
+```toml
+#Specify the Token item to consume
+token = "revivetoken:coin"
+#Specify the Item count to consume
+# Default: 1
+# Range: > 0
+cost = 1
+#Disable the trade recipes of Coin
+notrade = false
+```
+
+Changing `token` lets you define which item is consumed upon revival (non-droppable items will also change accordingly).  
+Changing `cost` lets you set how many tokens are consumed when reviving.  
+Set `notrade` to `true` to disable the added trade recipes.
+
+## FAQ
+
+**Q: Why doesn’t the respawn button appear even though I have tokens in my inventory?**  
+**A:** Not enough tokens / tokens don’t match the item defined in the config file.
+
+**Q: Fabric / Forge / 1.20.1 support?**  
+**A:** Not implemented. PRs are welcome.