Skip to content

Commit

Permalink
Merge pull request #90 from naem-less/main
Browse files Browse the repository at this point in the history
spelling/grammar update along with some other misc updates
  • Loading branch information
NervN authored Aug 2, 2024
2 parents 90a78e3 + 05a7a21 commit e40665f
Show file tree
Hide file tree
Showing 125 changed files with 490 additions and 455 deletions.
2 changes: 1 addition & 1 deletion guide/Bot/botCount.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Returns the amount of bots in your server/guild!
</discord-messages>

::: danger Warning
This data comes from the cache, not the api, therefore it may not be precise unless all the guild members are cached (which only in tier 5).
This data comes from the cache, not the api, therefore it may not be precise unless all the guild members are cached (which is only in tier 5).
:::

##### Function Difficulty: <Badge type="tip" text="Easy" vertical="middle" />
Expand Down
4 changes: 2 additions & 2 deletions guide/Bot/botOwnerID.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# $botOwnerID

Returns the ID of the bot owner.
If the bot belongs to a team, it'll return multiple ID.
Optionally, and if there is more than one owner (team), you can input a separator.
If the bot belongs to a team, it'll return multiple IDs.
Optionally, if there is more than one owner (team) you can input a separator.

## Usage

Expand Down
4 changes: 2 additions & 2 deletions guide/Bot/ping.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ This function returns the bot's ping, it can be used to check if the bot is onli
<br/>
<discord-messages>
<discord-message :bot="false" role-color="#ffcc9a" author="Member">
!!exec `$ping`ms
!!exec $ping ms
</discord-message>
<discord-message :bot="true" role-color="#0099ff" author="Custom Command" avatar="https://media.discordapp.net/avatars/725721249652670555/781224f90c3b841ba5b40678e032f74a.webp">
`20`ms
20 ms
</discord-message>
</discord-messages>

Expand Down
4 changes: 2 additions & 2 deletions guide/Bot/serverCount.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ Returns the amount of servers the bot is in.
<br/>
<discord-messages>
<discord-message :bot="false" role-color="#ffcc9a" author="Member">
!!exec I am in `$serverCount` servers.
!!exec I am in $serverCount servers.
</discord-message>
<discord-message :bot="true" role-color="#0099ff" author="Custom Command" avatar="https://media.discordapp.net/avatars/725721249652670555/781224f90c3b841ba5b40678e032f74a.webp">
I am in `15000` servers.
I am in 15000 servers.
</discord-message>
</discord-messages>

Expand Down
2 changes: 1 addition & 1 deletion guide/Channel/vcAfter.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# $vcAfter

Returns the Voice channelID that the user switched to, **after**.
Returns the Voice channelID that the user switched to, **after** switching voice channels or joining a voice channel without being in one prior.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion guide/Channel/vcBefore.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# $vcBefore

Returns the Voice channelID the user switched from.
Returns the Voice channelID the user switched from when switching voice channels or when a user leaves a voice channel.

## Usage

Expand Down
42 changes: 42 additions & 0 deletions guide/CodeReferences/ref.message_types.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Message types
Use the `$messageType` function to return the type of the message.

### Current message types:
```
Default
Recipient Add
Recipient Remove
Call
Channel Name Change
Channel Icon Change
Channel Pinned Message
User Join
Guild Boost
Guild Boost Tier 1
Guild Boost Tier 2
Guild Boost Tier 3
Channel Follow Add
Guild Discovery Disqualified
Guild Discovery Requalified
Guild Discovery Grace Period Initial Warning
Guild Discovery Grace Period Final Warning
Thread Created
Reply
Chat Input Command
Thread Starter Message
Guild Invite Reminder
Context Menu Command
Auto Moderation Action
Role Subscription Purchase
Interaction Premium Upsell
Stage Start
Stage End
Stage Speaker
Stage Topic
Guild Application Premium Subscription
Guild Incident Alert Mode Enabled
Guild Incident Alert Mode Disabled
Guild Incident Report Raid
Guild Incident Report False Alarm
Purchase Notification
```
14 changes: 7 additions & 7 deletions guide/Contribution_Info/main.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# Main Information

## Rules
Please follow the following rules:
Please follow the contribution rules:

* Use the template for every function. Template can be found [here](./function_template.md)
* Please use correct English sentences. Swearing is forbidden
* Make clear what you have changed when you make an pull request. Use an appropriate title & description
* Make sure you make docs on functions you know well. You should prevent, in any way possible, that wrong information is pushed.
* Make clear what you have changed when you make a pull request. Use an appropriate title & description
* Make sure you make docs on functions you know well. You should avoid, in any way possible, that wrong information is pushed.

