Skip to content

Commit d0476fa

Browse files
committed
Add pages and content
1 parent 3a28010 commit d0476fa

File tree

18 files changed

+721
-12
lines changed

18 files changed

+721
-12
lines changed

docs/customization.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Customization
2+
3+
## ✨ Custom Bot
4+
Customize Cookie's **name**, **avatar**, **bio** and **banner** to make it unique for your server.
5+
6+
- Use `/custom_bot` to get started.
7+
8+
---
9+
10+
## ✏️ Custom Messages
11+
You can customize **most messages** sent by Cookie to make them **unique** for your server.
12+
13+
- Use `/messages` to get started.
14+
15+
---
16+
17+
### Send Custom Messages
18+
By using `/messages`, you can **create** and **send** custom messages in any channel on your server.
19+
20+
- You can also right-click any existing message and select `Apps > Copy Message` to duplicate it.
21+
22+
![Message Builder](https://cdn.cookieapp.me/docs/messages/msg_builder.png){ width="450" }
23+
/// caption
24+
A dynamic message builder to create and send custom messages.
25+
///
26+
27+
!!! tip "Edit Custom Messages"
28+
29+
Custom messages can be edited by right-clicking them and selecting `Apps > Edit Message`.
30+
31+
---
32+
33+
### Variables
34+
Depending on the message, you can use different types of variables when editing Cookie's messages.
35+
36+
37+
<div class="annotate" markdown>
38+
39+
- User Variables (1)
40+
- Server Variables (2)
41+
- Role Variables (3)
42+
- Channel Variables (4)
43+
44+
</div>
45+
46+
1. **User Variables** - Information about a specific user.
47+
- `{user_mention}` - Pings the user.
48+
- `{user_name}` - The user's name.
49+
- `{user_global_name}` - The user's global display name
50+
- `{user_display_name}` - The user's display name on the current server
51+
- `{user_avatar}` - The profile picture URL
52+
- `{user_id}` - The user's ID
53+
54+
2. **Server Variables** - Information about the current server.
55+
- `{server_name}` - The name of the current server
56+
- `{member_count}` - The number of members on the server
57+
- `{server_icon}` - The server icon URL
58+
- `{server_id}` - The role ID
59+
60+
3. **Role Variables** - Information about a specific role.
61+
- `{role_name}` - The role name
62+
- `{role_mention}` - The role ping
63+
- `{role_id}` - The role ID
64+
65+
4. **Channel Variables** - Information about a specific channel.
66+
- `{channel_name}` - The channel name
67+
- `{channel_mention}` - The channel mention
68+
- `{channel_id}` - The channel ID

docs/economy.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Economy
2+
Cookie provides an economy system that allows users to collect cookies and spend them on various
3+
items.
4+
5+
!!! info
6+
The economy system is global. Cookies and items are shared across all servers where you use
7+
Cookie.
8+
9+
---
10+
11+
## 🍪 Earn Cookies
12+
There are several ways to earn cookies:
13+
14+
- Claim your daily reward using the `/daily` command.
15+
- Get a job and work using the `/work` command.
16+
- Bake cookies using your oven with the `/bake` command.
17+
- Complete orders using the `/orders` command.
18+
19+
!!! tip "Daily Reminder"
20+
Be reminded of your daily cookies using `/notifications`.
21+
22+
---
23+
24+
## 🛒 Shop
25+
You can spend your cookies on various items in the `/shop`.
26+
27+
- Buy an oven and usee it with `/bake`.
28+
- Buy a safe and use it with `/safe` to protect your cookies from thieves.
29+
30+
You can view, use and sell your items using the `/inventory` command.
31+
32+
---
33+
34+
## 👷🏽‍♂️ Career
35+
You can choose a career path to earn different benefits.
36+
37+
=== "🍪 Cookie Producer"
38+
Employees in cookie production are the indispensable masters of cookie craftsmanship,
39+
conjuring **delicious** cookie creations in record time.
40+
41+
- Get **bonus capacity** in your oven!
42+
43+
=== "👮🏼‍♂️ Security"
44+
Security protects the cookies from **sneaky thieves** and ensures hard-earned cookies
45+
don't fall into the **wrong hands**.
46+
47+
- Gain **extra protection** against cookie theft!
48+
49+
=== "💣 Thief"
50+
Using **cunning tricks** and nimble fingers, the thief gains access to others' cookie supplies.
51+
52+
- Steal cookies from other users with a **higher success rate**!
53+
54+
!!! tip "Changing Career"
55+
You can change your career by buying a job changer from the `/shop`. You will **not**
56+
lose your current career progress.
57+
58+
---
59+
60+
## 👮🏼‍♂️ Stealing Cookies
61+
Steal cookies from other users using the `/steal` command.
62+
63+
- The success rate of stealing cookies depends on your career and the items owned by both you
64+
and the target user.
65+
66+
!!! tip
67+
Use `/info steals` to view who stole cookies from you.
68+
69+
---
70+
71+
## 🏠 Farm
72+
Grow your own cookie ingredients using the `/farm` command.
73+
74+
### What are the benefits of farm upgrades?
75+
- You can buy **more fields** to grow ingredients.
76+
- You unlock **new plants** that you can cultivate.
77+
- You get **more harvest** per field.
78+
79+
### What are server investments?
80+
- You can invest cookies in the current server to unlock benefits for **all members**.
81+
- For each level achieved, you can grow one additional plant **for free** forever.

docs/faq.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# FAQ
2+
## ❓ General Questions
3+
4+
??? quote "What does Cookie do?"
5+
Cookie offers various features for your server, such as games, tickets, giveaways, leveling,
6+
temporary voice channels, and stats.
7+
8+
Use `/help` to explore all features.
9+
10+
??? quote "Is Cookie free to use?"
11+
Yes, all features are available for free. With Cookie Premium, you can increase limits.
12+
13+
??? quote "Can I customize Cookie's messages?"
14+
Yes, use the `/messages` command to personalize messages sent by Cookie.
15+
16+
??? quote "Why isn't a command showing up?"
17+
Some commands are only available on servers, not in private chats.
18+
If you are on a server, ensure that Cookie is a member of the server, and
19+
you have the required permissions, as some commands can only be used by server admins.
20+
21+
??? quote "Where can I report bugs or suggest features?"
22+
You can report bugs easily using `/bug`.
23+
You can also join our [Support Server](https://cookieapp.me/support) and create a new post
24+
in our `#❓cookie-support` forum.
25+
26+
27+
## 🍪 Economy
28+
29+
??? quote "How do I earn cookies?"
30+
You can earn cookies by using claiming your `/daily` reward.
31+
You can get a job with `/work` or use your oven with `/bake`.
32+
33+
??? quote "What can I do with cookies?"
34+
You can spend cookies on various items in the `/shop`.
35+
36+
??? quote "Is the economy system global or per-server?"
37+
The economy system is global. Your cookies and items are shared across all servers
38+
where you use Cookie.
39+
40+
41+
## 💎 Cookie Premium
42+
43+
??? quote "How do I subscribe to Cookie Premium?"
44+
Inside Discord, open [Cookie's profile](https://discord.com/application-directory/1005119817294041209/store)
45+
and click on the `Shop` button to view available subscriptions.
46+
47+
??? quote "What are the benefits of Cookie Premium?"
48+
While all features of Cookie are free to use, Cookie Premium offers increased limits on
49+
certain features, such as more ticket categories or giveaway restrictions.
50+
51+
??? quote "Can I test premium features before subscribing?"
52+
Yes, you can try Cookie Premium free for 30 days using the `/premium info` command.
53+
54+
??? quote "Is the subscription user-based or server-based?"
55+
Once you subscribe, you can use premium features on all servers. If you own a server,
56+
your members will also be able to use premium features on your server.
57+
58+
<br>
59+
Still need help? Join our [Support Server](https://cookieapp.me/support) and create a new post
60+
in our `#❓cookie-support` forum.

docs/features/banner.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Server Banner
2+
3+
Show the most active user in the server banner.
4+
5+
- Use `/banner` to get started.
6+
7+
!!! info
8+
Discord required **server level 2** for banners. If your server does not meet this requirement,
9+
you can send the banner message in a **text channel** instead.
10+
11+
## Customization
12+
The banner image is **highly customizable** and can include various elements. You can also specify
13+
a **role** for the most active user to receive.
14+
15+
![Banner Settings](https://cdn.cookieapp.me/docs/banner/settings.png){ width="400" }
16+
/// caption
17+
Personalize your banner by setting a custom background or font.
18+
///

docs/features/birthday.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Birthday Notifications
2+
3+
Cookie can send birthday greeting to channel on your server.
4+
5+
---
6+
7+
## Member Setup
8+
9+
Members can set their birthday using the `/birthday` command.
10+
11+
![Birthday](https://cdn.cookieapp.me/docs/birthday/birthday.png){ width="350" }
12+
13+
---
14+
15+
## Moderator Setup
16+
Moderators can use `/birthday_settings` to configure birthday notifications.
17+
18+
- A **channel** can be selected for birthday notifications.
19+
- A **role** can be assigned to members on their birthday.
20+
21+
![Birthday Settings](https://cdn.cookieapp.me/docs/birthday/settings.png){ width="350" }

docs/features/giveaway.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Giveaways
2+
Create giveaways in your server to reward your community members!
3+
4+
- Use `/giveaway create` to start a new giveaway.
5+
6+
You can choose different **requirements** to limit who can enter the giveaway (1).
7+
{ .annotate }
8+
9+
1. **The following requirements are available:**
10+
- Require a specific role
11+
- Exclude a role
12+
- Limit to users without Nitro
13+
- Require message activity in the past X days
14+
- Require voice activity in the past X days
15+
- Require account age
16+
- Require server join date
17+
18+
![Giveaway Setup](https://cdn.cookieapp.me/docs/giveaway/setup.png){ width="450" }
19+
/// caption
20+
Manage giveaway settings with an intuitive interface.
21+
///
22+
23+
## View Participants
24+
Use `/giveaway participants` to view the list of users who have entered a giveaway.
25+
26+
## Redraw Giveaway
27+
If you need to select a new winner for a giveaway, use `/giveaway reroll`.

docs/features/index.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Feature Overview
2+
Here is a quick overview of Cookie's **main features**.
3+
If you want to learn more, we have a dedicated page for each system.
4+
5+
---
6+
7+
## 📈 [Leveling](leveling.md)
8+
Cookie has a built-in leveling system for **text** and **voice** activity.
9+
10+
- Activate level-up messages with `/settings`.
11+
- Configure the level system with `/level settings`.
12+
13+
---
14+
15+
## 🎟️ [Ticket System](tickets.md)
16+
Create a ticket panel where users can create support tickets.
17+
18+
- Use `/ticket setup` to enable the ticket system in your server.
19+
20+
---
21+
22+
## 🔊 [TempVoice](tempvoice.md)
23+
Allow users to create their own customizable voice channels!
24+
25+
- Use `/tempvoice setup` to get started.
26+
27+
---
28+
29+
## 🎉 [Giveaways](giveaway.md)
30+
Host powerful giveaways on your server.
31+
32+
- Use `/giveaway create` to start a new giveaway.
33+
34+
---
35+
36+
## 🍰 [Birthday Notifications](birthday.md)
37+
Send birthday notifications to your server members.
38+
39+
- Server members can set their birthday using the `/birthday` command.
40+
- Moderators can use `/birthday settings` to select a **channel** for birthday notifications.

docs/features/leveling.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Level System
2+
Cookie provides a **customizable** level system for both **text** and **voice** activity.
3+
4+
- Members can use `/rank` to view their current level and XP.
5+
- The server leaderboard can be accessed with `/leaderboard server`.
6+
7+
!!! tip
8+
Members can disable their level-up ping using `/notifications`.
9+
10+
## ⚙️ Setup
11+
1. Activate level-up messages with `/settings`.
12+
2. Configure all settings with `/level settings`. By default, level-up messages will be sent
13+
in the channel where the user leveled up.
14+
3. You can customize level-up messages using the `/messages` command.
15+
16+
## ✏️ Text Levels
17+
With **text levels**, users can collect XP when they write messages on your server.
18+
19+
- The XP reward and cooldown can be customized using `/level settings`.
20+
21+
## 🔊 Voice Levels
22+
For **voice levels**, the minutes that you have been active in a voice channel are counted.
23+
24+
!!! note
25+
26+
By default, voice minutes will not be counted in the following cases:
27+
28+
- You are in the AFK channel.
29+
- You are alone in a voice channel.
30+
- You are headset-muted.
31+
- You are in a blacklisted channel.

docs/features/stats.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Statistics & Leaderboards
2+
Cookie provides detailed statistics and leaderboards for **text** and **voice** activity.
3+
4+
- Use `/stats` to view activity stats for the **server** or **individual members**.
5+
- View the **server leaderboard** with `/leaderboard server`.
6+
7+
![Stats Overview](https://cdn.cookieapp.me/docs/stats/stats.png){ width="400" }
8+
/// caption
9+
View detailed statistics about server activity.
10+
///
11+
12+
## Server Info
13+
Use `/info server` to view the history of the server's member count and boosts.
14+
15+
## Server Boosters
16+
Use `/booster` to view a leaderboard of top server boosters.
17+
18+
- You can choose to display current boosters or all-time boosters.

0 commit comments

Comments
 (0)