{"id":30842688,"url":"https://github.com/wethink25/we-friends","last_synced_at":"2025-09-06T21:02:43.038Z","repository":{"id":310934912,"uuid":"1041767694","full_name":"WeThink25/We-Friends","owner":"WeThink25","description":"A comprehensive friend and party management system for Minecraft servers with cross-server support, built for Paper/Spigot and Folia.","archived":false,"fork":false,"pushed_at":"2025-08-23T04:18:02.000Z","size":76,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-24T06:41:27.701Z","etag":null,"topics":["best","builtbybit","cross-server","folia","free","friends","minecraft","minecraft-plugin","modrinth","paper","papermc","plugin","spigotmc"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WeThink25.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-21T01:32:36.000Z","updated_at":"2025-08-23T04:18:05.000Z","dependencies_parsed_at":"2025-08-24T07:44:15.703Z","dependency_job_id":"757f6c19-ee6d-4465-84d7-7521cd20b759","html_url":"https://github.com/WeThink25/We-Friends","commit_stats":null,"previous_names":["wethink25/we-freinds","wethink25/we-friends"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/WeThink25/We-Friends","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WeThink25%2FWe-Friends","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WeThink25%2FWe-Friends/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WeThink25%2FWe-Friends/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WeThink25%2FWe-Friends/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WeThink25","download_url":"https://codeload.github.com/WeThink25/We-Friends/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WeThink25%2FWe-Friends/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273962583,"owners_count":25198602,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-06T02:00:13.247Z","response_time":2576,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["best","builtbybit","cross-server","folia","free","friends","minecraft","minecraft-plugin","modrinth","paper","papermc","plugin","spigotmc"],"created_at":"2025-09-06T21:02:41.076Z","updated_at":"2025-09-06T21:02:43.029Z","avatar_url":"https://github.com/WeThink25.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# We-Friends\r\n\r\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\r\n[![Java](https://img.shields.io/badge/Java-17+-orange.svg)](https://www.oracle.com/java/)\r\n[![Paper](https://img.shields.io/badge/Paper-1.21.1+-blue.svg)](https://papermc.io/)\r\n[![Folia](https://img.shields.io/badge/Folia-Supported-green.svg)](https://github.com/PaperMC/Folia)\r\n\r\nA comprehensive friend and party management system for Minecraft servers with cross-server support, built for Paper/Spigot and Folia.\r\n\r\n## ✨ Features\r\n\r\n### 🤝 Friend System\r\n- **Friend Requests**: Send, accept, and deny friend requests\r\n- **Friend List**: View online/offline friends with status indicators\r\n- **Friend Chat**: Private messaging and group chat with friends\r\n- **Join/Quit Notifications**: Get notified when friends join or leave\r\n- **Request Toggle**: Enable/disable receiving friend requests\r\n- **Cross-Server Support**: Friends can interact across multiple servers\r\n\r\n### 🎉 Party System\r\n- **Party Creation**: Create and manage parties with friends\r\n- **Party Invites**: Invite friends to join your party\r\n- **Party Chat**: Dedicated party chat channel\r\n- **Party Roles**: Leader and member roles with permissions\r\n- **Party Management**: Kick, promote, transfer leadership, and disband\r\n- **Cross-Server Parties**: Party members can be on different servers\r\n\r\n### 🌐 Cross-Server Support\r\n- **Multi-Server Network**: Connect multiple servers with Redis\r\n- **Real-time Sync**: Instant notifications across servers\r\n- **Server Identification**: See which server friends/party members are on\r\n- **Seamless Experience**: Chat and interact across the entire network\r\n\r\n### 🔧 Advanced Features\r\n- **Database Support**: SQLite and MySQL support\r\n- **Redis Integration**: For cross-server communication\r\n- **PlaceholderAPI**: Custom placeholders for other plugins\r\n- **Folia Support**: Full compatibility with Folia servers\r\n- **Chat Spy**: Staff can monitor friend/party chats\r\n- **Chat Modes**: Toggle between normal, friend, and party chat\r\n\r\n## 📋 Requirements\r\n\r\n- **Java**: 17 or higher\r\n- **Server Software**: Paper 1.21.1+ or Folia\r\n- **Database**: SQLite (included) or MySQL\r\n- **Redis**: Required for cross-server functionality (optional)\r\n\r\n## 🚀 Installation\r\n\r\n1. **Download** the latest release from [Releases](https://github.com/WeThink25/We-Friends/releases)\r\n2. **Place** the JAR file in your server's `plugins` folder\r\n3. **Start** your server to generate the configuration files\r\n4. **Configure** the plugin (see Configuration section)\r\n5. **Restart** your server\r\n\r\n## ⚙️ Configuration\r\n\r\n### Basic Setup (Single Server)\r\n\r\n```yaml\r\n# config.yml\r\ndatabase:\r\n  type: sqlite # Use SQLite for single server\r\n\r\nserver:\r\n  name: lobby # Your server name\r\n\r\ncross-server:\r\n  enabled: false # Disable for single server\r\n\r\nredis:\r\n  enabled: false # Not needed for single server\r\n```\r\n\r\n### Multi-Server Setup\r\n\r\n```yaml\r\n# config.yml\r\ndatabase:\r\n  type: mysql # Required for multi-server\r\n  mysql:\r\n    host: localhost\r\n    port: 3306\r\n    database: wefriends\r\n    username: root\r\n    password: \"your_password\"\r\n\r\nserver:\r\n  name: lobby # Unique name for each server\r\n\r\ncross-server:\r\n  enabled: true # Enable cross-server features\r\n  sync-interval: 30\r\n  notification-timeout: 5\r\n\r\nredis:\r\n  enabled: true # Required for cross-server\r\n  host: localhost\r\n  port: 6379\r\n  password: \"\"\r\n  channel: wefriends:events\r\n\r\nlimits:\r\n  max-friends: 200\r\n  max-party-size: 8\r\n```\r\n\r\n### Database Setup (MySQL)\r\n\r\n```sql\r\nCREATE DATABASE wefriends;\r\nCREATE USER 'wefriends'@'%' IDENTIFIED BY 'your_password';\r\nGRANT ALL PRIVILEGES ON wefriends.* TO 'wefriends'@'%';\r\nFLUSH PRIVILEGES;\r\n```\r\n\r\n## 🎮 Commands\r\n\r\n### Friend Commands\r\n- `/friend add \u003cplayer\u003e` - Send a friend request\r\n- `/friend accept \u003cplayer\u003e` - Accept a friend request\r\n- `/friend deny \u003cplayer\u003e` - Deny a friend request\r\n- `/friend remove \u003cplayer\u003e` - Remove a friend\r\n- `/friend list` - View your friends list\r\n- `/friend requests` - View pending requests\r\n- `/friend toggle` - Toggle friend requests on/off\r\n- `/fchat \u003cmessage\u003e` - Send a message to all friends\r\n- `/fmsg \u003cfriend\u003e \u003cmessage\u003e` - Send a private message to a friend\r\n\r\n### Party Commands\r\n- `/party create` - Create a new party\r\n- `/party invite \u003cplayer\u003e` - Invite a friend to your party\r\n- `/party accept \u003cplayer\u003e` - Accept a party invite\r\n- `/party deny \u003cplayer\u003e` - Deny a party invite\r\n- `/party leave` - Leave your current party\r\n- `/party kick \u003cplayer\u003e` - Kick a member from the party (leader only)\r\n- `/party promote \u003cplayer\u003e` - Promote a member to leader (leader only)\r\n- `/party transfer \u003cplayer\u003e` - Transfer leadership (leader only)\r\n- `/party disband` - Disband the party (leader only)\r\n- `/pc \u003cmessage\u003e` - Send a message to party members\r\n\r\n### Chat Mode Commands\r\n- `/fchatmode` - Toggle friend chat mode\r\n- `/pchatmode` - Toggle party chat mode\r\n- `/chatmode` - View current chat mode\r\n\r\n### Admin Commands\r\n- `/fchatspy` - Toggle friend chat spy (permission required)\r\n- `/partyspy` - Toggle party chat spy (permission required)\r\n- `/wefriends reload` - Reload the plugin configuration\r\n\r\n## 🔑 Permissions\r\n\r\n### Player Permissions\r\n- `wefriends.friend.use` - Use friend commands\r\n- `wefriends.party.use` - Use party commands\r\n- `wefriends.chat.friend` - Use friend chat\r\n- `wefriends.chat.party` - Use party chat\r\n\r\n### Admin Permissions\r\n- `wefriends.admin` - Access admin commands\r\n- `wefriends.spy.friend` - Spy on friend chats\r\n- `wefriends.spy.party` - Spy on party chats\r\n- `wefriends.reload` - Reload plugin configuration\r\n\r\n## 📊 PlaceholderAPI\r\n\r\nThe plugin provides placeholders for use with PlaceholderAPI:\r\n\r\n- `%wefriends_friends_online%` - Number of online friends\r\n- `%wefriends_friends_total%` - Total number of friends\r\n- `%wefriends_party_size%` - Current party size\r\n- `%wefriends_party_leader%` - Party leader name\r\n- `%wefriends_in_party%` - Whether player is in a party (true/false)\r\n\r\n## 🔧 API Usage\r\n\r\n### Maven Dependency\r\n```xml\r\n\u003cdependency\u003e\r\n    \u003cgroupId\u003eme.wethink\u003c/groupId\u003e\r\n    \u003cartifactId\u003ewefriends\u003c/artifactId\u003e\r\n    \u003cversion\u003e1.0.0\u003c/version\u003e\r\n    \u003cscope\u003eprovided\u003c/scope\u003e\r\n\u003c/dependency\u003e\r\n```\r\n\r\n### Basic API Examples\r\n\r\n```java\r\n// Get the plugin instance\r\nWeFriends plugin = WeFriends.getInstance();\r\n\r\n// Check if two players are friends\r\nboolean areFriends = plugin.getFriendManager().areFriends(player1UUID, player2UUID);\r\n\r\n// Get a player's friends\r\nSet\u003cUUID\u003e friends = plugin.getFriendManager().getFriendUuidsPublic(playerUUID);\r\n\r\n// Get party information\r\nString partyId = plugin.getPartyManager().getPartyIdPublic(playerUUID);\r\nList\u003cUUID\u003e partyMembers = plugin.getPartyManager().getPartyMembers(partyId);\r\n```\r\n\r\n## 🌐 Cross-Server Setup Guide\r\n\r\n### Step 1: Database Configuration\r\nSet up a shared MySQL database accessible by all servers:\r\n\r\n```yaml\r\ndatabase:\r\n  type: mysql\r\n  mysql:\r\n    host: your-database-host\r\n    port: 3306\r\n    database: wefriends_network\r\n    username: wefriends_user\r\n    password: secure_password\r\n```\r\n\r\n### Step 2: Redis Configuration\r\nConfigure Redis for real-time communication:\r\n\r\n```yaml\r\nredis:\r\n  enabled: true\r\n  host: your-redis-host\r\n  port: 6379\r\n  password: redis_password\r\n  channel: wefriends:network\r\n```\r\n\r\n### Step 3: Server Identification\r\nGive each server a unique name:\r\n\r\n```yaml\r\nserver:\r\n  name: lobby    # For lobby server\r\n  name: survival # For survival server\r\n  name: creative # For creative server\r\n```\r\n\r\n### Step 4: Enable Cross-Server Features\r\n```yaml\r\ncross-server:\r\n  enabled: true\r\n  sync-interval: 30\r\n  notification-timeout: 5\r\n```\r\n\r\n## 🐛 Troubleshooting\r\n\r\n### Common Issues\r\n\r\n**Database Connection Failed**\r\n- Verify MySQL credentials and host accessibility\r\n- Check firewall settings\r\n- Ensure database exists and user has proper permissions\r\n\r\n**Redis Connection Failed**\r\n- Verify Redis server is running\r\n- Check Redis host and port configuration\r\n- Verify Redis password if authentication is enabled\r\n\r\n**Cross-Server Not Working**\r\n- Ensure all servers use the same MySQL database\r\n- Verify Redis configuration is identical across servers\r\n- Check that server names are unique\r\n- Confirm `cross-server.enabled` is true\r\n\r\n**Plugin Not Loading**\r\n- Verify Java 17+ is installed\r\n- Check server software compatibility (Paper 1.21.1+)\r\n- Review server logs for error messages\r\n\r\n## 🤝 Contributing\r\n\r\nWe welcome contributions! Please follow these steps:\r\n\r\n1. **Fork** the repository\r\n2. **Create** a feature branch (`git checkout -b feature/amazing-feature`)\r\n3. **Commit** your changes (`git commit -m 'Add amazing feature'`)\r\n4. **Push** to the branch (`git push origin feature/amazing-feature`)\r\n5. **Open** a Pull Request\r\n\r\n### Development Setup\r\n\r\n1. Clone the repository\r\n2. Import into your IDE (IntelliJ IDEA recommended)\r\n3. Run `mvn clean install` to build\r\n4. Test on a Paper 1.21.1+ server\r\n\r\n## 📝 License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## 🙏 Acknowledgments\r\n\r\n- **Paper Team** - For the excellent server software\r\n- **Folia Team** - For multi-threaded server support\r\n- **PlaceholderAPI** - For placeholder integration\r\n- **HikariCP** - For database connection pooling\r\n- **Jedis** - For Redis connectivity\r\n\r\n## 📞 Support\r\n\r\n- **Issues**: [GitHub Issues](https://github.com/WeThink25/We-Friends/issues)\r\n- **Discussions**: [GitHub Discussions](https://github.com/WeThink25/We-Friends/discussions)\r\n\r\n---\r\n\r\nMade with ❤️ by [WeThink](https://github.com/WeThink25)\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwethink25%2Fwe-friends","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwethink25%2Fwe-friends","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwethink25%2Fwe-friends/lists"}