TornMonitor Cog

TornMonitor is a cog for RedBot, designed to monitor the Torn City game for user-specific activities, such as monitoring bazaar purchases. The cog uses the Torn API to fetch user data and checks periodically for any changes in specified user's bazaar sum of item prices. It compares the total sum of prices with the previous value and if it's lower it means that most likely there was a sell. The logic will only trigger a discord message if the differences between previous and current sum total is more than 5M and bazaar owner is "Okay" or in "Hospital", but with revives "ON". It sends a discord message with an Attack hyperlink for you to initiate the mug.

Features

• API Key Management: Set and store your Torn API key securely.
• User Monitoring: Add or remove user IDs to monitor for activity.
• Purchase Detection: Checks for significant changes in user bazaar purchases.
• Configurable Check Interval: Adjust the time interval between each cycle of checks.
• Detailed Logging: Optionally enable detailed logging for debugging purposes.

Requirements

• RedBot: This cog requires RedBot to be installed. RedBot Documentation
• Python 3.8+: The cog is compatible with Python 3.8 and above.
• Torn API Key: You need a Torn API key, which can be obtained from the Torn City website.

Installation

1. Install RedBot if you haven't already. Follow the instructions on the RedBot GitHub page.

2. Add the cog Send the following messages in discord to your RedBot.

   [p]repo add torn-cogs https://github.com/ivan-kirov/torn-cogs
   [p]cog install torn-cogs Mug
   

Setup

1. Set the Torn API Key Use the command to set your Torn API key. This key is used to authenticate requests to the Torn API.

   [p]mug setapikey <your_api_key>

2. Set the Discord Channel By the default the name of the discord channel is "torn", if you want to specify a different discord channel please use the below cmdlet.

   [p]mug setchannel <your discord channel name>
   

3. Add Users to Monitor Add user IDs that you want the cog to monitor. These should be valid Torn City user IDs.

   [p]mug add <user_id>
   

4. Set the Check Interval Optionally, you can set how often the bot checks for purchases. The interval is specified in seconds.

   [p]mug setinterval <seconds>
   

5. Enable or Disable Detailed Logging Toggle detailed logging to help debug issues or to monitor the bot's activities more closely.

   [p]mug togglelogging true   # To enable detailed logging
   [p]mug togglelogging false  # To disable detailed logging
   
   

Commands

[p]mug setapikey <api_key>	#Sets the Torn API key for authentication.
[p]mug add <user_id>	#Adds a user ID to the list of monitored users.
[p]mug remove <user_id>	#Removes a user ID from the list of monitored users.
[p]mug list	#Lists all currently monitored user IDs.
[p]mug setinterval <seconds>	#Sets the time interval between checks.
[p]mug togglelogging <true/false>	#Enables or disables detailed logging.