Ultron

Ultron is a BBS Teleconference Bot with the purpose of bringing modern amenities to the teleconference module of Worldgroup/MajorBBS. It's multi-function operation works via a !trigger system.

Features

• BBS Connection: Connect to a BBS using a specified host and port.
• Favorites Management: Add, remove, and load favorite BBS addresses.
• Web Search: Use !search <keyword> for Google Custom Searches.
• ChatGPT Interaction: Use !chat <query> to communicate with ChatGPT.
• Weather Information: Use !weather <city or zip> to fetch current weather data.
• YouTube Search: Use !yt <query> for YouTube searches.
• News Headlines: Use !news <topic> to get news headlines via NewsAPI.
• Map Lookup: Use !map <place> to retrieve place information from Google Places API.
• Picture Search: Use !pic <img/gif> <query> to get a picture or GIF from Google Custom Search.
• Stock Prices: Use !stocks <symbol> for the current price of a stock.
• Cryptocurrency Prices: Use !crypto <symbol> for cryptocurrency price data.
• Text-to-Speech: Use !polly <voice> <text> to convert text to speech with AWS Polly.
• YouTube to MP3: Use !mp3yt <youtube link> to download YouTube videos as MP3.
• GIF Search: Use !gif <query> to fetch a popular GIF.
• Timer: Use !timer <value> <minutes or seconds> to set a timer.
• Private Messaging: Use !msg <username> <message> to leave a message for another user.
• Conversation Persistence: Save conversations using DynamoDB.
• Split View: Create multiple bot instances in one interface. (Still in Development)
• Auto-Greeting: Automatically greet new users in the chatroom.
• Keep-Alive: Maintains the connection with periodic messages.
• No Spam Mode: Prevents the bot from responding to public triggers with !nospam.
• Document Generation: Use !doc <topic> to generate a detailed document using ChatGPT.
• Trump's Latest Post: Use !trump to fetch and display Donald Trump's latest post from Truth Social.
• NEW – !said Command: In public chat, type !said <username> to display the three most recent public messages from that user or !said by itself for the last three messages sent to the chatroom in general.
• Email Sending: Use !mail "recipient@example.com" "Subject" "Body" to send an email using Gmail.

Triggers and Commands

!search

Perform a Google Custom Search and return the response as a string.

!chat

Send a query to ChatGPT and return the response.

!weather

Fetch current weather data for the specified city or zip code.

!yt

Perform a YouTube search for the given query.

!news

Fetch top 2 news headlines based on the given topic.

!map

Fetch place information from Google Places API.

!pic <img/gif>

Fetch a picture or GIF URL based on the query format !pic <img/gif> <search terms> using Google Custom Search.

!stocks

Fetch the current price of a stock.

!crypto

Fetch the current price of a cryptocurrency.

!polly

Convert text to speech using AWS Polly and provide an S3 link to the MP3 file.

!mp3yt

Download YouTube video as MP3, upload to S3, and provide the link.

!gif

Fetch a popular GIF based on the query.

!timer

Set a timer for the specified value and unit.

!msg

Leave a private message for another user.

!nospam

Toggle No Spam Mode to prevent the bot from responding to public triggers.

!doc

Generate a detailed document using ChatGPT based on the given topic.

!trump

Fetch and display Donald Trump's latest post from Truth Social.

!said

Display the three most recent public messages from the specified user or the last three messages sent to the chatroom in general.

!mail "recipient@example.com" "Subject" "Body"

Send an email using Gmail.

!blaz

Fetch and display information about a radio station based on its call letters.

!radio

Perform a radio search based on the given query.

!pod

Fetch and display information about a podcast episode.

!musk

Fetch and display Elon Musk's latest post from Twitter.

!since

Fetch and display the last time the specified user was seen in the chatroom.

Requirements

