Quick start

Getting started with Onyx

Add Onyx to your Telegram group or Discord server, activate it with your key, and point it at a kingdom. Alerts begin on their own from there.

How it works

Four commands to live alerts

Onyx runs inside the group or server you invite it to. You register it with the key you were given, which starts your subscription and ties the bot to that chat. Then you tell it which kingdom to watch. Scanning and the default alerts turn on the moment a kingdom is set, so there is nothing else to press to start.

Run /register in the group you want alerts in. The command binds Onyx to whatever chat you send it from, and that chat becomes the owner of the subscription. Add the bot as a normal member (Telegram) or app (Discord) first so it can post there.

Setup

Set it up step by step

First run

From invite to first alerts

Follow these in order. Each one is a single message in your group.

1

Add Onyx to your chat

Invite the bot into your Telegram group, or add the app to your Discord server, the same way you would add any other member.

2

Activate with your key

Send your registration key. This starts your subscription and binds Onyx to this group.

/register NX-05-4Q7KM2-... Activated. This group is now bound to your subscription.
3

Point it at a kingdom

Tell Onyx which kingdom to scan. Scanning begins as soon as it confirms.

/move 212 Kingdom set to K212
4

Alerts start on their own

Once a kingdom is set, Onyx begins posting. Fury and shield drop alerts are on by default, so you will see activity without any extra setup.

5

Tune your settings

Open the settings panel to switch individual alerts on or off and set the might ranges you care about.

/settings Settings panel opened.
6

Post the command list

Drop the full list of commands into the group and pin it so everyone can find what Onyx can do.

/commands Command list posted and pinned.

Housekeeping

Everyday commands

A few commands cover the basics: checking that scanning is healthy, seeing how much time is left, changing language, and handing the subscription off if you need to.

/accs

Check the health of the scanning accounts. A normal reply is "All good."

/expiry

Show how much subscription time you have left.

/lang [code]

View or change the language. Pick from 21 languages with the flag picker, or pass a code directly.

/unregister

Release ownership and make the key reusable again. Owner only, and it must be run in the bound group.

Next steps

Where to go from here

Now make it yours. See the Alerts page to learn every alert type and how to tune them, then read Multi-Kingdom to watch more than one kingdom from the same group.
See plans Full command guide