Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/developer51709/Noxie/llms.txt

Use this file to discover all available pages before exploring further.

This page walks through everything you need to go from zero to a running Noxie instance: cloning the project, installing Python dependencies, filling in config.json, enabling the required Discord gateway intents, setting bot permissions, and launching the process. By the end, your bot will be online, the SQLite database will be initialized, and slash commands will be queued for global sync.
1

Clone or download the project

Clone the repository or download and extract the source archive into a local directory.
git clone https://github.com/developer51709/Noxie.git
cd Noxie
Your project root should contain main.py, config.json, requirements.txt, and the cogs/ directory.
2

Install dependencies

Noxie requires two Python packages. Install them from the included requirements.txt:
pip install -r requirements.txt
The file pins the following minimum versions:
discord.py>=2.3.0
aiohttp>=3.9.0
Both packages are required. discord.py 2.3+ provides the Components V2 API used for all rich message layouts, and aiohttp powers the OxaPay donation HTTP requests.
3

Configure config.json

Open config.json at the project root and fill in at least the three required values:
{
  "bot_token": "YOUR_DISCORD_BOT_TOKEN",
  "global_prefix": "noxie ",
  "oxapay_merchant_key": "YOUR_OXAPAY_MERCHANT_KEY"
}
  • bot_token — your Discord bot token from the Developer Portal. Alternatively, export it as an environment variable (see below).
  • global_prefix — the permanent global command prefix. Defaults to noxie (with a trailing space).
  • oxapay_merchant_key — your merchant key from the OxaPay dashboard. Required for /donate to function.
If you prefer not to store the token in a file, export it as an environment variable instead — Noxie will read it at startup:
export NOXIE_TOKEN="your_bot_token_here"
4

Enable Discord gateway intents

Noxie requires two Privileged Gateway Intents that must be enabled manually in the Discord Developer Portal.
  1. Open your application in the portal and navigate to the Bot tab.
  2. Scroll to the Privileged Gateway Intents section.
  3. Enable both:
    • ✅ Message Content Intent — allows Noxie to read the content of prefix commands.
    • ✅ Server Members Intent — required for member-related events and profile lookups.
  4. Save your changes.
If either intent is disabled in the portal, Noxie will still connect but prefix commands will silently fail to parse and member events will not fire. Both intents must be active before you run the bot.
5

Set bot permissions

When generating your bot invite link (or under the OAuth2 → URL Generator tab in the portal), grant the following permissions:
PermissionWhy it’s needed
Send MessagesPost hunt results, profiles, and help responses
Embed LinksRender CV2 container layouts
Attach FilesSend mood banner image assets
Use Slash CommandsRegister and respond to application commands
Read Message HistoryContext for certain channel interactions
6

Run the bot

Start Noxie from the project root:
python main.py
On the first run, Noxie will:
  • Create db/noxie.db automatically and initialize all database tables (economy, inventory, badges, donations, guild_prefixes).
  • Load all cogs (prefixes, hunt, donate, profile, help).
  • Sync slash commands globally with Discord’s application command API.
A successful startup looks like this in the console (timestamps and ANSI colors omitted for clarity):
── startup banner ──────────────────────────────────
  🌑  N O X I E  vibe engine · discord companion
────────────────────────────────────────────────────
[OK     ] loaded cogs.prefixes
[OK     ] loaded cogs.hunt
[OK     ] loaded cogs.donate
[OK     ] loaded cogs.profile
[OK     ] loaded cogs.help
[OK     ] slash commands synced (N registered)
[INFO   ] 🌑 Noxie is online — YourBot#0000 (123456789)
[INFO   ]    serving N guild(s)

​
After startup

Once Noxie is online:
  • SQLite database — db/noxie.db is created automatically. No manual database setup is required.
  • Slash commands — commands are synced globally on every startup. Global sync can take up to one hour to propagate to all Discord clients. The commands are registered immediately; they just may not appear in the slash command menu for all users right away.
While slash commands propagate, all features are immediately available via prefix commands. Run noxie hunt, noxie inventory, noxie profile, or noxie help to start using Noxie right away without waiting for Discord’s global command cache to update.

​
Termux (Android) setup

Noxie runs on Android via Termux. Install the required packages and launch the bot with the following commands: 
pkg update && pkg upgrade
pkg install python
pip install discord.py aiohttp
cd /path/to/noxie
python main.py
To keep Noxie running after closing the Termux session, use nohup to detach the process: 
nohup python main.py &
The bot will continue running in the background until the device is restarted or the process is manually killed.

Build docs developers (and LLMs) love

Get started for freeTalk to us