• Python 3.x
• Virtual Environment (venv)
• AWS EC2 Instance (Amazon Linux 2)
• AWS DynamoDB
• Screen
• systemd
• Tkinter (usually included with Python)
• asyncio
• boto3 (for AWS DynamoDB integration)
• requests (for API requests)
• openai (for ChatGPT integration)
• pytube (for YouTube video downloads)
• pydub (for audio processing)
• subprocess (for running external commands)
• smtplib (for sending emails)

Local Installation

1. Clone the repository:

   git clone https://github.com/ntack93/BBSBOT.git
   cd BBSBOT

2. Install the required Python packages:

   pip install -r requirements.txt

3. Create configuration files:
   Create username.json, password.json, and email_credentials.json in the project directory containing your credentials. For example:

   For username.json:

   "your_username"

   For password.json:

   "your_password"

   For email_credentials.json:

   {
       "smtp_server": "smtp.gmail.com",
       "smtp_port": 587,
       "sender_email": "your-email@gmail.com",
       "sender_password": "your-email-password"
   }

EC2 Deployment

1. Launch EC2 Instance:

   • Launch an Amazon Linux 2 EC2 instance
   • Configure security group to allow inbound port 23 (Telnet)
   • Connect to your instance:

   ssh -i your-key.pem ec2-user@your-instance-ip

2. Install Dependencies:

   # Update system
   sudo yum update -y
   
   # Install Python 3 and development tools
   sudo yum install python3 python3-devel gcc screen -y
   
   # Install pip
   curl -O https://bootstrap.pypa.io/get-pip.py
   python3 get-pip.py --user

3. Set Up Project:

   # Create project directory
   mkdir -p /home/ec2-user/Headless-Robot
   cd /home/ec2-user/Headless-Robot
   
   # Create virtual environment
   python3 -m venv venv
   source venv/bin/activate
   
   # Clone repository
   git clone https://github.com/ntack93/BBSBOT.git .
   
   # Install requirements
   pip install -r requirements.txt

4. Create Startup Script:

   # filepath: /home/ec2-user/Headless-Robot/start_bot.sh
   #!/bin/bash
   cd /home/ec2-user/Headless-Robot
   source venv/bin/activate
   screen -dmS bbs_bot python3 UltronCLI.py

5. Create Systemd Service:

   # filepath: /etc/systemd/system/bbs-bot.service
   [Unit]
   Description=BBS Bot Service
   After=network.target
   
   [Service]
   Type=forking
   User=ec2-user
   WorkingDirectory=/home/ec2-user/Headless-Robot
   ExecStart=/bin/bash /home/ec2-user/Headless-Robot/start_bot.sh
   Restart=always
   RestartSec=10
   
   [Install]
   WantedBy=multi-user.target

6. Set Permissions:

   # Make startup script executable
   chmod +x /home/ec2-user/Headless-Robot/start_bot.sh
   
   # Set proper ownership for systemd service
   sudo chown root:root /etc/systemd/system/bbs-bot.service
   sudo chmod 644 /etc/systemd/system/bbs-bot.service

7. Enable and Start Service:

   # Reload systemd
   sudo systemctl daemon-reload
   
   # Enable service
   sudo systemctl enable bbs-bot
   
   # Start service
   sudo systemctl start bbs-bot

Managing the Bot on EC2

1. Service Management:

   # Check service status
   sudo systemctl status bbs-bot
   
   # View logs
   journalctl -u bbs-bot -f
   
   # Restart service
   sudo systemctl restart bbs-bot
   
   # Stop service
   sudo systemctl stop bbs-bot

2. Screen Session Management:

   # List screen sessions
   screen -ls
   
   # Attach to bot screen
   screen -r bbs_bot
   
   # Detach from screen (while in screen)
   # Press Ctrl+A, then press D

3. Log Monitoring:

   # View bot logs
   tail -f /home/ec2-user/Headless-Robot/bbs_bot.log

File Structure

• ultronprealpha.py: Main application script.
• ultron(MacOS).py: MacOS-specific version of the bot.
• README.md: This README file.
• requirements.txt: List of required Python packages.
• api_keys.json: Stores API keys.
• favorites.json: Stores favorite BBS addresses.
• username.json: Stores the username.
• password.json: Stores the password.
• email_credentials.json: Stores email credentials.
• last_seen.json: Stores the last seen timestamps for users.
• nospam_state.json: Stores the state of No Spam Mode.

