|
1 | 1 | # Quick Start |
2 | 2 |
|
3 | | -Get up and running with GitCord in minutes! This guide will show you how to create your first channels using templates. |
| 3 | +Get GitCord working in minutes! |
4 | 4 |
|
5 | | -## Prerequisites |
| 5 | +## What You Need |
6 | 6 |
|
7 | | -- GitCord bot installed and running (see [Installation](./installation.md)) |
8 | | -- Bot has proper permissions in your Discord server |
9 | | -- You have administrator permissions in the server |
| 7 | +- GitCord bot running (see [Installation](./installation.md)) |
| 8 | +- Bot has permissions in your Discord server |
| 9 | +- You have admin permissions |
10 | 10 |
|
11 | | -## Step 1: Create a Simple Channel Template |
| 11 | +## Step 1: Create a Channel |
12 | 12 |
|
13 | | -Create a file called `my-channels.yaml` with this content: |
| 13 | +Create a file called `general.yaml`: |
14 | 14 |
|
15 | 15 | ```yaml |
16 | 16 | name: general |
17 | 17 | type: text |
18 | 18 | topic: General discussion for the server |
19 | 19 | position: 0 |
| 20 | +nsfw: false |
20 | 21 | ``` |
21 | 22 |
|
22 | | -## Step 2: Use the Create Command |
| 23 | +## Step 2: Create the Channel |
23 | 24 |
|
24 | | -In your Discord server, use the slash command: |
| 25 | +In your Discord server, use: |
25 | 26 |
|
26 | 27 | ``` |
27 | | -/create-channel |
| 28 | +!createchannel |
28 | 29 | ``` |
29 | 30 |
|
30 | | -Then upload your `my-channels.yaml` file when prompted. |
| 31 | +**Note:** This command uses a fixed file path. You'll need to put your file in the right place. |
31 | 32 |
|
32 | 33 | ## Step 3: Create Multiple Channels |
33 | 34 |
|
34 | | -Create a more complex template with multiple channels: |
| 35 | +Create a category file: |
35 | 36 |
|
36 | 37 | ```yaml |
| 38 | +# category.yaml |
37 | 39 | name: community |
38 | 40 | type: category |
| 41 | +position: 0 |
| 42 | + |
39 | 43 | channels: |
40 | | - - name: general |
41 | | - type: text |
42 | | - topic: General discussion |
43 | | - - name: announcements |
44 | | - type: text |
45 | | - topic: Important announcements |
46 | | - - name: voice-chat |
47 | | - type: voice |
48 | | - topic: Voice chat room |
| 44 | + - general |
| 45 | + - announcements |
| 46 | + - voice-chat |
49 | 47 | ``` |
50 | 48 |
|
51 | | -Use the same `/create-channel` command with this template. |
| 49 | +Then create channel files for each channel listed. |
52 | 50 |
|
53 | | -## Step 4: Explore Built-in Templates |
| 51 | +## Step 4: Create the Category |
54 | 52 |
|
55 | | -GitCord comes with pre-built templates. Try: |
| 53 | +Use: |
56 | 54 |
|
57 | 55 | ``` |
58 | | -/templates list |
| 56 | +!createcategory |
59 | 57 | ``` |
60 | 58 |
|
61 | | -This shows available templates you can use immediately. |
| 59 | +Or with a specific path: |
62 | 60 |
|
63 | | -## Step 5: Use a Template |
| 61 | +``` |
| 62 | +/createcategory path/to/category.yaml |
| 63 | +``` |
64 | 64 |
|
65 | | -To use a built-in template: |
| 65 | +## Step 5: Try Basic Commands |
66 | 66 |
|
67 | 67 | ``` |
68 | | -/templates use community |
| 68 | +!hello # Get a greeting |
| 69 | +!ping # Check bot latency |
| 70 | +!help # Show help information |
69 | 71 | ``` |
70 | 72 |
|
71 | | -This creates a community category with general channels. |
| 73 | +## Example Templates |
72 | 74 |
|
73 | | -## Common Templates |
74 | | - |
75 | | -### Community Template |
| 75 | +### Community Category |
76 | 76 | ```yaml |
| 77 | +# category.yaml |
77 | 78 | name: community |
78 | 79 | type: category |
| 80 | +position: 0 |
| 81 | + |
79 | 82 | channels: |
80 | | - - name: general |
81 | | - type: text |
82 | | - topic: General discussion |
83 | | - - name: announcements |
84 | | - type: text |
85 | | - topic: Important announcements |
86 | | - - name: memes |
87 | | - type: text |
88 | | - topic: Share your memes here |
89 | | - - name: off-topic |
90 | | - type: text |
91 | | - topic: Off-topic discussions |
| 83 | + - general |
| 84 | + - announcements |
| 85 | + - memes |
| 86 | + - off-topic |
92 | 87 | ``` |
93 | 88 |
|
94 | | -### Gaming Template |
| 89 | +### Voice Category |
95 | 90 | ```yaml |
96 | | -name: gaming |
| 91 | +# category.yaml |
| 92 | +name: voice-chats |
97 | 93 | type: category |
| 94 | +position: 1 |
| 95 | + |
98 | 96 | channels: |
99 | | - - name: general-gaming |
100 | | - type: text |
101 | | - topic: General gaming discussion |
102 | | - - name: voice-chat |
103 | | - type: voice |
104 | | - topic: Gaming voice chat |
105 | | - - name: game-announcements |
106 | | - type: text |
107 | | - topic: Game updates and announcements |
| 97 | + - vc1 |
| 98 | + - vc2 |
108 | 99 | ``` |
109 | 100 |
|
110 | 101 | ## Next Steps |
111 | 102 |
|
112 | 103 | - Learn about [Channel Management](../user-guide/channel-management.md) |
113 | | -- Explore [Configuration](./configuration.md) options |
114 | | -- Check out [Available Commands](../user-guide/commands.md) |
115 | | -- Create [Custom Templates](../templates/custom-templates.md) |
| 104 | +- Explore [Categories](../user-guide/categories.md) |
| 105 | +- Check [Available Commands](../user-guide/commands.md) |
| 106 | +- Read about [Permissions](../user-guide/permissions.md) |
116 | 107 |
|
117 | 108 | ## Tips |
118 | 109 |
|
119 | | -- Use descriptive channel names and topics |
120 | | -- Organize channels into categories for better structure |
121 | | -- Test templates in a private server first |
122 | | -- Use the `/help` command to see all available options |
| 110 | +- Use clear, simple names |
| 111 | +- Test your YAML files first |
| 112 | +- Keep backups of your files |
| 113 | +- Use the `!help` command for more options |
0 commit comments