Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme update #208

Merged
merged 4 commits into from
Dec 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Core.lua
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ RLF:SetDefaultModulePrototype({
G_RLF.localeName = addonName .. "Locale"
G_RLF.lsm = LibStub("LibSharedMedia-3.0")
G_RLF.Masque = LibStub and LibStub("Masque", true)
G_RLF.iconGroup = Masque and Masque:Group(addonName)
G_RLF.iconGroup = G_RLF.Masque and G_RLF.Masque:Group(addonName)
local dbName = addonName .. "DB"
local acd = LibStub("AceConfigDialog-3.0")
local TestMode
Expand Down
42 changes: 39 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,44 @@

[![GitHub issue custom search in repo](https://img.shields.io/github/issues-search/McTalian/RPGLootFeed?query=is%3Aissue%20is%3Aopen%20-label%3Ai18n&style=for-the-badge&label=Open%20Tickets)](https://github.com/Mctalian/RPGLootFeed/issues?q=is%3Aissue+is%3Aopen+-label%3Ai18n) [![GitHub issue custom search in repo](https://img.shields.io/github/issues-search/McTalian/RPGLootFeed?query=is%3Aissue%20is%3Aopen%20-label%3Ai18n%20label%3Abug&style=for-the-badge&label=Known%20Bugs&color=red)](https://github.com/Mctalian/RPGLootFeed/issues?q=is%3Aissue+is%3Aopen+-label%3Ai18n+label%3Abug) [![GitHub issue custom search in repo](https://img.shields.io/github/issues-search/McTalian/RPGLootFeed?query=is%3Aissue%20is%3Aopen%20label%3Ai18n%20&style=for-the-badge&label=Locales%20Need%20Translation&color=orange)](https://github.com/Mctalian/RPGLootFeed/issues?q=is%3Aissue+is%3Aopen+label%3Ai18n)

RPGLootFeed is a World of Warcraft addon designed to elevate your looting experience by offering a dynamic and immersive loot feed, reminiscent of what you'd find in popular open-world RPGs.
RPGLootFeed is a World of Warcraft addon designed to declutter your chat and enhance your looting experience by providing a dynamic and immersive loot feed. Keep your chat just for chat and let RPGLootFeed handle the rest.

With RPGLootFeed, all your looted items and currencies are displayed in a sleek, scrolling feed that keeps you informed without cluttering your screen. Whether you're raiding, questing, or farming, RPGLootFeed ensures that you never miss a drop.
As featured in SoulSoBreezy's _11 Useful Addons for Patch 11.0.7_

I highly recommend pairing this with Speedy AutoLoot by Yuyuli ([CurseForge](https://www.curseforge.com/wow/addons/speedyautoloot) [Wago](https://addons.wago.io/addons/speedy-autoloot)) or another addon to speed up looting by not showing the loot frame.
[![Alt text](https://img.youtube.com/vi/GFr01R3TkmE/hqdefault.jpg)](https://youtu.be/GFr01R3TkmE?si=Wgw5F3AtenWdC08U&t=84)

## Features

- **Declutter Your Chat**: Keep your chat window free from loot spam. RPGLootFeed displays all your looted items, currencies, reputation gains, and even profession skill-ups in a sleek, scrolling feed.
- **Contextual Information**: Get detailed information about looted items, currencies, and faction reputation gains. See the item count available to your character, currency cap information, reputation progress, and more at a glance.
- **Integrations**: Seamlessly integrates with popular addons like Auctionator, TradeSkillMaster (TSM) to provide additional contextual information and enhance your looting experience. Or apply your favorite Masque themes to RPGLootFeed so it fits in nicely with your custom UI experience.
- **Customizable**: Tailor the loot feed to your preferences. Choose what information to display and how it should be presented.

## Recommended Addons

Pair RPGLootFeed with Speedy AutoLoot by Yuyuli for an even better looting experience. Speed up looting by not showing the loot frame.

- [Speedy AutoLoot on CurseForge](https://www.curseforge.com/wow/addons/speedyautoloot)
- [Speedy AutoLoot on Wago](https://addons.wago.io/addons/speedy-autoloot)

## Installation

1. Download the latest release from [GitHub](https://github.com/Mctalian/RPGLootFeed/releases/latest) or [CurseForge](https://www.curseforge.com/wow/addons/rpglootfeed).
2. Extract the downloaded file into your World of Warcraft `Interface/AddOns` directory.
3. Restart World of Warcraft and enable RPGLootFeed in the AddOns menu.

## Contributing

We welcome contributions from the community! If you encounter any issues or have suggestions for improvements, please open an issue on [GitHub](https://github.com/Mctalian/RPGLootFeed/issues). Or head over to [Discussions](https://github.com/Mctalian/RPGLootFeed/discussions) if you have any questions or want to show off your UI.

## License

RPGLootFeed is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.

## Screenshots

![Example screenshot of RPGLootFeed with currency, XP, money, Party Loot, highlighted item loot, and reputation](example-feed.png)

![Animation showing loot being added and removed from the feed](RLF_test_mode.gif)

![Example screenshot of RPGLootFeed's loot history feature](example-loot-history.png)
Binary file added RLF_test_mode.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added example-feed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added example-loot-history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading