Neopets-R-Us - A Python/Selenium-based Adoption Bot

My flatmate was feeling nostalgic for Neopets - so I did what any good dev does and created a problem to f- *ahem* fixed a problem they were absolutely already having!

(To clarify, Neopets and their parent company are in no way affiliated with this project in any kind of professional capacity - only tangentally as their software is the sandbox my bot plays in)

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

Earlier joking aside, the issue said flatmate of mine has is a busy schedule that doesnt leave them with the time to sit down and refresh the Neopets pound non-stop looking for rare pet colors. This little program will log in with your credentials using Selenium, load into the pound, and start saving pictures of all the rare 'pets!

It does a fairly simple x-path lookup (fastest method) to check the color field against a blacklist contained in a handy-dandy config file. If the color matches something in the list, the bot ignores it and moves on.

for each pet out of each 3-pet page that fails to match against the blacklist, the bot will take a webpage screenshot and hand it to Pillow for cropping down to just the relevant third of the pets section. That then gets saved as a .png (in wherever you cloned this repo) under the pets unique name! Easy as 3.1415.

(back to top)

Built With

• Selenium
• Selenium (python)
• TOML
• Pillow

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Python 3.10 and pipenv
  (for linux users, the apt-install for pipenv may be broken! As a general rule, please use python3-pip to install it instead)

• ChromeDriver version that matches your chrome installation
  

  • make sure this is in youre $PATH (Windows, Mac) - Linux users can just grab chromium-chromedriver from their preferred package manager.

Installation

1. Clone the repo

   git clone https://github.com/BLovegrove/Neopets-R-Us.git

2. Create pipenv with dependencies

   .../Neopets-R-Us/ > pipenv install

3. Rename config_template.toml to config.toml
4. Fill in your Neopets username + password in the config.toml file.
5. Launch the bot with:

   .../Neopets-R-Us/ > pipenv run np-bot

6. Profit!!!

(back to top)

Roadmap

• Scan and save names of rare Neopet colors
• Add detailed datetime-based logging system
• Save entire pet card with the name
• Make sure you're auto-creating log + screenshots folder 🤦
• Detect open pet slots and adopt most valuable one(s)
  • Support multiple accounts if pet slots are full
• Check for 'Un-converted' neopets using realtime image processing
  • Add some kind of user-alert for detected UCs

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the Apache 2.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Brandon Lovegrove - @B_A_Lovegrove - [email protected]

Project Link: https://github.com/BLovegrove/Neopets-R-Us

Like my work?

(back to top)