Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New pictures in the documentation should always be created on our demo server, pixel cube, please update images.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
79 changes: 77 additions & 2 deletions docs/custom-bot/login-as-bot.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,80 @@
# Log-In as Bot

With bot login, you can send messages using your custom bot, with or without embeds, and even attach custom command buttons, link buttons, and self-role buttons.

Here is a Example how Log-In as Bot looks like:
![](@site/docs/assets/custom-bot/additional-features/login-as-bot-1.png)

and on Discord:
![](@site/docs/assets/custom-bot/additional-features/login-as-bot-4.png)

In this picture, you can see the channels of your server on the left side. In the center, you can see the messages within the selected channel. At the bottom, there are three buttons: `Send Message`, `Start a Poll`, and `Start a Giveaway`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a picture description and not helpful in a documentation document. It should be placed in the markdown picture description.
Here, instead, should be a detailed description of available options

To access this interface, simply visit https://scnx.app/glink?page=bot/login.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not helpful. Add requirements to using the system (e.g. permissions), having a bot and more. Make sure that this is actually helpful and not just a link.


---
## Send A meesage as your Bot
Click on the `Send Message` button, and you will be greeted with the Message Editor feature from SCNX.

Within the Message Editor, you can:
- Type your message as plain text
- Use rich **embeds** for structured and visually appealing layouts
- **Attach up to 5 images** per message
- Add up to **5 self-role buttons**, each supporting up to **25 self-role options**
- Include up to **5 custom command buttons**, each with up to **25 custom command actions**
- Add up to **5 link buttons** to redirect users to external websites or resources
Comment on lines +22 to +24
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bunch of features are name-dropped here. Create and link to a (new) section in this document that describes what they do and how to use them; also add a small description here. In general, consider a new heading for the message editor and subheadings for each feature.


![](@site/docs/assets/custom-bot/additional-features/login-as-bot-2.png)

:::note
If you want to use `Custom Command Button` and `Custom Command Element` you have to Work with [Custom Commands](https://scnx.app/glink?page=bot/custom-commands)
:::
Comment on lines +28 to +30
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mean this isn't really helpful? Try being more positive, describe what custom commands are and how o use them. With proper description above, you can also remove them.


After configuring your message, click the `Send Message` button. After a short moment, congratulations! you’ve just sent a message with your bot!


---
<center><h1>Coming soon</h1></center>
<center>We're still working on adding this documentation file - please check back later or raise a PR.</center>
## Edit a Message

You can also edit Messages as a bot. Simply click on the **"Edit Message"** button located underneath the message sent by the bot. After clicking the **"Edit Message"** button, you will be greeted with the **Message Editor** feature from **SCNX**.
Here, you can write your message in plain text, use an embed for better formatting, or even combine both — depending on your needs.

Within the Message Editor, you can:
- Type your message as plain text
- Use rich **embeds** for structured and visually appealing layouts
- **Attach up to 5 images** per message
- Add up to **5 self-role buttons**, each supporting up to **25 self-role options**
- Include up to **5 custom command buttons**, each with up to **25 custom command actions**
- Add up to **5 link buttons** to redirect users to external websites or resources

This can help if you forgot something or a Typo if you want to correct.

:::info
You can **only edit messages sent by the bot**. Messages from other users **cannot** be edited through the Message Editor.
:::

Comment on lines +41 to +54
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

duplicated content; create separate section and link it.

---
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we do not use this type of lines in docs in moste cases. remove all lines please.

## Best way to use "Log-In as Bot"
Here is a list on where you can use Log-In as Bot:

- **Create announcements** for your community
- **Set up self-role systems** that allow users to assign roles to themselves with the click of a button
- **Post your server rules** in a clean and organized format using embeds or plain text
- **Seamlessly integrate with custom commands** to trigger specific bot actions
- Perfect for managing **large communities**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what does this mean? why? you can't make statements like this in a user manual, maybe on a marketing page and even there you might actually need to describe why this might be the case?


---
## Troubleshooting

**Your Bot needs the VIEW_CHANNEL and SEND_MESSAGES permissions on #Channel to use Login-As-A-Bot**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a heading, not something to empathize. Please use a heading element for proper UX.


This error means that you didn’t grant Administrator permissions to your bot. However, it must have at least the `VIEW_CHANNEL` and `SEND_MESSAGES` permissions so it can see the channel and send messages to it.

**When using the Self-Role Buttons, the bot doesn't assign any roles.**

This issue usually occurs when the bot doesn't have the permission to do that. Please make sure your custom bot has the `MANAGE_ROLES` permission.

**In scnx.app its stuck in the "Hang in there, we are fetching you messages..." loading screen**

If you're experiencing issues, you can try **restarting the website** or **switching channels** and then try again.

![](@site/docs/assets/custom-bot/additional-features/login-as-bot-3.png)