Skip to content

Commit d70209b

Browse files
committed
feat(README.md): add dynamic role-based permission system to feature list
docs(README.md): update installation steps to include bot run command docs(commands.md): add new file to document bot commands docs(services.md): add new file to document bot services feat(info.py): add new cog for server, bot, and member info commands feat(avatar.py): add new cog for avatar command to fetch user avatars feat(membercount.py): add new MemberCount cog to show server member count This new cog includes a command 'membercount' that shows the total number of members, humans, bots, and staff in the server.
1 parent 63c9f76 commit d70209b

File tree

7 files changed

+121
-3
lines changed

7 files changed

+121
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Tux is a Discord bot for the All Things Linux Discord server. It is designed to
4646
- Activity rotation
4747
- Custom help command
4848
- Configuration system
49+
- Dynamic role-based (access level) permission system
4950

5051
## Installation
5152

@@ -86,12 +87,14 @@ Tux is a Discord bot for the All Things Linux Discord server. It is designed to
8687
```bash
8788
cp config/settings.json.example config/settings.json
8889
```
89-
8. Run the sync command in the server to sync the slash command tree.
90+
8. Run the bot
91+
```bash
92+
poetry run python tux/main.py
93+
```
94+
9. Run the sync command in the server to sync the slash command tree.
9095
```
9196
{prefix}dev sync <server id>
9297
```
93-
9. Review all useful CLI commands by visiting the [useful CLI commands](docs/CLI.md) file.
9498
95-
9699
## License
97100
This project is licensed under the terms of the The GNU General Public License v3.0. See the [LICENSE](LICENSE.md) file for details.

docs/commands.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# Categories and Commands
2+
3+
## Categories
4+
5+
- Admin
6+
- Fun
7+
- Guild
8+
- Misc
9+
- Moderation
10+
- Utility
11+
12+
13+
## Commands
14+
15+
### Admin
16+
17+
- `dev`
18+
- `sync`
19+
- `clear`
20+
- `load`
21+
- `unload`
22+
- `reload`
23+
- `eval`
24+
- `git`
25+
- `create issue`
26+
- `mail`
27+
- `register`
28+
29+
### Fun
30+
31+
- `random`
32+
- `8ball`
33+
- `coinflip`
34+
- `dice`
35+
- `number`
36+
- `xkcd`
37+
- `latest`
38+
- `random`
39+
- `specific`
40+
41+
### Guild
42+
43+
- `config`
44+
- `set channels`
45+
- `set logs`
46+
- `set roles`
47+
- `get channels`
48+
- `get logs`
49+
- `get roles`
50+
- `export`
51+
- `members`
52+
- `banned`
53+
- `rolecount`
54+
- `distro`
55+
- `de/wm`
56+
- `lang`
57+
- `misc`
58+
- `vanity`
59+
60+
### Misc
61+
62+
- `run`
63+
64+
### Moderation
65+
66+
- `cases`
67+
- `view`
68+
- `modify`
69+
- `ban`
70+
- `unban`
71+
- `kick`
72+
- `timeout`
73+
- `untimeout`
74+
- `jail`
75+
- `unjail`
76+
- `warn`
77+
- `slowmode`
78+
- `purge`
79+
80+
### Info
81+
82+
- `info`
83+
- `member`
84+
- `server`
85+
- `tux`
86+
- `avatar`
87+
- `membercount`
88+
89+
### Utility
90+
91+
- `ping`
92+
- `poll`
93+
- `query`
94+
- `remindme`
95+
- `snippets`
96+
- `tldr`
97+
- `wiki`

docs/services.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Services
2+
3+
## Overview
4+
5+
Services within the context of this bot are background tasks that run continuously and provide various functionalities to the server. They are typically not directly interacted with by users, but rather provide additional features to the server that are not covered by commands.
6+
7+
## Available Services
8+
9+
- **TTY Roles**: Assigns roles to users based on the member count of the server to act as a vanity metric for how long a user has been a member of the server.
10+
- **Harmful Message Detection**: Detects harmful CLI commands in messages and warns users about them.
11+
- **Temp Voice Channels**: Automatically creates temporary voice channels for users to use and deletes them when they are empty.
12+
13+
## Planned Services
14+
15+
- **Auto Welcome**: Sends a welcome message to new members when they join the server.
16+
- **Auto Role**: Assigns a role to new members when they join the server.
17+
- **Auto Mod**: Automatically moderates the server by enforcing rules and restrictions
18+
- **Auto Unban**: Automatically unbans users after a specified duration

tux/cogs/info/__init__.py

Whitespace-only changes.

0 commit comments

Comments
 (0)