{"id":19149102,"url":"https://github.com/flytegg/mc-utils","last_synced_at":"2025-04-15T07:07:12.836Z","repository":{"id":170702516,"uuid":"619345321","full_name":"flytegg/mc-utils","owner":"flytegg","description":"Community powered Minecraft utilities for developers, builders and players.","archived":false,"fork":false,"pushed_at":"2025-03-09T23:57:29.000Z","size":304501,"stargazers_count":40,"open_issues_count":91,"forks_count":18,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-15T07:06:49.151Z","etag":null,"topics":["mcutils","minecraft","tool","util","utils"],"latest_commit_sha":null,"homepage":"https://mcutils.com","language":"Svelte","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flytegg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2023-03-27T00:19:51.000Z","updated_at":"2025-04-15T01:42:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"a736397d-08a6-4db6-81c2-cedd6a831ec5","html_url":"https://github.com/flytegg/mc-utils","commit_stats":null,"previous_names":["flytegg/mcu-website","flytegg/mc-utils"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flytegg%2Fmc-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flytegg%2Fmc-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flytegg%2Fmc-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flytegg%2Fmc-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flytegg","download_url":"https://codeload.github.com/flytegg/mc-utils/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249023700,"owners_count":21199958,"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":["mcutils","minecraft","tool","util","utils"],"created_at":"2024-11-09T08:06:30.909Z","updated_at":"2025-04-15T07:07:07.825Z","avatar_url":"https://github.com/flytegg.png","language":"Svelte","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MC Utils\n[MC Utils](https://mcutils.com) is a collection of Minecraft utilities built for developers, builders and players. The site hosts some popular tools like Server Jars, Item IDs, Inventory Slots, Start File Generator and more, all with a slick interface for ease of use.\n\nThe project is powered by the team at [Flyte](https://flyte.gg/) and our generous contributors.\n\nIf you want to support, or chat with the team, come join our Discord:\n\n[![Discord Banner](https://discordapp.com/api/guilds/835561528299880518/widget.png?style=banner2)](https://discord.gg/flyte)\n\n\n## 📝 Contributing\n\n### Prerequisites\n\nYou need to have Node 16 or higher installed.\n\nIf you're using VS Code, it will help to install the following extensions:\n- Svelte for VS Code\n- Svelte Intellisense\n- Svelte Auto Import\n- Tailwind CSS IntelliSense\n\n### Setup\n\nClone the GitHub repository onto your machine and open a command line inside the project.\n\nRun `npm install`.\n\nAnd you're all set!\n\n### Technologies\n\nWe use [SvelteKit](https://kit.svelte.dev/) and [Tailwind](https://tailwindcss.com/).\n\nThis entails some knowledge of:\n- JavaScript/TypeScript\n- Node/NPM\n- SvelteKit's structure\n- Svelte (very simple logic syntax on top of HTML/JS)\n- Some CSS knowledge and the ability to type in Tailwind's search bar\n\n### Our component system\n\n#### Util components\n\nWe've made it easy to add utils to the site by having a dynamic routing system for util components. Refer to [Adding a new util](#adding-a-new-util) to understand how to use it.\n\n#### Reusable elements\n\nWe also have a library of reusable elements that you can use in your utils to allow for a consistent style across the site.\n\nCurrently we only have a Search component and a slightly different way of using buttons, see below for how to use each.\n\nSearch\n```svelte\n\u003cscript\u003e\n    let searchValue: string\n\n    const handleKeyPress = (event: KeyboardEvent) =\u003e {\n        if (event.key === \"Enter\") updateSkin(searchValue)\n    }\n\n    const handleInput = () =\u003e {\n        updateSkin(searchValue)\n    }\n\u003c/script\u003e\n\u003cinput class=\"search\" bind:value={searchValue} type=\"text\" placeholder=\"Enter someone's username\" on:keypress={handleKeyPress} on:blur={handleInput}\u003e\n```\n\nButton\n```svelte\n\u003cbutton class=\"button\"\u003eMy Button\u003c/button\u003e\n```\n\n### Adding a new util\n\nFirstly we should declare our util, we do this by navigating to `src/lib/utils.ts`.\n\nIn here is an array called `utils`, all you have to do is add your util to the list. Below is the schema with a description of each element:\n\n```\npath: The path in the URL, also needs to be the same name as the .svelte component we're about to create.\nname: The name of the util... pretty self explanatory.\ndescription: The description of the util... pretty self explantory.\nshortDescription: ... A shorter version of the description - the one shown in the sidebar.\n```\n\nNext we can add the icon for our util to the `static/component/icon` folder and upload your icon, named the same as the `path`. Make sure it's a `.svg`.\n\nFinally, navigate to the `src/lib/component/util` folder, where you can create your util component, remember this needs to be named the same as `path`.\n\nFrom here you just write your util in Svelte using HTML \u0026 JS/TS.\n\nIf you want to take a look, here's a link to an existing util, [Skin Stealer](https://github.com/flytegg/mc-utils/blob/master/src/lib/component/util/skin-stealer.svelte).\n\n\n## 🖥️ API\n\nMC Utils does a lot of heavy lifting in the backend to power the [Server Jars](https://mcutils.com/server-jars) util. As a service to the community, we are happy to expose endpoints making this technology accessable in your own projects.\n\nThe following endpoints can be used to retrieve information about or serve jars from a range of server platforms and versions. Note that where a version may have multiple builds, we will always serve the latest build.\n\n### Retrieve platforms supported by MC Utils\n`GET` \u003chttps://mcutils.com/api/server-jars\u003e\n\n#### Example Response\n```json\n[\n  {\n    \"key\": \"purpur\",\n    \"name\": \"Purpur\",\n    \"url\": \"https://mcutils.com/api/server-jars/purpur\"\n  },\n  {\n    \"key\": \"paper\",\n    \"name\": \"Paper\",\n    \"url\": \"https://mcutils.com/api/server-jars/paper\"\n  }\n]\n```\n\n### Retrieve all versions for platform\n`GET` \u003chttps://mcutils.com/api/server-jars/:platform\u003e\n\n#### Example Response\n```json\n[\n  {\n    \"version\": \"1.20.4\",\n    \"url\": \"https://mcutils.com/api/server-jars/paper/1.20.4\"\n  },\n  {\n    \"version\": \"1.20.2\",\n    \"url\": \"https://mcutils.com/api/server-jars/paper/1.20.2\"\n  }\n]\n```\n\n### Retrieve details about a version for a platform\n`GET` \u003chttps://mcutils.com/api/server-jars/:platform/:version\u003e\n\n#### Example Response\n```json\n{\n  \"platform\": \"paper\",\n  \"display\": \"Paper\",\n  \"version\": \"1.20.4\",\n  \"release\": \"March 25th 2024\",\n  \"downloadUrl\": \"https://mcutils.com/api/server-jars/paper/1.20.4/download\"\n}\n```\n\n### Download jar for platform \u0026 version\n`GET` \u003chttps://mcutils.com/api/server-jars/:platform/:version/download\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflytegg%2Fmc-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflytegg%2Fmc-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflytegg%2Fmc-utils/lists"}