documentation

ShyamX documentation

Everything you need to add the bot, manage your server and understand how the platform is put together.

Getting started

  1. Use Add to Discord to invite the bot. You need the Manage Server permission on the server.
  2. Log in with Discord. ShyamX only requests your identity and your server list.
  3. Open My Servers and choose Manage Server on any server where the bot is installed.
  4. Pick a module, adjust the settings and press Save changes.

Who can manage what

Access is decided on the server, never in your browser. Three levels exist:

  • Public: the website, features, commands, docs, status and invite pages.
  • Server owner / admin: anyone who owns a server or holds Manage Server or Administrator on it. They can configure only those servers, and only where the bot is present.
  • Bot owner: platform operators listed in the deployment configuration. They alone can open the admin panel, change global settings or enable maintenance.

Trying to open another server's settings, or the admin area without being a bot owner, is refused by the server.

Configuring modules

Modules with a dashboard page: AntiNuke, AutoMod, Logging, Welcome, Tickets, Leveling, Reaction Roles, AutoRole, Invites, Tracking, Verification, Vanity Roles, Custom Roles, Join 2 Create, Join DM, AutoReact and Invite Role.

Channel and role fields are dropdowns filled from your real server, so you never paste IDs. Changes apply to the bot immediately after saving. Some advanced options (for example Logging ignore lists and Leveling rank card images) are set through commands and shown read-only in the dashboard.

Everything else, such as music, games, giveaways and moderation actions, is used through Discord commands. See the command reference.

Maintenance mode

When the platform is under maintenance, a banner appears on the site and dashboard, configuration changes are rejected by the server, and the bot only accepts commands from its owners. Normal operation resumes as soon as maintenance is turned off.

Activity & audit

Each server's overview shows its recent configuration changes (who changed which setting). Bot owners also get a platform-wide audit log covering every sensitive owner action, including who, what, when and whether it succeeded. Secrets are never recorded.

For bot owners

  • The website, dashboard and admin panel are one application; the bot and its API run beside it.
  • The browser never talks to the bot API. The dashboard server does, using a private API key.
  • Bot owners are identified by Discord ID from ADMIN_DISCORD_IDS (or the bot's OWNER_IDS).
  • The deployment guide ships with the project as DEPLOY.md.

FAQ

I don't see my server.

You need to own it or hold Manage Server / Administrator. Log out and back in after your permissions change.

It says the bot isn't installed.

Use the Invite button next to the server. Configuration unlocks once the bot has joined.

Why can't I save right now?

The platform may be in maintenance mode. Check the banner at the top of the page or the status page.