Skip to content

Commit 22c34fd

Browse files
committed
chore: updated readme
1 parent 0635579 commit 22c34fd

File tree

1 file changed

+50
-19
lines changed

1 file changed

+50
-19
lines changed

README.md

+50-19
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,60 @@
11
# RoflanUtils
2-
[![Java CI with Gradle](https://github.com/xoderton/RoflanUtils/actions/workflows/gradle.yml/badge.svg)](https://github.com/xoderton/RoflanUtils/actions/workflows/gradle.yml)
32

4-
Social Plugin for Bukkit/Paper servers, that could improve player(s) experience on server.
3+
Plugin that adds commands and tweaks to your server, that might improve player's experience on your server, however there are some commands that are could be useful for redstone builders, learn more about it down below.
54

6-
## Legend
7-
- `<>` – Required
8-
- `()` – Optional
9-
- `[]` – Sub Commands
5+
I should make an important point, that `report` command doesn't store all reports in some kind of database (sqlite, mysql) but **in-memory**, since this command was just an experiement, that might be removed from this plugin.
106

11-
## Commands
7+
# Commands
128

13-
### `/invsee <player>`
14-
Inventory See, simply opens someone's inventory, also allowing you to edit it in any way.
9+
## invsee
1510

16-
### `/item [rename] <...arg>`
17-
`ItemEdit` plugin but minimal and simple version, with price of 1 experience level.
11+
### Description
1812

19-
### `/mute <player> <duration> <reason>`
20-
I don't recommend using this command as actual security layer, since it doesn't being saved between restarts, and it stored in server's memory instead.
13+
Old-Fashioned Invsee from Essentials or EssentialsX, currently *(at the time of writing)* doesn't have armor support, and have some... strange bugs with inventories causing some items to appear in wrong slot when being taken or changed.
2114

22-
### `/report [send/close]`
23-
Small and minimalistic ticket system for administrators, same as `mute`, where it's being saved in memory, instead of somewhere in database.
15+
### Arguments
2416

25-
### `/[vanish/cloak/v]`
26-
Vanish or Cloak, simply hides you or selected player from everyone.
17+
- `player` player that will be examined.
2718

28-
### `/tweak`
29-
`tweak` command is similar to `fabric-carpet` mod, implementing some features from `carpet-extra` and `carpet-tis`
19+
## item
20+
21+
### Description
22+
23+
Adds `rename` command to... rename items with MiniMessage format feature.
24+
25+
## report
26+
27+
### Description
28+
29+
It was added for some server, and this plugin at all was private at first point, but I just decided to publish it, and this command is some kind of tickets that are being saved **in-memory of server** and not in database, so it will be lost upon server's restart, so this is pretty much useless for actual servers, this might be improved in future, or removed at all, but currently this will be like that.
30+
31+
It will send an message to all moderators, that someone got reported. If there moderator joined later and report case was still not closed, it will be sent to them upon connection with all details.
32+
33+
### Arguments
34+
35+
- `send`
36+
- `player` player that will be reported for some reason
37+
- `reason` why {player} is bad and should be banned
38+
- `close`
39+
- `id` id of report that must be closed *(moderators retrieves all reports upon connection to server)*
40+
41+
## tweak
42+
43+
### Description
44+
45+
It's something similar to `fabric-carpet` and his addons, actually all of these tweaks were taken from them, but just made in Paper, there is not alot of them, but some useful for admins or redstoners are already there.
46+
47+
### Arguments
48+
49+
- `tweak` name of the tweak that will be changed
50+
- `value` value that will be applied to tweak, look in `config.yml` for more information
51+
52+
## vanish
53+
54+
### Description
55+
56+
Absolutely vanishes you or some selected player from server, like they are not on the server at all.
57+
58+
### Arguments
59+
60+
- `player` player that will be in vanish, it's optional argument

0 commit comments

Comments
 (0)