🎮 OSRS Wiki Search Tool 🔍

"Knowledge is power, and with this tool, you'll have the wisdom of the Wise Old Man at your fingertips!"

---

🌟 Features

• 🔎 Search for monsters within a specific OSRS Wiki category or search for a specific monster
• 📊 Fetch drop tables for all monsters in a category or for a specific monster
• 💾 Save drop tables in JSON format (always)
• 📝 Optionally save drop tables in TXT format
• 🔢 Optionally save only item IDs as a comma-separated list
• 🏦 Create RuneLite bank layout files
• 🖥️ Display progress and results in a rich, interactive console interface

---

🚀 Installation

Prerequisites

• Python 3.7 or higher
• pip (Python package installer)

📥 Click here for detailed installation instructions

Windows

1. Download the latest Python installer from the official Python website.
2. Run the installer. Make sure to check the box that says "Add Python to PATH" during installation.
3. Open Command Prompt and type python --version to verify the installation.

macOS

1. Install Homebrew if you haven't already:

   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
   

2. Install Python using Homebrew:

   brew install python
   

3. Open Terminal and type python3 --version to verify the installation.

Installing the OSRS Wiki Search Tool

Windows

1. Open Command Prompt
2. Install Git if you haven't already:

   winget install --id Git.Git -e --source winget
   

3. Clone the repository:

   git clone https://github.com/gillesdm/OSRS-Drop-Parser.git
   cd OSRS-Drop-Parser
   

4. Create a virtual environment:

   python -m venv venv
   venv\Scripts\activate
   

5. Install the required packages:

   pip install -r requirements.txt
   

macOS

1. Open Terminal
2. Install Git if you haven't already:

   brew install git
   

3. Clone the repository:

   git clone https://github.com/gillesdm/OSRS-Drop-Parser.git
   cd OSRS-Drop-Parser
   

4. Create a virtual environment:

   python3 -m venv venv
   source venv/bin/activate
   

5. Install the required packages:

   pip install -r requirements.txt
   

🛠️ Troubleshooting

Click here for troubleshooting tips

If you encounter any issues during installation:

• Make sure your Python version is 3.7 or higher by running python --version (Windows) or python3 --version (macOS).
• If you get a "command not found" error, make sure Python is added to your system's PATH.
• If you have issues with pip, you may need to upgrade it: python -m pip install --upgrade pip (Windows) or python3 -m pip install --upgrade pip (macOS).

---

🎮 Usage

To run the OSRS Wiki Search Tool, use the following command:

python osrs_scraper/main.py [options]

🛠️ Options

Option	Description
--logs	Enable logging of API responses and parsed data
--txt	Output drop tables as a txt file in addition to JSON
--id	Output only item IDs as a comma-separated list in a txt file (default: True)
--sort	Sort the item IDs from small to large (default: True)
--banklayout	Create a RuneLite bank layout file (default: True)

📚 Examples

Click to see usage examples

1. Search for a specific monster and save drop table in JSON and TXT formats:

   python osrs_scraper/main.py --txt
   

2. Search for a category of monsters and save only item IDs:

   python osrs_scraper/main.py --id
   

3. Create a RuneLite bank layout file for a specific monster:

   python osrs_scraper/main.py --banklayout
   

4. Enable logging for debugging:

   python osrs_scraper/main.py --logs
   

---

📂 Output

The tool will create output files in the osrs_scraper/Output directory. Depending on the options used, you may find:

• 📊 JSON files with full drop table information
• 📝 TXT files with formatted drop tables
• 🔢 TXT files with comma-separated item IDs
• 🏦 TXT files with RuneLite bank layout data

---

🆕 Recent Updates

For a detailed list of changes, please see the CHANGELOG.md file.

Recent highlights include:

• Added a new feature to warn users when their search is redirected to a different name.
• Improved the user interface with a more interactive search type selection.
• Enhanced error handling and user feedback for better user experience.
• Removed dependency on rich-spinner package for simpler installation and usage.

---

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📜 License

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

🙏 Acknowledgments

• OSRS Wiki for providing the API and data
• The OSRS community for their continued support and contributions to the wiki

Happy scaping! 🎉

"Get rich quick with this one weird trick: Use the OSRS Wiki Search Tool!"