{"id":13408873,"url":"https://github.com/CloudburstMC/Nukkit","last_synced_at":"2025-03-14T13:32:17.349Z","repository":{"id":36985023,"uuid":"113088414","full_name":"CloudburstMC/Nukkit","owner":"CloudburstMC","description":"Cloudburst Nukkit - Nuclear-Powered Minecraft: Bedrock Edition Server Software","archived":false,"fork":false,"pushed_at":"2024-10-23T21:41:21.000Z","size":29459,"stargazers_count":1216,"open_issues_count":174,"forks_count":420,"subscribers_count":77,"default_branch":"master","last_synced_at":"2024-10-24T10:14:12.084Z","etag":null,"topics":["bedrock","bedrock-edition","bedrock-engine","java","mcbe","mcbe-server","mcpe","mcpe-server","minecraft","minecraft-server","nukkit","pocket-edition"],"latest_commit_sha":null,"homepage":"https://cloudburstmc.org","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/CloudburstMC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","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}},"created_at":"2017-12-04T19:55:58.000Z","updated_at":"2024-10-24T04:04:42.000Z","dependencies_parsed_at":"2023-02-18T23:45:58.572Z","dependency_job_id":"fafc2c22-12aa-4678-93ce-7e1aa14ad952","html_url":"https://github.com/CloudburstMC/Nukkit","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CloudburstMC%2FNukkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CloudburstMC%2FNukkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CloudburstMC%2FNukkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CloudburstMC%2FNukkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CloudburstMC","download_url":"https://codeload.github.com/CloudburstMC/Nukkit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243584530,"owners_count":20314780,"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":["bedrock","bedrock-edition","bedrock-engine","java","mcbe","mcbe-server","mcpe","mcpe-server","minecraft","minecraft-server","nukkit","pocket-edition"],"created_at":"2024-07-30T20:00:56.050Z","updated_at":"2025-03-14T13:32:17.338Z","avatar_url":"https://github.com/CloudburstMC.png","language":"Java","readme":"![nukkit](.github/images/banner.png)\n\nIntroduction\n-------------\n\nNukkit is nuclear-powered server software for Minecraft Bedrock Edition.\nIt has a few key advantages over other server software:\n\n* Written in Java, Nukkit is faster and more stable.\n* Having a friendly structure, it's easy to contribute to Nukkit's development and rewrite plugins from other platforms into Nukkit plugins.\n\nNukkit is under improvement yet, we welcome contributions.\n\nLinks\n--------------------\n\n* __[Forums](https://cloudburstmc.org/forums/)__\n* __[Discord](https://discord.gg/5PzMkyK)__\n* __[Wiki](https://cloudburstmc.org/wiki/nukkit)__\n* __[Download Nukkit](https://dl.opencollab.dev/nukkit)__\n* __[Download Plugins](https://cloudburstmc.org/resources/categories/nukkit-plugins.1/)__\n\nCompile Nukkit\n-------------\n- `git clone https://github.com/CloudburstMC/Nukkit`\n- `cd Nukkit`\n- `./gradlew shadowJar`\n\nThe compiled JAR can be found in the `target/` directory.\n\nNote: You don't need to compile Nukkit yourself if you don't intend to modify the code.\n\nRunning\n-------------\nSimply run `java -jar nukkit-1.0-SNAPSHOT.jar`.\n\nPlugin API\n-------------\nInformation on Nukkit's API can be found at the [wiki](https://nukkitx.com/wiki/nukkit/).\n\nDocker\n-------------\n\nRunning Nukkit in [Docker](https://www.docker.com/) (17.05+ or higher).\n\nBuild image from the source,\n\n```\ndocker build -t nukkit .\n```\n\nRun once to generate the `nukkit-data` volume, default settings, and choose language,\n\n```\ndocker run -it -p 19132:19132/udp -v nukkit-data:/data nukkit\n```\nDocker Compose\n-------------\n\nUse [docker-compose](https://docs.docker.com/compose/overview/) to start server on port `19132` and with `nukkit-data` volume,\n\n```\ndocker-compose up -d\n```\n\nKubernetes \u0026 Helm\n-------------\n\nValidate the chart:\n\n`helm lint charts/nukkit`\n\nDry run and print out rendered YAML:\n\n`helm install --dry-run --debug nukkit charts/nukkit`\n\nInstall the chart:\n\n`helm install nukkit charts/nukkit`\n\nOr, with some different values:\n\n```\nhelm install nukkit \\\n  --set image.tag=\"arm64\" \\\n  --set service.type=\"LoadBalancer\" \\\n    charts/nukkit\n```\n\nOr, the same but with a custom values from a file:\n\n```\nhelm install nukkit \\\n  -f helm-values.local.yaml \\\n    charts/nukkit\n```\n\nUpgrade the chart:\n\n`helm upgrade nukkit charts/nukkit`\n\nTesting after deployment:\n\n`helm test nukkit`\n\nCompletely remove the chart:\n\n`helm uninstall nukkit`\n","funding_links":[],"categories":["Server Software","Java"],"sub_categories":["Velocity"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCloudburstMC%2FNukkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCloudburstMC%2FNukkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCloudburstMC%2FNukkit/lists"}