Skip to content

Commit f305447

Browse files
committed
doc: modify README
1 parent 5354458 commit f305447

File tree

1 file changed

+44
-1
lines changed

1 file changed

+44
-1
lines changed

README.md

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,61 @@
11
# mc-scoreboardHelper
22
A Minecraft [mana9er](https://github.com/mana9er/mana9er-core) plugin for enabling in-game sidebar scoreboard cycling.
33

4-
## Functionalities
4+
## Functionalities & Usage
5+
6+
The following shows a list of functionalities of the ***scoreboardHelper*** pulgin and their in-game usages (by sending the command to the chat box).
57

68
### For Players
79

810
1. List all visible scoreboards.
11+
12+
```
13+
!sb list
14+
```
15+
916
2. View a certain scoreboard for a (fixed) period of time.
1017

18+
```
19+
!sb view <name>
20+
```
21+
22+
3. Display help info.
23+
24+
```
25+
!sb help
26+
```
27+
1128
### For Server OPerators
1229

1330
1. Toggle scoreboard cycling.
31+
32+
```
33+
!sb cycle <true|false>
34+
```
35+
1436
2. Register / Remove "visible" scoreboards.
37+
38+
```
39+
!sb <add|rm> visible <name>
40+
```
41+
1542
3. Register / Remove scoreboards for cycling.
43+
44+
```
45+
!sb <add|rm> cycle <name>
46+
```
47+
1648
4. Set scoreboard cycle interval.
49+
50+
```
51+
!sb settime cycle <time_in_sec>
52+
```
53+
1754
5. Set duration for temporal viewing.
1855

56+
```
57+
!sb settime view <time_in_sec>
58+
```
59+
60+
61+

0 commit comments

Comments
 (0)