nv-kit 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ABOUT.md +110 -0
- package/README.md +0 -0
- package/package.json +1 -1
package/ABOUT.md
ADDED
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# nv-kit
|
|
2
|
+
|
|
3
|
+
A beginner-friendly Discord.js command handler framework.
|
|
4
|
+
|
|
5
|
+
Install once. Build commands instantly.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 📦 Installation
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install nv-kit
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 🚀 What is nv-kit?
|
|
18
|
+
|
|
19
|
+
nv-kit is a structured command handler for Discord.js that simplifies:
|
|
20
|
+
|
|
21
|
+
- Slash commands
|
|
22
|
+
- Prefix (legacy) commands
|
|
23
|
+
- Cooldowns
|
|
24
|
+
- Permission checks
|
|
25
|
+
- Owner-only commands
|
|
26
|
+
- Test server restriction
|
|
27
|
+
- Optional MongoDB integration
|
|
28
|
+
- Built-in administrative utilities
|
|
29
|
+
|
|
30
|
+
It removes boilerplate so you can focus on writing commands.
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## Handler
|
|
35
|
+
|
|
36
|
+
The handler automatically:
|
|
37
|
+
|
|
38
|
+
- Registers slash commands
|
|
39
|
+
- Handles interactions
|
|
40
|
+
- Parses arguments
|
|
41
|
+
- Applies cooldowns
|
|
42
|
+
- Validates permissions
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## ⚙ Command Options
|
|
47
|
+
|
|
48
|
+
Each command may include:
|
|
49
|
+
|
|
50
|
+
- description
|
|
51
|
+
- type (SLASH | LEGACY | BOTH)
|
|
52
|
+
- guildOnly
|
|
53
|
+
- testOnly
|
|
54
|
+
- ownerOnly
|
|
55
|
+
- permissions
|
|
56
|
+
- minArgs / maxArgs
|
|
57
|
+
- expectedArgs
|
|
58
|
+
- correctSyntax
|
|
59
|
+
- aliases
|
|
60
|
+
- cooldowns
|
|
61
|
+
- deferReply
|
|
62
|
+
- init()
|
|
63
|
+
- callback()
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## 🗂 Default Commands
|
|
68
|
+
|
|
69
|
+
nv-kit includes optional built-in commands:
|
|
70
|
+
|
|
71
|
+
- prefix
|
|
72
|
+
- togglecommand
|
|
73
|
+
- customcommand
|
|
74
|
+
- delcustomcmd
|
|
75
|
+
- requiredpermissions
|
|
76
|
+
- requiredroles
|
|
77
|
+
- channelcommand
|
|
78
|
+
|
|
79
|
+
Disable them during initialization:
|
|
80
|
+
|
|
81
|
+
```js
|
|
82
|
+
new NV({
|
|
83
|
+
client,
|
|
84
|
+
disabledDefaultCommands: ["prefix", "togglecommand"]
|
|
85
|
+
});
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## 🗄 MongoDB
|
|
91
|
+
|
|
92
|
+
MongoDB is **required**! This is used for:
|
|
93
|
+
|
|
94
|
+
- Custom prefixes
|
|
95
|
+
- Custom commands
|
|
96
|
+
- Role requirements
|
|
97
|
+
- Command toggling
|
|
98
|
+
- Persistent guild settings
|
|
99
|
+
|
|
100
|
+
If you do not need dynamic configuration, Mongo can be removed with minor edits.
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
## 👤 Who Is This For?
|
|
105
|
+
|
|
106
|
+
- Beginners learning Discord.js
|
|
107
|
+
- Developers who want structure without complexity
|
|
108
|
+
- Bots growing beyond single-file scripts
|
|
109
|
+
|
|
110
|
+
---
|
package/README.md
CHANGED
|
Binary file
|
package/package.json
CHANGED