Skip to content

Commit 67e8547

Browse files
docs: add channel-management
Signed-off-by: Eve <evolvewithevan@gmail.com>
1 parent 8a7833a commit 67e8547

File tree

1 file changed

+78
-0
lines changed

1 file changed

+78
-0
lines changed
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,79 @@
11
# Channel Management
2+
3+
GitCord lets you create Discord channels using YAML files. This makes it easy to set up your server the same way every time.
4+
5+
## How It Works
6+
7+
1. Write a YAML file describing your channel
8+
2. Use a command to create the channel
9+
3. GitCord reads the file and makes the channel
10+
11+
## Channel Types
12+
13+
### Text Channels
14+
For typing messages.
15+
16+
```yaml
17+
name: general
18+
type: text
19+
position: 0
20+
topic: "General chat for everyone"
21+
nsfw: false
22+
```
23+
24+
### Voice Channels
25+
For talking with voice.
26+
27+
```yaml
28+
name: General Voice
29+
type: voice
30+
position: 0
31+
user_limit: 10
32+
```
33+
34+
### Categories
35+
Groups that hold other channels.
36+
37+
```yaml
38+
name: Community
39+
position: 0
40+
type: category
41+
42+
channels:
43+
- general
44+
- memes
45+
- off-topic
46+
```
47+
48+
## Creating Channels
49+
50+
### Single Channel
51+
Use `!createchannel` to make one channel.
52+
53+
**Note:** This command uses a fixed file path.
54+
55+
### Multiple Channels
56+
Use `!createcategory` or `/createcategory` to make a category with channels.
57+
58+
1. Create a category YAML file
59+
2. Create channel YAML files for each channel
60+
3. Run the command
61+
62+
## YAML Basics
63+
64+
### Required Fields
65+
- `name`: Channel name
66+
- `type`: "text", "voice", or "category"
67+
- `position`: Where it appears (0 = top)
68+
69+
### Optional Fields
70+
- `topic`: Channel description
71+
- `nsfw`: Set to true for NSFW channels
72+
- `user_limit`: Max users in voice channels
73+
74+
## Tips
75+
76+
- Use simple, clear names
77+
- Test your YAML files first
78+
- Keep backups of your files
79+
- Use categories to organize channels

0 commit comments

Comments
 (0)