Skip to content

Latest commit

 

History

History
72 lines (43 loc) · 2.42 KB

README.md

File metadata and controls

72 lines (43 loc) · 2.42 KB
Raw

Yahoo Auction and Mercari Discord Bot

This project is a Discord bot designed to find newly posted articles on Yahoo Auction and Mercari and alert the user on a Discord server. The bot employs an unofficial Google Translator API to translate the article names from Japanese, which can occasionally result in instability.

Installation

Before you start the installation process, ensure you have Python installed on your system. You can download Python from here. This project is compatible with Python 3.8 and above.

Follow these steps to install the project:

  1. Clone this repository to your local machine using https://github.com/vlourme/yahoo-auction-alert-discord-bot.git.
git clone https://github.com/vlourme/yahoo-auction-alert-discord-bot.git
  1. Navigate to the project directory.
cd yahoo-auction-alert-discord-bot
  1. Install the required dependencies.
pip install -r requirements.txt

Setting Up the Environment Variables

Create a .env file in the root directory of the project. This file will store the Discord token required for the bot to function. The .env file should look something like this:

BOT_TOKEN=your-discord-token
CHECK_INTERVAL=60
ENABLE_YAHOO_AUCTION=true
ENABLE_MERCARI=true

Replace your-discord-token with the actual Discord bot token.

Running the Bot

You can start the bot by running the main.py script.

python main.py

The bot should now be running and scanning Yahoo Auction and Mercari for new articles.

Important Notes

  1. The bot depends on an unofficial Google Translator API to translate the names of the articles from Japanese. Due to the unofficial nature of this API, it can be unstable at times. We are working on a more stable solution and appreciate your patience in the interim.

  2. This bot also relies on ZenMarket unofficial API to fetch items, any API change could break this bot.

  3. Make sure to keep your Discord token secure and never share it with anyone.

Contributing

We welcome contributions to this project. Please feel free to open an issue or submit a pull request.

License

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

Contact

If you encounter any issues or have questions, please open an issue on this GitHub repository. We will try our best to assist you.

This readme was written (mostly) by ChatGPT because I'm lazy.