Skip to content

Commit d1b1a49

Browse files
committed
docs(README): update plugin description and features
- Add badge icons for license, issues, and Modrinth downloads - Create new Features section highlighting key functionalities - Update Permissions section
1 parent 160bda1 commit d1b1a49

File tree

2 files changed

+20
-14
lines changed

2 files changed

+20
-14
lines changed

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,29 @@
11
# DataSyncer
22

3+
[![License](https://img.shields.io/github/license/AsOne2020/DataSyncer.svg)](http://www.gnu.org/licenses/lgpl-3.0.html)
4+
[![Issues](https://img.shields.io/github/issues/AsOne2020/DataSyncer.svg)](https://github.com/AsOne2020/DataSyncer/issues)
5+
[![Modrinth](https://img.shields.io/modrinth/dt/KInBrN57?label=Modrinth%20Downloads)](https://modrinth.com/plugin/datasyncer)
6+
7+
A plugin that allows players to sync entity and block entity data by vanilla's tag query protocol
8+
39
## Depend
410

511
- [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/)
612

7-
## Description
8-
A plugin that allows players to sync entity and block entity data by vanilla's tag query protocol
13+
## Features
914

10-
## Permissions
11-
| Permission | Description | Default |
12-
|--------------------------|-------------------------------------------------|---------|
13-
| datasyncer.block | Has permission to query block data | op |
14-
| datasyncer.entity | Has permission to query entity data | op |
15-
| datasyncer.entity.player | Has permission to query player entity data | op |
16-
| datasyncer.op | Has permission to query operator utilities data | op |
15+
- **Block Data Syncing**: Enables querying of entity data through BlockEntityNbtQueryPacket
16+
- **Entity Data Syncing**: Enables querying of entity data through EntityNbtQueryPacket
17+
- **Region Protection Compatibility**: Integrates with popular protection plugins:
18+
- [Residence](https://www.spigotmc.org/resources/11480/) : By using "container" flag
19+
- [Dominion](https://modrinth.com/plugin/lunadeer-dominion) : By using "container" flag
20+
- **Multi-Version & Folia Support**: Compatible with Minecraft 1.21.x and Folia/Paper/Purpur server software
1721

18-
## Compatibility
1922

20-
[Residence](https://www.spigotmc.org/resources/11480/) or [Dominion](https://modrinth.com/plugin/lunadeer-dominion) (Region query permission control by using "container" flag)
23+
## Permissions
24+
| Permission | Description | Default |
25+
|--------------------------|-------------------------------------------------------------------------|---------|
26+
| datasyncer.block | Has permission to query block data | op |
27+
| datasyncer.entity | Has permission to query entity data | op |
28+
| datasyncer.entity.player | Has permission to query player's entity data | op |
29+
| datasyncer.op | Has permission to query operator utilities data, such as command blocks | op |

build.gradle.kts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,6 @@ val jvmArgsExternal = listOf(
9292
)
9393

9494
val paperPlugins = runPaper.downloadPluginsSpec {
95-
// Configure the Minecraft version for our task.
96-
// This is the only required configuration besides applying the plugin.
97-
// Your plugin's jar (or shadowJar if present) will be used automatically.
9895
url("https://www.zrips.net/CMILib/CMILib1.5.6.0.jar")
9996
url("https://zrips.net/Residence/files/Residence5.1.7.7.jar")
10097
github("LunaDeerMC", "Dominion", "v4.5.0-beta", "Dominion-4.5.0-beta-full.jar")

0 commit comments

Comments
 (0)