diff --git a/.github/commit-template.md b/.github/commit-template.md new file mode 100644 index 0000000..596d5c8 --- /dev/null +++ b/.github/commit-template.md @@ -0,0 +1,29 @@ +# Commit Message Format + +[Type]: [Brief description] + +[Optional: Add details, context, or additional information if necessary] + +## Type (Choose one): + +- **Feature**: Adding new functionality. +- **Fix**: Fixing issues, bugs, or errors. +- **Refactor**: Code refactoring without changing its behavior. +- **Docs**: Documentation updates or additions. +- **Style**: Code style/formatting changes (no code change). +- **Test**: Adding or modifying tests. +- **Chore**: Routine tasks, maintenance, or tooling changes. + +## Brief Description: + +[Concise one-line description of the change] + +## Details: + +[Additional context, explanation, or relevant information] + +## Related Issues/Pull Requests: + +- Fixes # [Issue Number] +- Addresses # [Issue Number] +- Related to # [Issue Number] diff --git a/.gitignore b/.gitignore index b63da45..df54656 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ build/ !**/src/test/**/build/ ### IntelliJ IDEA ### +.idea/ .idea/modules.xml .idea/jarRepositories.xml .idea/compiler.xml diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml index 919ce1f..f5cb871 100644 --- a/.idea/codeStyles/Project.xml +++ b/.idea/codeStyles/Project.xml @@ -1,7 +1,13 @@ + + + + \ No newline at end of file diff --git a/.idea/discord.xml b/.idea/discord.xml index 30bab2a..d8e9561 100644 --- a/.idea/discord.xml +++ b/.idea/discord.xml @@ -1,7 +1,7 @@ - \ No newline at end of file diff --git a/README.md b/README.md index 17787f8..9900abc 100644 --- a/README.md +++ b/README.md @@ -1 +1,76 @@ -# Celestial \ No newline at end of file +# Hypixel Celestial Discord Bot + +## Introduction + +The Celestial is a powerful and feature-rich bot designed to enhance the Hypixel Minecraft server experience for Discord communities. Whether you're a player looking to check your stats or a guild leader managing your members, this bot has you covered. + +## Features + +- **Player Stats Lookup**: Get detailed statistics for Hypixel players, including game-specific stats and leaderboards. +- **Guild Lookup**: Get detailed statistics for Hypixel guilds, including member lists and guild-specific leaderboards. +- **Player & Guild Info**: Get information about Hypixel players and guilds, including social media links and recent name history. +- **Skyblock Auction House**: Search the Hypixel Skyblock Auction House for items and get detailed information about them. +- **Skyblock Bazaar**: Get current prices for items in the Hypixel Skyblock Bazaar. +- **Skyblock Collections**: Get information about Hypixel Skyblock collections, including collection rewards and unlockable items. +- **Skyblock Skills**: Get information about Hypixel Skyblock skills, including skill levels and experience. +- **Skyblock Items**: Get information about Hypixel Skyblock items, including item stats and item recipes. +- **Skyblock Dungeons**: Get information about Hypixel Skyblock dungeons, including dungeon floors and dungeon secrets. +- **SkyBlock Elections**: Get information about Hypixel Skyblock elections, including election candidates and election results. +- **Skyblock News**: Get information about Hypixel Skyblock news, including recent updates and patch notes. +- **Lots more SkyBlock stuff**: There's a lot more SkyBlock stuff that this bot can do, but we don't have enough space to list it all here. Try it out for yourself! +- **Hypixel Status**: Get the current status of the Hypixel Minecraft server. +- **Hypixel Player Count**: Get the current player count of the Hypixel Minecraft server. +- **Minecraft Stuff**: Get information about a Player or Server, including player skins and server status and a lot more! +- **Guild Management**: *soonTM* + +## Getting Started + +To add the Hypixel Discord Bot to your server, follow these steps: + +1. [Invite the Bot](https://discord.com/api/oauth2/authorize?client_id=1146578530705084507&permissions=2048&scope=bot%20applications.commands) to your Discord server. +2. Set up the necessary permissions for the bot to function correctly. +3. Use the `/help` command to explore available commands and get started. + +## Usage + +Here are some example commands to get you started: +- soon... +- +## Contributions + +Contributions to this project are welcome! If you have any feature suggestions or encounter bugs, please [submit an issue](https://github.com/PinkCloudStudios/celestial-bot/issues/new/choose). + +## License + +This project is licensed under the [GNU Lesser General Public License](https://github.com/PinkCloudStudios/celestial-bot/blob/main/LICENSE). + +## To-Do + +Here are some planned features and improvements for Celestial: + +- [ ] Implement a user ranking system based on Hypixel achievements. +- [ ] Add support for more Hypixel minigames and features. +- [ ] Create a web-based dashboard for easier bot configuration. +- [ ] Global Stats +- [ ] Guild Management +- [ ] Guild Stats +- [ ] Stats Display +- [ ] Stats Viewer +- [ ] Leaderboards +- [ ] Player Profile +- [ ] Skyblock Stuff +- [ ] Player Status Info +- [ ] Party Helper +- [ ] Minecraft Stuff +- [ ] Fun Discord Stuff +- [ ] Bots Structure +Feel free to [contribute](link_to_contributions_section) to the project by working on any of these tasks or suggesting new ideas. + +## Acknowledgments + +- Special thanks to the Hypixel team for their amazing Minecraft server and API. + +## Contact + +For questions or support related to the Hypixel Discord Bot, you can contact us at [emily@bunni.me]. +