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 you through everything you need to get Noxie running on your own machine or server — from installing Python dependencies and editing config.json, to starting the bot process and keeping it alive in the background. Noxie runs entirely on Python and a local SQLite file, so there is no external database or cloud service to provision.

​
Prerequisites

Before you begin, make sure you have the following ready:
  • Python 3.10 or later — Noxie uses modern type-hint syntax and asyncio patterns that require 3.10+.
  • pip — the standard Python package manager, bundled with Python.
  • A Discord bot application — you will need a token from the Discord Developer Portal. See the Discord Setup page for step-by-step instructions.

​
Installation Steps

1

Clone or download the project

Clone the repository with Git, or download and unzip the source archive:
git clone https://github.com/developer51709/Noxie.git
cd Noxie
All commands on this page assume your working directory is the project root (the folder that contains main.py).
2

Install Python dependencies

Noxie has exactly two runtime dependencies. Install them from the included requirements.txt:
pip install -r requirements.txt
This installs:
PackageMinimum versionPurpose
discord.py>=2.3.0Discord gateway, intents, Components V2, slash commands
aiohttp>=3.9.0Async HTTP client used for OxaPay API calls
If you are working inside a virtual environment (recommended), activate it before running this command.
3

Configure config.json

Open config.json in the project root and fill in your values. At minimum you must set bot_token:
{
  "bot_token": "YOUR_DISCORD_BOT_TOKEN",
  "global_prefix": "noxie ",
  "oxapay_merchant_key": "YOUR_OXAPAY_MERCHANT_KEY_HERE",
  "oxapay_base_url": "https://api.oxapay.com",
  "donation_channel_log": null,
  "db_path": "db/noxie.db",
  "hunt_cooldown": 30,
  "default_accent_color": 7930727,
  "economy": {
    "glow_shards_per_hunt": [5, 25],
    "vibe_coins_per_hunt": [1, 5],
    "donation_glow_shards_per_usd": 500,
    "donation_vibe_coins_per_usd": 50
  }
}
You can leave all other fields at their defaults for a standard setup. See the OxaPay Setup page if you want to enable the /donate command.
4

Run the bot

Start Noxie with:
python main.py
On Windows you may need to use py instead of python depending on how Python was installed and what is on your PATH:
py main.py

​
What Happens on First Run

When Noxie starts for the first time it performs several automatic setup steps before connecting to Discord:
  • db/noxie.db is created — get_db_conn() in utils/helpers.py creates the db/ directory and the SQLite file if they do not already exist.
  • All database tables are initialized — init_economy_db(conn) and init_prefix_table(conn) run CREATE TABLE IF NOT EXISTS statements, so they are safe to re-run on every start.
  • Slash commands are synced globally — setup_hook calls await self.tree.sync() which registers all application commands with Discord’s API. Global command propagation can take up to one hour to reach all servers.
  • Bot presence is set — once the gateway connection is ready, Noxie sets its activity to “Watching the vibe”.
After the start-up sequence completes you will see log lines confirming each loaded cog and the number of synced slash commands.

​
Using an Environment Variable for the Token

Instead of writing your token directly into config.json, you can pass it as an environment variable. Noxie checks NOXIE_TOKEN first; if it is set, it takes precedence over the bot_token field in the config file: 
export NOXIE_TOKEN="your_bot_token_here"
python main.py
This is the recommended approach on shared servers or in CI/CD pipelines where you want to keep secrets out of the repository.
NOXIE_TOKEN always takes precedence over bot_token in config.json. If both are set, the environment variable wins. If neither is set (or bot_token is still the placeholder string "YOUR_BOT_TOKEN_HERE"), Noxie will print an error and exit without connecting.

​
Platform-Specific Notes

​
Linux / macOS

Standard Python and pip usage applies. If your system has both Python 2 and Python 3 installed, use python3 and pip3 explicitly: 
pip3 install -r requirements.txt
python3 main.py

​
Windows

Python is typically aliased as python or py on Windows. If python is not recognized, try: 
py -3 main.py
Everything else (paths, config syntax, SQLite) works identically on Windows.

​
Termux (Android)

Noxie runs on Android via Termux. Install the required packages and run 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

​
Keeping Noxie Running

If you close your terminal the bot process will stop. For persistent operation, use one of the following approaches: Quick background process (Linux / Termux): 
nohup python main.py &
Screen session (keeps the process in a detachable terminal): 
screen -S noxie
python main.py
# Detach with Ctrl+A then D; reattach with: screen -r noxie
tmux session (similar to screen): 
tmux new -s noxie
python main.py
# Detach with Ctrl+B then D; reattach with: tmux attach -t noxie
systemd service (recommended for Linux servers — auto-starts on reboot): Create /etc/systemd/system/noxie.service: 
[Unit]
Description=Noxie Discord Bot
After=network.target

[Service]
User=youruser
WorkingDirectory=/path/to/noxie
ExecStart=/usr/bin/python3 main.py
Restart=on-failure

[Install]
WantedBy=multi-user.target
Then enable and start it: 
sudo systemctl daemon-reload
sudo systemctl enable noxie
sudo systemctl start noxie

Build docs developers (and LLMs) love

Get started for freeTalk to us