### Editing existing or adding docs
You can edit pages in our github repo. You can click the edit page button for existing page.

#### Requirements
* Github [account](https://github.com)
* Never used Github? Check this https://docs.github.com/en
* Never used Github? Check the github [docs](https://docs.github.com/en)
* Basic knowledge of [markdown]( https://www.markdownguide.org/cheat-sheet/)

Since the function doesn't exist,you have to create a file inside the specific folder in the [repo](https://github.com/raspdevpy/ccdoc/tree/main/guide)
Example $botCount

0. Check in `undone.md` to be sure,that nobody else already documented the function.
1. Fork the [repo](https://github.com/raspdevpy/ccdoc/tree/
1. Fork the [repo](https://github.com/raspdevpy/ccdoc/tree/)
![](https://i.ibb.co/2kPRCX0/image.png)
2. Create a file in bot folder with name `botCount.md`
![](https://i.ibb.co/BLCbs7q/image.png)
Expand All @@ -30,8 +30,8 @@ Example $botCount
![](https://i.ibb.co/8XvCCdm/image.png)
5. go to undone.md and move the function to done
![](https://i.ibb.co/85PxQjM/image.png)
5. If you have done all your changes(add many function docs,not only 1 change), do a pull request,which we will review.
5. If you have done all your changes(add/change many function docs,not only 1), do a pull request,which we will review.
![](https://i.ibb.co/p3RCGYf/image.png)
![](https://i.ibb.co/R9fJz7g/image.png)

### For extra information, please contact a moderator/ developer in our discord server!
### For extra information, please contact a moderator/developer in our discord server!
4 changes: 2 additions & 2 deletions guide/Date/formatDate.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# $formatDate
Formats the providen Date in Milliseconds / Stringed Date / ISO String to default/given format. syntax of formats can be found (here)[https://momentjs.com/docs/#/parsing/string-format/]
Formats the providen Date provided in Milliseconds/Stringed Date/ISO String to default/given format. Syntax of formats can be found [here](https://momentjs.com/docs/#/parsing/string-format/)
#### Usage: `$formatDate[date in ms / string / iso string / javascript convertable date;format]`
Example:
<br/>
Expand Down Expand Up @@ -39,4 +39,4 @@ Date functions uses on default UTC timezone,but you can change it [Learn More](.
:::

##### Function difficulty: <Badge type="tip" text="Easy" vertical="middle" />
###### Tags: <Badge type="tip" text="formatDate" vertical="middle" />
###### Tags: <Badge type="tip" text="formatDate" vertical="middle" />
8 changes: 4 additions & 4 deletions guide/Date/humanizeMS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# $humanizeMS
Converts Milliseconds into a Readable durations
Converts milliseconds into human readable durations

#### Usage: `$humanizeMS[MS;limit (Number) (optional), separator (optional)]`
Example:
Expand All @@ -13,9 +13,9 @@ Example:
</discord-message>
</discord-messages>

::: tip Other Timezone
Date functions uses on default UTC timezone,but you can change it [Learn More](./timezone.md)
::: tip Other Timezones
Date functions by default use the UTC timezone,but you can change it [Learn More](./timezone.md)
:::

##### Function difficulty: <Badge type="tip" text="Easy" vertical="middle" />
###### Tags: <Badge type="tip" text="humanizeMS" vertical="middle" />
###### Tags: <Badge type="tip" text="humanizeMS" vertical="middle" />
4 changes: 2 additions & 2 deletions guide/Date/memberJoinedDate.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# $memberJoinedDate
returns the date the member Joined in date or time or from the current Author
Returns the date a member joined in date or time from the provided user/command executor.
#### Usage: `$memberJoinedDate[userid;date/time(optional)]` or `$memberJoinedDate`
Example:
<br/>
Expand All @@ -17,4 +17,4 @@ Date functions uses on default UTC timezone,but you can change it [Learn More](.
:::

##### Function difficulty: <Badge type="tip" text="Easy" vertical="middle" />
###### Tags: <Badge type="tip" text="memberJoinedDate" vertical="middle" />
###### Tags: <Badge type="tip" text="memberJoinedDate" vertical="middle" />
4 changes: 2 additions & 2 deletions guide/Date/timezone.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# $timezone
this function set the timezone for all date functions
get tz name (here)[https://en.wikipedia.org/wiki/List_of_tz_database_time_zones]
This function sets the timezone for all date functions after the `$timezone` function itself.\
Get valid timezone names from [this website](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
#### Usage: `$timezone[Region/City]`

Example:
Expand Down
3 changes: 1 addition & 2 deletions guide/Events/eventDelete.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# $eventDelete

to delete an already existed event

To delete an existing event
## Usage

```bash
Expand Down
14 changes: 7 additions & 7 deletions guide/Guide/1.create.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ Before we start working on our command, we have to create one.
> ![](https://i.imgur.com/VFsbL20.png)
::: tip Tour
On your first visit you will be greeted with a dashboard tour!
We highly suggest NOT skipping through it... It will save you a lot of trouble in the future!
We highly suggest NOT skipping through it. It will save you a lot of trouble in the future!
:::

## Type
A very first part of every command is it's type, an action which will activate your command.
The very first part of every command is it's type, an action which will activate your command.
It can be selected using this dropdown menu:
> ![Type dropdown](https://cdn.discordapp.com/attachments/957286111250624552/1096882428422918164/image.png)
Expand All @@ -50,8 +50,8 @@ You can proceed to a guide on specific trigger by clicking the green name of it.
:::

## Trigger
Command type is sometimes not enough to make your command working perfectly.
Sometimes you need the action to meet some conditions, for example: a message should be a certain `!ping` to activate your **ping** command.
Command type is sometimes not enough to make your command work perfectly.
Sometimes you need the action to meet some conditions, for example: a message should start with `!ping` to activate your **ping** command.
This field can be specified using this input field:
> ![trigger input](https://cdn.discordapp.com/attachments/957286111250624552/1096884667686326302/image.png)
::: tip
Expand All @@ -61,15 +61,15 @@ The value expected greatly depends on the type of your command. We recommend che


## Code
Now as you know how to make a triggered, we can move on to the real **meat** of a custom command, the **code**.
Now as you know how to make a trigger, we can move on to the real **meat** of a custom command, the **code**.
Code is simply what the bot will do upon triggering.
It can be set using this field:
> ![code editor](https://cdn.discordapp.com/attachments/957286111250624552/1096900826791944304/image.png)
### What should I put there?
The simplest code is just a text which gets sent after triggering.
But typing in a plain text is of course not all you can do with CC.
Inside the code field you can use various functions, which you can find under `Functions` tab in this documentation, or in docs built-in the dashboard.
Inside the code field you can use various functions, which you can find under the `Functions` tab in this documentation, or in docs built into the dashboard.

::: tip Examples
You can find some examples of CC in action in the [Tutorials & Examples](../Tutorials/1.ping.md) tab.
Expand All @@ -95,4 +95,4 @@ Here's a short explanation of all of them:
You do not always have to code every single command by yourself. From the dashboard you get access to a great deal of templates, that can be effortlessly imported and setup easily.

#### Want to learn more?
If you want to learn more about what templates are, and how to get them, please check the [template section](./4.template.md).
If you want to learn more about what templates are, and how to get them, please check the [template section](./4.template.md).
20 changes: 10 additions & 10 deletions guide/Guide/2.faq.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
# Frequently Asked Questions

## Why does the bot has such high cooldowns?
## Why does the bot have such high cooldowns?
::: details Answer
Our bot is unique in it's sort.
But sadly we aren't quite big enough yet, to get our raidimits decreased!
But sadly we aren't quite big enough yet to get our rateimits decreased.
Regarding to this, we sadly have to add cooldowns to functions and command executions. This to prevent a punishment from Discord Inc.
:::

## I don't see the "copy ID" option. Help!
:::details Fix
Enable the developer mode on discord. This will give you all the required options!
Enable developer mode on discord. This will give you all the required options!

https://media.discordapp.net/attachments/772051120368910371/882629065314566144/get_id.gif
:::


## Are there inbuild commands? Or do I have to code them all myself
## Are there inbuilt commands, or do I have to code them all myself?
:::details Answer
You kind of need to... We only have some basic commands like `!!purge` & `!!ban` build in.
You kind of need to. We only have some basic commands like `!!purge` and `!!ban` built in. You can view them all by running `!!commands` in your server.

There are some commands that you can use to get a dashboard link and your total amount of votes. Read [me](../Guide/botInfo.md) to learn more
Other commands that you can use include getting a dashboard link or your total amount of votes. Read [me](../Guide/botInfo.md) to learn more
:::

## Why does my embed not sends correctly?
## Why does my embed not send correctly?
::: details Answer
It's probably because you have a hyperlink in it...
It's probably because you have a hyperlink in it.

![](https://media.discordapp.net/attachments/772051120368910371/883355096308654080/url_in_description_embed.gif)
:::

## How do I get an ID from a channel, user, message, thread or guild?
## How do I get an ID from a channel, user, message, thread or guild(server)?
::: details Answer
![](https://media.discordapp.net/attachments/772051120368910371/882629065314566144/get_id.gif)

Expand All @@ -47,4 +47,4 @@ This is bugged in the web version of discord! You need to use the desktop client
A variable is a place to store some data and get it back later. For example in another command!

Check out the variable category, to see all types available!
:::
:::
40 changes: 20 additions & 20 deletions guide/Guide/3.policy.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,59 @@
# Custom Command Bot's Privacy Policy
Get detailed information here about our, your rights and other information.
# Custom Command bot's Privacy Policy
Get detailed information here about our rights, your rights and other information.

# Our Rights

* Children under 13 years are not allowed to use our service
* Children under 13 years are not allowed to use our service.

* Any type of Selfbotting or Misusage of our Bot is strictly prohibited
* Any type of selfbotting or misusage of our bot is strictly prohibited.

* Our Bot including Custom Bots can't be used to send/host Discussing Offensive/Controversial Material/Pirated content and NSFW Content.
* Our bot including Custom bots can't be used to send/host Discussing Offensive/Controversial Material/Pirated content and NSFW Content.

* You are not allowed to break the Discord TOS or third-party TOS.

Not following our rules can lead to a ban and, in the worst case, a detailed report to Discord. For example, (Scam Servers).
Not following our rules can lead to a ban and, in the worst case, a detailed report to Discord. For example, Scam Servers.

# User Rights

* **Data Removal/Request**: You can contact us to have your data deleted or requested.
* (Server Owner)You can delete data yourself by deleting all Custom Commands and Variables.
* (User)
* Server Owner: You can delete data yourself by deleting all Custom Commands and Variables.
* User:
You can leave the server or contact us to opt-out

* **Content Removal** The Bot and the website use third-party content like open source icons. As owner/maintainer, you have the right to request content removal.
* **Content Removal**: The bot and the website use third-party content like open source icons. As owner/maintainer, you have the right to request content removal.

* **Reports** Every user has the right to report a server that misuses our bot.
* **Reports**: Every user has the right to report a server that misuses our bot.

# Data we collect

* Server ID for identifying data and storing functional data (for example, commands count)

* Users work like commands content(code)
We don't store any private data like other bots. Generally, we only store IDs of servers that are functional for the Bot.
* User's work like command code
We don't store any private data like other bots. Generally, we only store IDs of servers that are functional for the bot.

* Variables setted by yourself on a command. You can leave the server to opt-out.
* Variables set by yourself on a command. You can leave the server to opt-out.


# New: Message Content Intent
Since the new approval of the discord message intent
Useful information gets listed here.
* We don't log out/save any type of message.
If a user sends a message, a custom command with the specified trigger gets executed. So not every message triggers a custom command. In this way, your privacy stays protected.Moreover, we have cooldowns, where a command can only receive a message every 4s if the command has been triggered. With the command!!view, you can view what type of commands the server uses.
* You can always **opt-out** from our bot by leaving the server, and your data will be deleted within 15 days or immediately(~ 1-2 day) (you must contact us for this).
* We don't log/save any type of message.
If a user sends a message, a custom command with the specified trigger gets executed. So not every message triggers a custom command. In this way, your privacy stays protected. Moreover, we have cooldowns, where a command can only receive a message every 4s if the command has been triggered. With the command `!!view`, you can view what commands the server uses.
* You can always **opt-out** from our bot by leaving the server, and your data will be deleted within 15 days or immediately(~ 1-2 days) (you must contact us for this).

# Data Retention

* We regularly do backups(every 10 days). Old backups get overwritten.

For more detailed information about what "User ID","Session Cookies" are, look [here pls.](https://ccommandbot.com/docs) (difficult to read due to lawyer English)
For more detailed information about what "User ID", "Session Cookies" are, look [here please.](https://ccommandbot.com/docs) (difficult to read due to lawyer English)

# Encryption

All data is saved encrypted in our database. In this way, nobody can view the plain database (Example: on an exploit) without our salted token.
All data is saved and encrypted in our database. In this way, nobody can view the plain database (Example: on an exploit) without our salted token.

# Contact Us

Generally,we recommend you contact us through our server to get a faster response.
Generally, we recommend you contact us through our server to get a faster response.

* Email: [[email protected]](mailto:[email protected])
* Server: [ccommandbot.com/join](http://ccommandbot.com/join)
* Server: [ccommandbot.com/join](http://ccommandbot.com/join)
Loading

0 comments on commit e40665f

Please sign in to comment.