From 36eb5875310acb48176b4694a9d5c9496e38ddd9 Mon Sep 17 00:00:00 2001 From: Emlembow <36314674+Emlembow@users.noreply.github.com> Date: Sun, 15 Sep 2024 16:34:11 -0700 Subject: [PATCH] Added Readme --- readme.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..c6b7bcb --- /dev/null +++ b/readme.md @@ -0,0 +1,38 @@ +# Mining and Herb Radar + +This Lua script creates a radar-like visualization for mining and herb nodes in World of Warcraft. It's designed to work with the Tinkr framework. + +## Support the Developer + +If you find this script helpful, please consider supporting the developer: + +🎁 **[Tip the Developer](https://coindrop.to/okrotations)** 🎁 + +Your support helps maintain and improve this project. Thank you! + +## Features + +- Displays mining and herb nodes as 3D crystal-like structures in the game world +- Customizable node visibility through an in-game settings window +- Option to draw lines from the player to visible nodes +- Distance indicators for each node +- Detailed filters for individual node types + +## Requirements + +- Tinkr framework + +## Usage + +1. Ensure you have Tinkr installed and properly set up. +2. Place the `Radar.lua` file in your Tinkr scripts folder. +3. Load the script through Tinkr. +4. Use the in-game settings window to customize node visibility and other options. + +## Customization + +Users can update the `nodes` table in the script if there are any additional nodes they want to add or modify. Each node entry should follow this format: + +## License + +This project is open-source and available under the MIT License. \ No newline at end of file