Skip to content

Commit 398e6ad

Browse files
zefir-gitzefir-git
authored
Add basic plugin documentation in README (#40)
2 parents f5aa5ff + 39061ac commit 398e6ad

File tree

1 file changed

+170
-1
lines changed

1 file changed

+170
-1
lines changed

‎README.md‎

Lines changed: 170 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,171 @@
11
# CloudnodeMSG
2-
Cloudnode's private messaging plugin
2+
A Minecraft Java plugin for private messages.
3+
4+
Supports message channels (so you don't have to use a command for every DM) and integrates with vanish plugins.
5+
6+
[See the default config](https://github.com/cloudnode-pro/CloudnodeMSG/blob/main/src/main/resources/config.yml)
7+
8+
## Commands
9+
The following are all commands from this plugin.
10+
11+
***
12+
13+
### `/msg <player> <message>`
14+
Send a private message to another player.
15+
16+
<dl>
17+
<dt>Aliases:</dt> <dd><code>/message</code>, <code>/tell</code>, <code>/t</code>, <code>/whisper</code>, <code>/dm</code>, <code>/m</code>, <code>/pm</code></dd>
18+
<dt>Permission:</dt> <dd><code>cloudnodemsg.use</code></dd>
19+
</dl>
20+
21+
***
22+
23+
### `/msg <player>`
24+
Create a private message channel to a player;
25+
i.e. all of your chat messages will be sent as private messages to this player.
26+
Run the command again to disable the message channel.
27+
28+
<dl>
29+
<dt>Aliases:</dt> <dd><code>/message</code>, <code>/tell</code>, <code>/t</code>, <code>/whisper</code>, <code>/dm</code>, <code>/m</code>, <code>/pm</code></dd>
30+
<dt>Permission:</dt> <dd><code>cloudnodemsg.use</code></dd>
31+
</dl>
32+
33+
***
34+
35+
### `/reply <message>`
36+
Send a private message to the last player that messaged you.
37+
38+
<dl>
39+
<dt>Aliases:</dt> <dd><code>/r</code>, <code>/re</code></dd>
40+
<dt>Permission:</dt> <dd><code>cloudnodemsg.use</code></dd>
41+
</dl>
42+
43+
***
44+
45+
### `/teammsg <message>`
46+
Send a private message to your [scoreboard team](https://minecraft.fandom.com/wiki/Scoreboard#Teams).
47+
48+
<dl>
49+
<dt>Aliases:</dt> <dd><code>/tm</code>, <code>/tmsg</code>, <code>/teamchat</code></dd>
50+
<dt>Permission:</dt> <dd><code>cloudnodemsg.use.team</code></dd>
51+
</dl>
52+
53+
***
54+
55+
### `/teammsg`
56+
Create a private message channel to your [scoreboard team](https://minecraft.fandom.com/wiki/Scoreboard#Teams);
57+
i.e. all of your chat messages will be sent as private team messages.
58+
Run the command again to disable the message channel.
59+
60+
<dl>
61+
<dt>Aliases:</dt> <dd><code>/tm</code>, <code>/tmsg</code>, <code>/teamchat</code></dd>
62+
<dt>Permission:</dt> <dd><code>cloudnodemsg.use.team</code></dd>
63+
</dl>
64+
65+
***
66+
67+
### `/ignore <player>`
68+
Ignore a player—you will stop seeing all of their private messages to you.
69+
70+
<dl>
71+
<dt>Aliases:</dt> <dd><code>/block</code></dd>
72+
<dt>Permission:</dt> <dd><code>cloudnodemsg.ignore</code></dd>
73+
</dl>
74+
75+
***
76+
77+
### `/unignore <player>`
78+
You will stop ignoring the player and will be able to receive their private messages again.
79+
80+
<dl>
81+
<dt>Aliases:</dt> <dd><code>/unblock</code></dd>
82+
<dt>Permission:</dt> <dd><code>cloudnodemsg.ignore</code></dd>
83+
</dl>
84+
85+
***
86+
87+
### `/togglemsg`
88+
Enable or disable receiving private messages.
89+
When your private messages are disabled, nobody can message you, but you can still send messages.
90+
91+
<dl>
92+
<dt>Aliases:</dt> <dd><code>/toggledms</code>, <code>/togglepms</code></dd>
93+
<dt>Permission:</dt> <dd><code>cloudnodemsg.toggle</code></dd>
94+
</dl>
95+
96+
***
97+
98+
### `/togglemsg <player>`
99+
Enable or disable receiving private messages of another player.
100+
101+
<dl>
102+
<dt>Aliases:</dt> <dd><code>/toggledms</code>, <code>/togglepms</code></dd>
103+
<dt>Permission:</dt> <dd><code>cloudnodemsg.toggle.other</code></dd>
104+
</dl>
105+
106+
107+
108+
***
109+
110+
### `/cloudnodemsg reload`
111+
Reload the plugin configuration.
112+
113+
<dl>
114+
<dt>Aliases:</dt> <dd><code>/toggledms</code>, <code>/togglepms</code></dd>
115+
<dt>Permission:</dt> <dd><code>cloudnodemsg.reload</code></dd>
116+
</dl>
117+
118+
## Permissions
119+
Here is a list of the permissions used by this plugin.
120+
121+
| Permission | Description | Recommended Group |
122+
|------------------------------|-------------------------------------------------------------------------|-------------------|
123+
| `cloudnodemsg.use` | Allows using the `/msg` and `/r` commands | default |
124+
| `cloudnodemsg.team` | Allows using the `/teammsg` command | default |
125+
| `cloudnodemsg.send.vanished` | Allows sending messages to vanished players | admin |
126+
| `cloudnodemsg.ignore` | Allows using the `/ignore` and `/unignore` commands | default |
127+
| `cloudnodemsg.ignore.bypass` | Makes your private messages visible, even if the recipient ignored you | admin |
128+
| `cloudnodemsg.toggle` | Allows you to use the `/togglemsg` command | default |
129+
| `cloudnodemsg.toggle.other` | Allows you to toggle msg for another player using `/togglemsg <player>` | admin |
130+
| `cloudnodemsg.toggle.bypass` | Allows you to send messages to players with disabled DMs | admin |
131+
| `cloudnodemsg.spy` | Players with this permission see ALL private messages and team messages | admin |
132+
133+
## Release Cycle
134+
135+
CloudnodeMSG follows a weekly **time-based release schedule**,
136+
with new features or changes typically released every **Tuesday**.
137+
138+
When we merge critical bug fixes, we may publish out-of-band releases on any day of the week.
139+
140+
## Report Issues
141+
Please ensure
142+
that you are using the [latest version](https://modrinth.com/plugin/5Ce4fxJB/version/latest) of CloudnodeMSG.
143+
The newest bug fixes are only available in the most recent version,
144+
and support is provided exclusively for this version.
145+
146+
If you encounter any problems with the plugin,
147+
please first check the [list of known issues](https://github.com/cloudnode-pro/CloudnodeMSG/issues?q=is%3Aopen+is%3Aissue+label%3Abug) on our GitHub repository.
148+
If you don’t find a similar fault listed there,
149+
we encourage you to [submit a new issue](https://github.com/cloudnode-pro/CloudnodeMSG/issues/new?labels=bug).
150+
Resolving bugs is the highest priority for this project.
151+
152+
To help us resolve your issue as quickly as possible, please provide as much relevant information as possible,
153+
including error logs, screenshots, and detailed steps to reproduce the problem.
154+
155+
## Feature Requests
156+
157+
To suggest a new feature, please [create a new issue](https://github.com/cloudnode-pro/CloudnodeMSG/issues/new),
158+
providing a detailed description of your idea.
159+
160+
## Contributing
161+
CloudnodeMSG is licensed under the [GPL-3.0 licence](https://github.com/cloudnode-pro/CloudnodeMSG/blob/main/LICENSE).
162+
The source code is available on [GitHub](https://github.com/cloudnode-pro/CloudnodeMSG).
163+
164+
New contributors are most welcome to the project. If you're interested in contributing, follow these steps:
165+
166+
1. [Fork the repository](https://github.com/cloudnode-pro/CloudnodeMSG/fork)
167+
2. Create a new branch for your contributions.
168+
3. Make your changes and ensure they align with the project’s goals.
169+
4. Commit your changes with clear and descriptive messages.
170+
5. Push your changes to your fork.
171+
6. Submit a pull request.

0 commit comments

Comments
 (0)