File Structure on EC2

/home/ec2-user/Headless-Robot/
├── venv/                     # Virtual environment
├── UltronCLI.py             # CLI interface
├── UltronPreAlpha.py        # Main bot logic
├── api_keys.json            # API keys
├── start_bot.sh             # Startup script
├── username.json            # Credentials
└── bbs_bot.log             # Log file

API Setup

To enable the various triggers, obtain API keys from these services and enter them via the Settings window:

• OpenAI API Key: Sign up at OpenAI, generate an API key, and enter it under "OpenAI API Key".
• Weather API Key: Sign up at OpenWeatherMap, generate an API key, and enter it under "Weather API Key".
• YouTube API Key: Sign up at Google Cloud Platform, enable the YouTube Data API v3, generate an API key, and enter it under "YouTube API Key".
• Google Custom Search API Key and ID (cx): Enable the Custom Search API in Google Cloud Platform, generate an API key, create a search engine via the Custom Search Engine page, then enter the API key under "Google CSE API Key" and the Search Engine ID under "Google CSE ID (cx)".
• News API Key: Sign up at NewsAPI, generate an API key, and enter it under "News API Key".
• Google Places API Key: Enable the Places API in Google Cloud Platform, generate an API key, and enter it under "Google Places API Key".
• Pexels API Key: Sign up at Pexels, generate an API key, and enter it under "Pexels API Key".
• Alpha Vantage API Key: Sign up at Alpha Vantage, generate an API key, and enter it under "Alpha Vantage API Key".
• CoinMarketCap API Key: Sign up at CoinMarketCap, generate an API key, and enter it under "CoinMarketCap API Key".
• Giphy API Key: Sign up at Giphy, generate an API key, and enter it under "Giphy API Key".

DynamoDB Setup

For conversation persistence and user management, set up the following tables in AWS DynamoDB:

• ChatBotConversations

  • Partition key: username (String)
  • Sort key: timestamp (Number)

• ChatRoomMembers

  • Partition key: room (String)

• PendingMessages

  • Partition key: recipient (String)
  • Sort key: timestamp (Number)

Configure your AWS credentials using:

aws configure

and follow the prompts.

Troubleshooting EC2 Deployment

1. Service Won't Start:

   • Check logs: journalctl -u bbs-bot -f
   • Verify paths in start_bot.sh
   • Ensure proper permissions

2. Bot Disconnects:

   • Check network connectivity
   • Verify keep-alive settings
   • Review EC2 security groups

3. Screen Session Missing:

   • Restart service: sudo systemctl restart bbs-bot
   • Check screen installation: which screen

4. Permission Issues:

   • Verify file ownership: ls -l /home/ec2-user/Headless-Robot/
   • Check service user: ps aux | grep bbs_bot

Usage

1. Run the application:

   python ultronprealpha.py

   Note: Although the main script is named "ultronprealpha.py", the bot’s persona is Ultron.

2. Connect to a BBS:
   Enter the BBS host and port in the GUI and click "Connect".

3. Public vs. Private Chat:

   • In public chat, the bot only responds when a recognized trigger is present.
   • Private (whispered or paged) messages without an explicit trigger are automatically treated as !chat commands.
   • The bot does not respond to its own messages.

4. Using the New !said Command:
   In public chat, type:

   !said <username>

   to retrieve and display the three most recent public messages from that user.

5. Using the New !mail Command:
   In public chat, type:

   !mail "recipient@example.com" "Subject" "Body"

   to send an email using Gmail.

6. Other Commands:
   Refer to the Features section for a complete list of available commands.

7. Additional Settings:
   Use the Settings window to configure API keys and preferences.
   Use the Favorites window to manage your favorite BBS addresses.
   To ensure uninterrupted query responses, send the command /P OK in the chat to enable unlimited pages.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.