FunPay Cardinal Documentation

FunPay Cardinal is an automation bot for FunPay with the following capabilities:

FunPay Automation

• Automatic product delivery (Auto-delivery).
• Automatic lot lifting (Auto-bump).
• Auto-responses to predefined commands.
• Automatic lot restoration after sale.
• Automatic lot deactivation when stock is empty.
• Permanent online status.

Telegram Control & Notifications

• Full Control Panel (PU) via Telegram.
• Notifications for: lot lifting, new orders, product delivery, and new messages.
• Ability to reply to messages directly from Telegram.
• Configure auto-delivery and auto-responder modules via Telegram.

Extensibility

• Use variables in auto-response/auto-delivery text.
• Plugin system for custom functionality.

Plugins allow for custom functionality without editing the core source code. Warning: Only install plugins from trusted sources, as they can gain full access to your FunPay account.

To install a plugin:

1. Open your chat with the FunPay Cardinal bot in Telegram.
2. Send the command /menu.
3. Tap the 🧩 Плагины (Plugins) button.
4. Tap the ➕ Добавить плагин (Add plugin) button.
5. Send or forward the plugin file to the bot.

To install on Ubuntu, use the automated installation script which installs all dependencies and runs the bot as a background process:

1. Execute the following command in your terminal: wget https://raw.githubusercontent.com/sidor0912/FunPayCardinal/main/install-fpc.sh -O install-fpc.sh && bash install-fpc.sh
2. Follow the on-screen instructions provided by the installer.

To install FunPay Cardinal on Windows, follow these steps:

1. Install Python: Download and install Python 3.11.0. Crucial: During installation, check the box Add python.exe to PATH on the first screen.
2. Download Project: Download the FunPay Cardinal source archive.
3. Extract: Move the FunPayCardinal-main.zip archive to your desired location and extract it.
4. Setup: Open the FunPayCardinal-main folder and run Setup.bat. Wait for all packages to finish downloading.
5. Run: Close the command prompt window once setup is complete, then run Start.bat to launch the bot.

To run FunPay Cardinal using Docker, ensure you have Docker Desktop (Windows/Mac) or Docker Engine + Docker Compose (Linux) installed.

1. Prepare Files: Download the FunPay Cardinal archive and extract it, or clone the repository.
2. Build Image: Navigate to the project folder and run: docker compose build
3. Initial Configuration: Because the first run requires interactive input (login, tokens, etc.), run a one-time interactive container: docker compose run --rm funpaycardinal Follow the setup wizard prompts in the terminal.
4. Run in Background: Once configured, start the bot in detached mode: docker compose up -d

Note: The directories configs, logs, storage, and plugins are mounted from the host to the container, ensuring data persistence across restarts.

When running on Linux, you can run FunPay Cardinal as a service. If the environment variable FPC_IS_RUNNIG_AS_SERVICE is set to '1', the application will create a PID file to track the process.

PID File Location

The PID file is stored at: /run/FunPayCardinal/{username}/FunPayCardinal.pid

This allows service managers to monitor and manage the process lifecycle.

You can deploy FunPay Cardinal as a Docker container using the provided docker-compose.yml. The service is configured to restart automatically unless manually stopped and requires interactive terminal support (stdin_open and tty).

To ensure data persistence and configuration management, the following host directories must be mapped to the container:

• ./configs: Stores application configuration files.
• ./logs: Stores application log files.
• ./storage: Stores application data/storage.
• ./plugins: Stores external plugins.

services:
  funpaycardinal:
    build: .
    container_name: funpaycardinal
    restart: unless-stopped
    stdin_open: true
    tty: true
    volumes:
      - ./configs:/app/configs
      - ./logs:/app/logs
      - ./storage:/app/storage
      - ./plugins:/app/plugins

FunPay Cardinal relies on several .cfg files located in the configs/ directory. The application uses Utils.config_loader to parse these files.

Primary Configuration Files

Important Notes

• Encoding: All configuration files must be encoded in UTF-8 and use LF line endings to avoid UnicodeDecodeError.
• Language: The language setting is controlled via MAIN_CFG["Other"]["language"] within _main.cfg and is used to initialize the Localizer.

Use these commands to manage your running FunPay Cardinal Docker instance:

• View Logs: docker compose logs -f
• Attach to Console: docker attach funpaycardinal (To detach without stopping the container, press Ctrl+P then Ctrl+Q).
• Stop Bot: docker compose down.