The kit id, the key under publickits in config.yml
name
String
The display name
icon
org.bukkit.Material
The icon shown in menus
getInstance() never returns null, but it cannot promise that PerPlayerKit has finished loading its kits. Call the API from an event handler or a command, not from your own onEnable().
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"PerPlayerKit","description":"Per-player custom PvP kits for Paper and Spigot servers.","colors":{"primary":"#1F4145","light":"#A6C2C2","dark":"#0E1B1E"},"logo":{"light":"https://mintcdn.com/noahross/uxUYLaOLuPWg9ZJH/logo/light.svg?fit=max\u0026auto=format\u0026n=uxUYLaOLuPWg9ZJH\u0026q=85\u0026s=82c3df7a229393dfc123869319eed527","dark":"https://mintcdn.com/noahross/uxUYLaOLuPWg9ZJH/logo/dark.svg?fit=max\u0026auto=format\u0026n=uxUYLaOLuPWg9ZJH\u0026q=85\u0026s=cfee19a7e757aa616724c518deabedfe","href":"https://perplayerkit.com"},"favicon":"https://mintcdn.com/noahross/uxUYLaOLuPWg9ZJH/favicon.png?fit=max\u0026auto=format\u0026n=uxUYLaOLuPWg9ZJH\u0026q=85\u0026s=17efd593f2b5b250bdba77cb21ea0f13","navbar":{"links":[{"href":"https://github.com/rossnoah/PerPlayerKit","type":"github"},{"href":"/downloads","label":"Downloads"}],"primary":{"type":"button","label":"Discord","href":"https://discord.gg/5djuBSKWuV"}},"footer":{"socials":{"github":"https://github.com/rossnoah/PerPlayerKit","discord":"https://discord.gg/5djuBSKWuV","website":"https://perplayerkit.com"},"links":[{"header":"PerPlayerKit","items":[{"label":"Modrinth","href":"https://modrinth.com/plugin/perplayerkit"},{"label":"SpigotMC","href":"https://www.spigotmc.org/resources/perplayerkit.121437"},{"label":"Hangar","href":"https://hangar.papermc.io/noah32/PerPlayerKit"},{"label":"Source code","href":"https://github.com/rossnoah/PerPlayerKit"}]}]},"seo":{"indexing":"all"},"icons":{"library":"fontawesome"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"noahross","hasAudioNarration":false,"actualSubdomain":"noahross","customDomains":["perplayerkit.com"],"gitSource":{"type":"github","owner":"rossnoah","repo":"perplayerkit","deployBranch":"main","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"chroma":{"collectionId":"1fe9f0bf-99eb-42c7-b247-837486445000","liveDeploymentHistoryId":"6a9db31be8f1313d3a24e31e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a9db31be8f1313d3a24e31e"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6a9db31be8f1313d3a24e31e","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"Features","count":7},{"language":"default","tag":"Settings","count":7},{"language":"default","tag":"Start here","count":6},{"language":"default","tag":"Common issues","count":5},{"language":"default","tag":"Managing data","count":4},{"language":"default","tag":"Troubleshooting","count":4},{"language":"default","tag":"For developers","count":3},{"language":"default","tag":"Java API","count":3},{"language":"default","tag":"Commands","count":3},{"language":"default","tag":"config.yml","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api/reference","slug":"/api/reference","pageMetadata":{"title":"PerPlayerKit API reference","sidebarTitle":"Reference","description":"Every method on the PerPlayerKit API singleton, and the fields of PublicKit.","icon":"list","related":[{"Setup":"/api/setup"},{"Example":"/api/example"}],"href":"/api/reference"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Every method on the PerPlayerKit API singleton, and the fields of PublicKit.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table,Tooltip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tooltip)_missingMdxReference(`Tooltip`,true);return _jsxs(_Fragment,{children:[_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`java`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`java`,children:_jsxs(_components.code,{language:`java`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` dev.noah.perplayerkit.API;`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#4EC9B0`},children:`API`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` api`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` API`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`getInstance`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`();`})]}),`\n`]})})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Method`}),_jsx(_components.th,{children:`Returns`}),_jsx(_components.th,{children:`Does`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`API.getInstance()`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`API`})}),_jsxs(_components.td,{children:[`The `,_jsx(Tooltip,{tip:`One shared instance. Every call returns the same object.`,children:`singleton`}),`. Creates it if it does not exist, so it is never `,_jsx(_components.code,{children:`null`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`api.getPublicKits()`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`List\u003cPublicKit>`})}),_jsxs(_components.td,{children:[`A `,_jsx(_components.strong,{children:`copy`}),` of the configured public kits.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`api.loadPublicKit(Player, PublicKit)`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`void`})}),_jsx(_components.td,{children:`Applies a public kit to an online player, silently. No message, no broadcast.`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`publickit`,children:`PublicKit`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Is`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`id`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`String`})}),_jsxs(_components.td,{children:[`The kit id, the key under `,_jsx(_components.code,{children:`publickits`}),` in `,_jsx(_components.code,{children:`config.yml`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`name`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`String`})}),_jsx(_components.td,{children:`The display name`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`icon`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`org.bukkit.Material`})}),_jsx(_components.td,{children:`The icon shown in menus`})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`getInstance()`}),` never returns `,_jsx(_components.code,{children:`null`}),`, but it cannot promise that PerPlayerKit has finished loading its kits. Call the API from an event handler or a command, not from your own `,_jsx(_components.code,{children:`onEnable()`}),`.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"PerPlayerKit API reference","sidebarTitle":"Reference","description":"Every method on the PerPlayerKit API singleton, and the fields of PublicKit.","icon":"list","related":[{"Setup":"/api/setup"},{"Example":"/api/example"}],"href":"/api/reference"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"PublicKit","slug":"publickit","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"noahross","siteName":"PerPlayerKit","title":"PerPlayerKit API reference - PerPlayerKit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-06T05:10:25.674Z","originalFileLocation":"api/reference.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Every method on the PerPlayerKit API singleton, and the fields of PublicKit.\">\u003cmeta data-mint-head name=\"application-name\" content=\"PerPlayerKit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/noahross/ppq7-G-TnSY1lNN5/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/noahross/ppq7-G-TnSY1lNN5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/noahross/ppq7-G-TnSY1lNN5/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/noahross/ppq7-G-TnSY1lNN5/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/noahross/ppq7-G-TnSY1lNN5/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/noahross/ppq7-G-TnSY1lNN5/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/noahross/ppq7-G-TnSY1lNN5/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/noahross/ppq7-G-TnSY1lNN5/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/noahross/ppq7-G-TnSY1lNN5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"PerPlayerKit API reference - PerPlayerKit\">\u003cmeta data-mint-head property=\"og:description\" content=\"Every method on the PerPlayerKit API singleton, and the fields of PublicKit.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PerPlayerKit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://perplayerkit.com/api/reference\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://noahross.mintlify.app/_mintlify/api/og/v2?division=Java+API\u0026amp;title=PerPlayerKit+API+reference\u0026amp;description=Every+method+on+the+PerPlayerKit+API+singleton%2C+and+the+fields+of+PublicKit.\u0026amp;theme=e9482534bdabe377ebffd81c\u0026amp;signature=303eb7f35a5ec64790d09a3942403306a4bc788e8bf0ba390a972657875e0b3d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"PerPlayerKit API reference - PerPlayerKit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Every method on the PerPlayerKit API singleton, and the fields of PublicKit.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://noahross.mintlify.app/_mintlify/api/og/v2?division=Java+API\u0026amp;title=PerPlayerKit+API+reference\u0026amp;description=Every+method+on+the+PerPlayerKit+API+singleton%2C+and+the+fields+of+PublicKit.\u0026amp;theme=e9482534bdabe377ebffd81c\u0026amp;signature=303eb7f35a5ec64790d09a3942403306a4bc788e8bf0ba390a972657875e0b3d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/noahross/ppq7-G-TnSY1lNN5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PerPlayerKit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1F4145\">\u003clink data-mint-head rel=\"canonical\" href=\"https://perplayerkit.com/api/reference\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/reference.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://perplayerkit.com/#organization\",\"name\":\"PerPlayerKit\",\"url\":\"https://perplayerkit.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/noahross/uxUYLaOLuPWg9ZJH/logo/light.svg?fit=max\u0026auto=format\u0026n=uxUYLaOLuPWg9ZJH\u0026q=85\u0026s=82c3df7a229393dfc123869319eed527\"}},{\"@type\":\"WebSite\",\"@id\":\"https://perplayerkit.com#website\",\"name\":\"PerPlayerKit\",\"url\":\"https://perplayerkit.com\",\"publisher\":{\"@id\":\"https://perplayerkit.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://perplayerkit.com/api/reference#webpage\",\"url\":\"https://perplayerkit.com/api/reference\",\"name\":\"PerPlayerKit API reference\",\"description\":\"Every method on the PerPlayerKit API singleton, and the fields of PublicKit.\",\"dateModified\":\"2026-09-06T05:10:25.674Z\",\"isPartOf\":{\"@id\":\"https://perplayerkit.com#website\"},\"breadcrumb\":{\"@id\":\"https://perplayerkit.com/api/reference#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://perplayerkit.com/api/reference#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"For developers\",\"item\":\"https://perplayerkit.com/api/setup\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Java API\",\"item\":\"https://perplayerkit.com/api\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"PerPlayerKit API reference\",\"item\":\"https://perplayerkit.com/api/reference\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://perplayerkit.com/api/reference#article\",\"headline\":\"PerPlayerKit API reference\",\"name\":\"PerPlayerKit API reference\",\"description\":\"Every method on the PerPlayerKit API singleton, and the fields of PublicKit.\",\"url\":\"https://perplayerkit.com/api/reference\",\"mainEntityOfPage\":{\"@id\":\"https://perplayerkit.com/api/reference#webpage\"},\"dateModified\":\"2026-09-06T05:10:25.674Z\",\"publisher\":{\"@id\":\"https://perplayerkit.com/#organization\"},\"isPartOf\":{\"@id\":\"https://perplayerkit.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PerPlayerKit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"PerPlayerKit","nav":{"global":null,"groups":[{"group":"Start here","icon":"rocket","pages":[{"title":"PerPlayerKit","sidebarTitle":"What is PerPlayerKit?","icon":"house","href":"/introduction"},{"title":"Download PerPlayerKit","sidebarTitle":"Downloads","icon":"download","href":"/downloads"},{"title":"Install PerPlayerKit","sidebarTitle":"Install it","icon":"download","href":"/installation"},{"title":"Upgrading to 1.8","sidebarTitle":"Upgrading","icon":"arrow-up","href":"/upgrading"},{"title":"Set up your kit room","sidebarTitle":"Set up your kit room","icon":"warehouse","href":"/kit-room"},{"title":"Give out permissions","sidebarTitle":"Give out permissions","icon":"key","href":"/permissions-setup"}]},{"group":"Features","icon":"layer-group","pages":[{"group":"Kits","icon":"backpack","root":{"title":"Kits and enderchest kits","sidebarTitle":"Kits \u0026 enderchest kits","icon":"backpack","href":"/features/kits"},"expanded":false,"pages":[{"title":"Kit slots","sidebarTitle":"Kit slots","icon":"layer-group","href":"/features/kit-slots"}]},{"title":"Sharing kits and moving accounts","sidebarTitle":"Sharing \u0026 transfers","icon":"share-nodes","href":"/features/sharing"},{"title":"Public kits","sidebarTitle":"Public kits","icon":"globe","href":"/features/public-kits"},{"group":"Automatic rekit","icon":"rotate","root":{"title":"Automatic rekit","sidebarTitle":"Automatic rekit","icon":"rotate","href":"/features/rekit"},"expanded":false,"pages":[{"title":"Rekit on respawn","sidebarTitle":"On respawn","icon":"heart-pulse","href":"/features/rekit-respawn"},{"title":"Rekit on kill","sidebarTitle":"On kill","icon":"skull","href":"/features/rekit-kill"}]},{"title":"Regear","sidebarTitle":"Regear","icon":"arrows-rotate","href":"/features/regear"},{"title":"Item filtering","sidebarTitle":"Item filtering","icon":"shield","href":"/features/anti-exploit"}]},{"group":"Commands","icon":"terminal","pages":[{"title":"Player commands","sidebarTitle":"For players","icon":"terminal","href":"/commands/players"},{"title":"Staff and admin commands","sidebarTitle":"For staff \u0026 admins","icon":"user-shield","href":"/commands/admin"},{"title":"Permission list","sidebarTitle":"Permission list","icon":"list","href":"/commands/permissions"}]},{"group":"Settings","icon":"sliders","pages":[{"group":"config.yml","icon":"file-code","root":{"title":"config.yml reference","sidebarTitle":"config.yml reference","icon":"sliders","href":"/settings/config-reference"},"expanded":false,"pages":[{"title":"Kit room and public kits in config.yml","sidebarTitle":"Kit room \u0026 public kits","icon":"warehouse","href":"/settings/config-kitroom"},{"title":"Interface, sounds and join messages in config.yml","sidebarTitle":"Interface \u0026 sounds","icon":"palette","href":"/settings/config-interface"},{"title":"Load effects and other settings","sidebarTitle":"Load effects","icon":"toggle-on","href":"/settings/config-features"}]},{"title":"Worlds and regions","sidebarTitle":"Worlds and regions","icon":"map-location-dot","href":"/settings/locations"},{"group":"Storage","icon":"database","root":{"title":"Storage and databases","sidebarTitle":"Storage \u0026 databases","icon":"database","href":"/settings/storage"},"expanded":false,"pages":[{"title":"Storage connection settings","sidebarTitle":"Connection settings","icon":"plug","href":"/settings/storage-reference"}]},{"group":"Messages","icon":"message","root":{"title":"Messages and broadcasts","sidebarTitle":"Messages \u0026 broadcasts","icon":"message","href":"/settings/messages"},"expanded":false,"pages":[{"title":"MiniMessage formatting","sidebarTitle":"Formatting","icon":"palette","href":"/settings/formatting"}]},{"title":"Languages","sidebarTitle":"Languages","icon":"language","href":"/settings/languages"}]},{"group":"Managing data","icon":"box-archive","pages":[{"title":"Backups","sidebarTitle":"Backups","icon":"clock-rotate-left","href":"/data/backups"},{"title":"Export and import kit data","sidebarTitle":"Export \u0026 import","icon":"file-export","href":"/data/export-import"},{"title":"Change database","sidebarTitle":"Change database","icon":"right-left","href":"/data/storage-migration"},{"title":"Remove an item from every kit","sidebarTitle":"Remove a banned item","icon":"trash","href":"/data/purge-items"}]},{"group":"Common issues","icon":"circle-question","pages":[{"group":"Troubleshooting","icon":"wrench","root":{"title":"Troubleshooting","sidebarTitle":"Troubleshooting","icon":"wrench","href":"/help/troubleshooting"},"expanded":false,"pages":[{"title":"Startup and database problems","sidebarTitle":"Startup \u0026 database","icon":"triangle-exclamation","href":"/help/startup"},{"title":"Permission problems","sidebarTitle":"Permissions","icon":"key","href":"/help/permissions"},{"title":"Kit and kit room problems","sidebarTitle":"Kits \u0026 kit room","icon":"warehouse","href":"/help/kits"},{"title":"Features not working","sidebarTitle":"Features not working","icon":"toggle-off","href":"/help/features"}]},{"title":"Frequently asked questions","sidebarTitle":"FAQ","icon":"circle-question","href":"/help/faq"}]},{"group":"For developers","icon":"code","pages":[{"group":"Java API","icon":"code","root":{"title":"Java API","sidebarTitle":"Java API","icon":"code","href":"/api"},"expanded":false,"pages":[{"title":"Add PerPlayerKit as a dependency","sidebarTitle":"Setup","description":"Add the PerPlayerKit jar to your project and declare it in plugin.yml so Paper loads it first.","icon":"wrench","href":"/api/setup"},{"title":"PerPlayerKit API reference","sidebarTitle":"Reference","icon":"list","href":"/api/reference"},{"title":"PerPlayerKit API example","sidebarTitle":"Example","description":"A working Paper plugin that loads a public kit for a player, and how to select a kit by id.","icon":"play","href":"/api/example"}]}]}]},"title":"PerPlayerKit API reference - PerPlayerKit","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":[],"chunks":[]}