Guide Update + Link fix (#359)

* Update threads.md * Update textSplitting.md * Update threads.md * Update threads.md
NilPointer-Software · Aug 2, 2023 · f1b13ba · f1b13ba
1 parent 22157a6
commit f1b13ba
Show file tree

Hide file tree

Showing 2 changed files with 187 additions and 29 deletions.
diff --git a/src/guides/general/textSplitting.md b/src/guides/general/textSplitting.md
@@ -5,13 +5,13 @@ In this section, you'll learn how to use the text splitting.
 [**Functions Used**](#functions-used) > [**$textSplit[]**](#textsplit) > [**$splitText[]**](#splittext) > [**$getTextSplitLength**](#getextsplitlength) > [**$getTextSplitIndex[]**](#gettextsplitindex) > [**$joinSplitText[]**](#joinsplittext) > [**$removeSplitTextElement[]**](#removesplittextelement) > [**Simple Code**](#simple-code)
 
 ## Functions Used
-- [`$textSplit[]`](../bdscript/textSplit.md)
-- [`$splitText[]`](../bdscript/splitText.md)
-- [`$getTextSplitLength`](../bdscript/getTextSplitLength.md)
-- [`$getTextSplitIndex[]`](../bdscript/getTextSplitIndex.md)
-- [`$joinSplitText[]`](../bdscript/joinSplitText.md)
-- [`$removeSplitTextElement[]`](../bdscript/removeSplitTextElement.md)
-- [`$editSplitText[]`](../bdscript/editSplitText.md)
+- [`$textSplit[]`](../../bdscript/textSplit.md)
+- [`$splitText[]`](../../bdscript/splitText.md)
+- [`$getTextSplitLength`](../../bdscript/getTextSplitLength.md)
+- [`$getTextSplitIndex[]`](../../bdscript/getTextSplitIndex.md)
+- [`$joinSplitText[]`](../../bdscript/joinSplitText.md)
+- [`$removeSplitTextElement[]`](../../bdscript/removeSplitTextElement.md)
+- [`$editSplitText[]`](../../bdscript/editSplitText.md)
 
 # $textSplit
 Splits the provided text by a given separator and saves the value temporarily.

diff --git a/src/guides/general/threads.md b/src/guides/general/threads.md
@@ -1,42 +1,200 @@
 # Threads
-![example](https://user-images.githubusercontent.com/69215413/130264464-d976d579-b480-46e5-8dab-abf26a2d4829.png)
 
-Threads are subset-channels within a channel. Threads are great for separating different conversations in one channel. This wiki will explain how you can integrate threads in your bot.
+In this section, you'll learn how to integrate threads in your bot.
 
-> ⚠️ In order to send a message in thread, make sure your bot has `SEND_MESSAGES_IN_THREADS` permission.
+> Make sure your bot has `SEND_MESSAGES_IN_THREADS` permission.
 
-### Creating a Thread
+## Content
+[**Functions Used**](#functions-used) > [**Archive Duration**](#archive-duration) > [**$startThread[]**](#startthread) > [**$editThread[]**](#editthread) > [**$threadAddMember[]**](#threadaddmember) > [**$threadRemoveMember[]**](#threadremovemember) > [**Simple Code**](#simple-code)
+
+## Functions Used
+- [`$startThread[]`](../../bdscript/startThread.md)
+- [`$editThread[]`](../../bdscript/editThread.md)
+- [`$threadAddMember`](../../bdscript/threadAddMember.md)
+- [`$threadRemoveMember[]`](../../bdscript/threadRemoveMember.md)
+
+## Archive Duration
+`60` - 1 Hour\
+`1440` - 1 Day\
+`4320` - 3 Days (Only for servers with level 1 boosted)\
+`10080` - 7 Days (Only for servers with level 2 boosted)
+
+# $startThread
+Creates a new thread in the provided channel.
+
+## Syntax
+```
+$startThread[Thread name;Channel ID;Message ID;(Archive duration;Return thread ID?)]
+```
+
+> Required permissions that the bot must have for this function to work properly:
+- `createpublicthreads`
+
+### Parameters
+- `Thread name` `(Type: String || Flag: Required)`: The name of the newly created thread.
+- `Channel ID` `(Type: Snowflake || Flag: Required)`: The channel where the thread will be created.
+- `Message ID` `(Type: Snowflake || Flag: Emptiable)`: The message from which the thread will be created. Can be left empty.
+- `Archive duration` `(Type: Integer || Flag: Optional)`: The [archive duration](#archive-duration) after which the thread will be auto-archived due to inactivity. Defaults to `60`.
+- `Return thread ID?` `(Type: Bool || Flag: Optional)`: Whether to return the thread channel ID or not. Defaults to `no`.
+
+## Example
+```
+$nomention
+I created a new thread! <#$startThread[Cool Thread;$channelID;;1440;yes]>
+```
+
+``` discord yaml
+- user_id: 803569638084313098
+  username: RainbowKey
+  avatar: https://github.com/NilPointer-Software/bdfd-wiki/assets/113303649/a9034fd5-40c2-4320-a408-2f2ee0071d9d
+  color: "#E67E22"
+  content: |
+    !example
+- type: thread
+  content: |
+    <i style="color: #378afa">BDFD Support</i> Started a thread: <i style="color: white">Cool Thread</i>. See all <i style="color: white">threads</i>.
+- username: BDFD Support
+  avatar: https://github.com/NilPointer-Software/bdfd-wiki/assets/113303649/e5fdc906-6c14-4e19-91c0-4ce95b852c61
+  color: "#378afa"
+  bot: true
+  verified: true
+  content: |
+    I created a new thread! <#Cool Thread>
+```
+\
+
+# $editThread
+Modifies an existing thread.
+
+## Syntax
+```
+$editThread[Thread ID;(Thread name;Archived?;Archive duration;Locked?;Slowmode)]
+```
+
+### Parameters
+- `Thread ID` `(Type: Snowflake || Flag: Required)`: The thread channel to edit.
+- `Thread name` `(Type: String || Flag: Optional)`: The new name of the thread.
+- `Archived?` `(Type: Bool || Flag: Optional)`: Whether to archive this thread or not.
+- `Archive duration` `(Type: Integer || Flag: Optional)`: The [archive duration](#archive-duration) after which the thread will be auto-archived due to inactivity. Defaults to `60`.
+- `Locked?` `(Type: Bool || Flag: Optional)`: Whether to lock this thread or not. Note that archived threads can't be locked.
+- `Slowmode` `(Type: Integer || Flag: Optional)`: The slowmode of this channel, expressed in seconds.
+
+>  Use `!unchanged` as an argument for the option to remain in its current state.
+
+## Example
 ```
-$startThread[name;channelID;messageID (canBeLeftEmpty);archiveDuration (60/1440/4320/10080);returnThreadID (yes/no)]
+$nomention
+$editThread[1098166444111433819;Cool Thread 😎;no;!unchanged;!unchanged;5]
+```
+
+``` discord yaml
+- user_id: 803569638084313098
+  username: RainbowKey
+  avatar: https://github.com/NilPointer-Software/bdfd-wiki/assets/113303649/a9034fd5-40c2-4320-a408-2f2ee0071d9d
+  color: "#E67E22"
+  content: |
+    !example
+- type: edit
+  content: |
+    <i style="color: #378afa">BDFD Support</i> <i style="color: white">changed the channel name: <b>Cool Thread 😎</b></i>
 ```
-Starts a thread [(learn more)](../../bdscript/startThread.md)
+\
+# $threadAddMember
+Adds a user to a thread.
 
-### Editing a Thread
+## Syntax
 ```
-$editThread[threadID;name;archived (yes/no);archiveDuration (60/1440/4320/10080);locked (yes/no);slowmode (in seconds)]
+$threadAddMember[Thread ID;User ID]
 ```
-Edits an existing thread. [(learn more)](../../bdscript/editThread.md)
 
-### Member Thread Management
+### Parameters
+- `Thread ID` `(Type: Snowflake || Flag: Required)`: The ID of the thread channel to add the user to.
+- `User ID` `(Type: Snowflake || Flag: Required)`: The user to add to the thread.
 
-#### Adding a User to a Thread
+## Example
 ```
-$threadAddMember[threadID;userID]
+$nomention
+$threadAddMember[1021054508975009793;$authorID]
 ```
-Adds a user to the thread. [(learn more)](../../bdscript/threadAddMember.md)
 
-#### Removing a User from a Thread
+``` discord yaml
+- user_id: 803569638084313098
+  username: RainbowKey
+  avatar: https://github.com/NilPointer-Software/bdfd-wiki/assets/113303649/a9034fd5-40c2-4320-a408-2f2ee0071d9d
+  color: "#E67E22"
+  content: |
+    !example
 ```
-$threadRemoveMember[threadID;userID]
+- In the thread:
+
+``` discord yaml
+- type: join
+  content: |
+    <i style="color: #378afa">BDFD Support</i> added <i style="color: #E67E22">RainbowKey</i> to the thread.
 ```
-Removes a user from the thread. [(learn more)](../../bdscript/threadRemoveMember.md)
+\
+# $threadRemoveMember
+Removes a user from a thread.
 
-### Example
+## Syntax
+```
+$threadRemoveMember[Thread ID;User ID]
 ```
-$var[threadID;$startThread[Cool Thread;$channelID;;1440;yes]]
-I created a new thread! <#$var[threadID]>
-$c[❗️This example requires BDScript 2 enabled❗️]
+
+### Parameters
+- `Thread ID` `(Type: Snowflake || Flag: Required)`: The ID of the thread channel to remove the user from.
+- `User ID` `(Type: Snowflake || Flag: Required)`: The user to remove from the thread.
+
+## Example
+``` discord yaml
+- user_id: 803569638084313098
+  username: RainbowKey
+  avatar: https://github.com/NilPointer-Software/bdfd-wiki/assets/113303649/a9034fd5-40c2-4320-a408-2f2ee0071d9d
+  color: "#E67E22"
+  content: |
+    !example
 ```
+- In the thread:
 
-### Further Reading
-If you want to learn more about threads, read [Discord's support article](https://support.discord.com/hc/en-us/articles/4403205878423-Threads-FAQ).
+``` discord yaml
+- type: leave
+  content: |
+    <i style="color: #378afa">BDFD Support</i> removed <i style="color: #E67E22">RainbowKey</i> from the thread.
+```
+\
+
+# Simple Code
+```
+$nomention
+$var[id;$startThread[Cool Thread;$channelID;;1440;yes]]
+New thread - <#$var[id]>
+$threadAddMember[$var[id];$authorID]
+```
+
+``` discord yaml
+- user_id: 803569638084313098
+  username: RainbowKey
+  avatar: https://github.com/NilPointer-Software/bdfd-wiki/assets/113303649/a9034fd5-40c2-4320-a408-2f2ee0071d9d
+  color: "#E67E22"
+  content: |
+    !example
+- type: thread
+  content: |
+    <i style="color: #378afa">BDFD Support</i> Started a thread: <i style="color: white">Cool Thread</i>. See all <i style="color: white">threads</i>.
+- username: BDFD Support
+  avatar: https://github.com/NilPointer-Software/bdfd-wiki/assets/113303649/e5fdc906-6c14-4e19-91c0-4ce95b852c61
+  color: "#378afa"
+  bot: true
+  verified: true
+  content: |
+    New thread - <#Cool Thread>
+```
+- In the thread:
+
+``` discord yaml
+- type: join
+  content: |
+    <i style="color: #378afa">BDFD Support</i> added <i style="color: #E67E22">RainbowKey</i> to the thread.
+```
+\
+> If you want to learn more about threads, read [Discord's support article](https://support.discord.com/hc/en-us/articles/4403205878423-Threads-FAQ).