diff --git a/README.md b/README.md index 45b4c1f..557f4f5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,43 @@ -# lua-runes -Rune System for World of Warcraft - Wrath of the Lich King +# Runes System +## Overview + +This interface is designed to empower administrators in implementing the Rune system available in Classic: Season of Discovery. Currently, it serves as a "visual" addon with the ultimate goal of introducing several key features to make the system fully functional. + +## Preview +![image](https://github.com/vaiocti/lua-runes/assets/125808072/96d771bf-e76f-4fc7-bd89-32076f27a2b4) + +## Features to Implement +1. New Crafting Profession: Rune Crafting + - Introduce a new crafting profession specifically for crafting runes. +2. Attach Runes to Equipment + - Implement the ability to attach crafted runes to different pieces of equipment. +3. Learn Runes + - Develop functionality to allow players to learn runes, possibly through specific in-game activities or items. +4. Rune Spells + - Establish the creation of rune spells, enabling the activation of rune effects on equipment. +5. Send Learned Runes to Interface + - Implement a system that allows players to send their learned runes to the interface for management. + +## Additional Tasks +- Research Season of Discovery Rune System + - Conduct in-depth research on the Season of Discovery and its existing rune system to ensure alignment with the intended features. +- User Feedback Integration + - Consider mechanisms for collecting and integrating user feedback to improve the rune system over time. +- Documentation + - Create comprehensive documentation for administrators and users, detailing the installation process, features, and troubleshooting. +- Testing and Debugging + - Conduct thorough testing to identify and address any bugs, glitches, or compatibility issues. +- Integration with Game Economy + - Explore the integration of the rune system with the in-game economy, ensuring a balanced and immersive experience. +- Security Measures + - Implement security measures to protect the integrity of the rune system, preventing potential exploits or abuses. +- Localization Support + - Provide support for multiple languages to enhance accessibility for a diverse player base. + +## Contribution Guidelines +We welcome contributions from the community to enhance and expand the functionality of the Rune System. + +## Reporting Issues +If you encounter any issues or have suggestions for improvement, please open an issue in the issue tracker. + +Thank you for your interest and contributions to making the Rune System for World of Warcraft - Wrath of the Lich King a robust and engaging addition to the game!