{"id":15974636,"url":"https://github.com/gmitch215/socketmc","last_synced_at":"2025-03-26T20:31:45.324Z","repository":{"id":230647142,"uuid":"777551222","full_name":"gmitch215/SocketMC","owner":"gmitch215","description":"🖥️ Communicate directly with Minecraft Clients from the Server","archived":false,"fork":false,"pushed_at":"2024-10-29T12:31:31.000Z","size":11580,"stargazers_count":11,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-29T14:56:45.394Z","etag":null,"topics":["client-to-server","fabric","forge","minecraft","paper","paper-api","spigot","spigot-api"],"latest_commit_sha":null,"homepage":"http://socketmc.gmitch215.xyz/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gmitch215.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},"funding":{"patreon":"gmitch215"}},"created_at":"2024-03-26T04:01:24.000Z","updated_at":"2024-10-29T12:31:32.000Z","dependencies_parsed_at":"2024-03-31T05:25:41.364Z","dependency_job_id":"cbf1158a-4e75-4cd7-ad71-6a28cac5f8be","html_url":"https://github.com/gmitch215/SocketMC","commit_stats":null,"previous_names":["gmitch215/socketmc"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gmitch215%2FSocketMC","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gmitch215%2FSocketMC/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gmitch215%2FSocketMC/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gmitch215%2FSocketMC/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gmitch215","download_url":"https://codeload.github.com/gmitch215/SocketMC/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245731540,"owners_count":20663203,"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","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":["client-to-server","fabric","forge","minecraft","paper","paper-api","spigot","spigot-api"],"created_at":"2024-10-07T21:43:14.225Z","updated_at":"2025-03-26T20:31:40.312Z","avatar_url":"https://github.com/gmitch215.png","language":"Java","readme":"# 🔌 SocketMC\n\n\u003e Minecraft Server-to-Client Direct Communication Library\n\n[Notice](./NOTICE.md) | [License](./LICENSE)\n\n## Background\n\n\"Client-side only\" is a term widely used when advancing in plugin development, where you're limited in interacting with player's own client. The goal of this library\nis to solve this issue: create a mod that can communicate with your plugin. That is exactly what SocketMC does! Send your own instructions to clients using our\nsimple and efficient API.\n\n## ❓ Why?\n\n- **Extensive**: SocketMC provides thorough documentation and examples to help you get started.\n- **Robust**: SocketMC is built with performance and reliability in mind, especially since it is version-dependent.\n- **Transparent**: SocketMC is open-source, meaning you can see how it works and contribute to its development.\n\n# 🚚 Features\n\n- Client Instructions\n  - Draw Shapes\n  - Draw Text\n  - Play Audio\n  - And More!\n- Client Events\n  - Player Type and Click Events\n\n\u003c!-- modrinth_exclude.start --\u003e\n\n## 📥 Installation\n\n[![GitHub branch checks state](https://github.com/gmitch215/SocketMC/actions/workflows/build.yml/badge.svg)](https://github.com/gmitch215/SocketMC/actions/workflows/build.yml)\n![GitHub](https://img.shields.io/github/license/gmitch215/SocketMC)\n![GitHub issues](https://img.shields.io/github/issues/gmitch215/SocketMC)\n\n### Prerequisites\n\nAll players on your server must have the SocketMC mod installed. \nYou can download them from the following locations:\n\n- [Modrinth](https://modrinth.com/mod/socketmc)\n- [Jenkins CI](https://ci.codemc.io/job/gmitch215/job/SocketMC/)\n- [GitHub Releases](https://github.com/gmitch215/SocketMC/releases/latest)\n\n### In your Plugin\n\n![GitHub release (latest by date)](https://img.shields.io/github/v/release/gmitch215/SocketMC)\n[![Static Badge](https://img.shields.io/badge/documentation-javadoc-yellow)](https://socketmc.gmitch215.xyz/)\n[![Static Badge](https://img.shields.io/badge/wiki-github-dgreen)](https://github.com/gmitch215/SocketMC/wiki)\n[![Static Badge](https://img.shields.io/badge/detailed_wiki-gitbook-dgreen)](https://docs.gmitch215.xyz/socketmc/)\n\n\u003cdetails\u003e\n    \u003csummary\u003eMaven\u003c/summary\u003e\n\n```xml\n\u003cproject\u003e\n    \n    \u003c!-- Import CodeMC Repo --\u003e\n    \n    \u003crepositories\u003e\n        \u003crepository\u003e\n            \u003cid\u003ecodemc-releases\u003c/id\u003e\n            \u003curl\u003ehttps://repo.codemc.io/repository/maven-releases/\u003c/url\u003e\n        \u003c/repository\u003e\n    \u003c/repositories\u003e\n    \n    \u003cdependencies\u003e\n        \u003c!-- Include Core Module --\u003e\n        \u003cdependency\u003e\n          \u003cgroupId\u003exyz.gmitch215.socketmc\u003c/groupId\u003e\n          \u003cartifactId\u003esocketmc-core\u003c/artifactId\u003e\n          \u003cversion\u003e[VERSION]\u003c/version\u003e\n        \u003c/dependency\u003e\n        \n        \u003cdependency\u003e\n            \u003cgroupId\u003exyz.gmitch215.socketmc\u003c/groupId\u003e\n            \u003cartifactId\u003esocketmc-spigot\u003c/artifactId\u003e\n            \u003cversion\u003e[VERSION]\u003c/version\u003e\n        \u003c/dependency\u003e\n        \n        \u003c!-- Alternatively, use the Paper Build instead of Spigot --\u003e\n        \u003cdependency\u003e\n            \u003cgroupId\u003exyz.gmitch215.socketmc\u003c/groupId\u003e\n            \u003cartifactId\u003esocketmc-paper\u003c/artifactId\u003e\n            \u003cversion\u003e[VERSION]\u003c/version\u003e\n        \u003c/dependency\u003e\n    \u003c/dependencies\u003e\n    \n\u003c/project\u003e\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n    \u003csummary\u003eGradle (Groovy)\u003c/summary\u003e\n\n```gradle\nrepositories {\n    maven { url 'https://repo.codemc.io/repository/maven-releases/' }\n}\n\ndependencies {\n    // Include Core Module\n    implementation 'xyz.gmitch215.socketmc:socketmc-core:[VERSION]'\n    implementation 'xyz.gmitch215.socketmc:socketmc-spigot:[VERSION]'\n    \n    // Alternatively, use the Paper Build\n    implementation 'xyz.gmitch215.socketmc:socketmc-paper:[VERSION]'\n}\n```\n\u003c/details\u003e\n\n\u003cdetails\u003e\n    \u003csummary\u003eGradle (Kotlin DSL)\u003c/summary\u003e\n\n```kotlin\nrepositories {\n    maven(url = \"https://repo.codemc.io/repository/maven-releases/\")\n}\n\ndependencies {\n    // Include Core Module\n    implementation(\"xyz.gmitch215.socketmc:socketmc-core:[VERSION]\")\n    implementation(\"xyz.gmitch215.socketmc:socketmc-spigot:[VERSION]\")\n    \n    // Alternatively, use the Paper Build\n    implementation(\"xyz.gmitch215.socketmc:socketmc-paper:[VERSION]\")\n}\n```\n\u003c/details\u003e\n\n## 📺 Example\n\n**Java**\n\n```java\nimport xyz.gmitch215.socketmc.spigot.SocketPlayer;\nimport xyz.gmitch215.socketmc.instruction.Instruction;\n\nimport org.bukkit.Bukkit;\nimport org.bukkit.entity.Player;\n\nimport java.time.Duration;\n\npublic class MyPlugin extends JavaPlugin {\n    @Override\n    public void onEnable() {\n        sendInstructions();\n    }\n\n    public void sendInstructions() {\n        Player player = Bukkit.getPlayer(\"gmitch215\");\n        SocketPlayer sp = new SocketPlayer(player);\n\n        // Specify X and Y, Text, and Duration\n        // Pass the plugin instance to the sendInstruction method\n        sp.sendInstruction(Instruction.drawText(100, 100, \"Hello World\", Duration.ofSeconds(5)), this);\n    }\n}\n```\n\n**Kotlin**\n\n```kotlin\nimport xyz.gmitch215.socketmc.spigot.SocketPlayer\nimport xyz.gmitch215.socketmc.instruction.Instruction\n\nimport org.bukkit.Bukkit\nimport org.bukkit.entity.Player\n\nimport java.time.Duration\n\nclass MyPlugin : JavaPlugin() {\n    override fun onEnable() {\n        sendInstructions()\n    }\n\n    fun sendInstructions() {\n        val player: Player = Bukkit.getPlayer(\"gmitch215\")\n        val sp = SocketPlayer(player)\n\n        // Specify X and Y, Text, and Duration\n        // Pass the plugin instance to the sendInstruction method\n        sp.sendInstruction(Instruction.drawText(100, 100, \"Hello World\", Duration.ofSeconds(5)), this)\n    }\n}\n```\n\nOutput:\n\n![Example](.github/demo.gif)\n\n\u003c!-- modrinth_exclude.end --\u003e","funding_links":["https://patreon.com/gmitch215"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgmitch215%2Fsocketmc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgmitch215%2Fsocketmc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgmitch215%2Fsocketmc/lists"}