🌐Need to switch languages? / 多语言文档

🤔What is PowerNukkitX ?

PowerNukkitX is a branch version based on PowerNukkit, developed and maintained by PowerNukkitX, any problems can be submitted to Issue feedback.

Join US:

• Discord
• QQ

What's new in PowerNukkitX? Let's See：

1. Support for 1.20.0 protocol.
2. Support for 384 world height.
3. Support for The Nether world, no need to install additional plugin.
4. Support 3D biomes.
5. Support for vanilla commands and command block.
6. Built-in Terra generator (if you have questions click here to view) .
7. Support for writing plugins using the JavaScript language (development documentation can be found here).
8. Support custom blocks / items / entity (refinement in progress, documentation to be added).
9. Original Entity AI framework, no need to install MobPlugin (under development, Not all creature completed).
10. Todo...

---

🎮 How to use

1.Run from PNX-CLI:

1. Download the PNX-CLI-Jar.zip latest version from release
2. Run java -jar PNX-CLI-0.1.6.jar

you can click here to get more information.

2.Run from command:

PowerNukkitX requires a minimum Java version of 17, please install it yourself and configure the environment variables.

1. Download libs.tar.gz and powernukkitx.jar from release
2. Extract the libs folder in libs.tar.gz to the same path as powernukkitx.jar
3. Run the following command

Windows Version

java -Dfile.encoding=UTF-8 ^
-Djansi.passthrough=true ^
-Dterminal.ansi=true ^
-XX:+UnlockExperimentalVMOptions ^
-XX:+UseG1GC ^
-XX:+UseStringDeduplication ^
-XX:+EnableJVMCI ^
--module-path=.\libs\graal-sdk-23.0.0.jar;.\libs\truffle-api-23.0.0.jar; ^
--add-opens java.base/java.lang=ALL-UNNAMED ^
--add-opens java.base/java.io=ALL-UNNAMED ^
-cp .\powernukkitx.jar;.\libs\* ^
cn.nukkit.Nukkit

Linux Version

java -Dfile.encoding=UTF-8 \
-Djansi.passthrough=true \
-Dterminal.ansi=true \
-XX:+UnlockExperimentalVMOptions \
-XX:+UseG1GC \
-XX:+UseStringDeduplication \
-XX:+EnableJVMCI \
--module-path=./libs/truffle-api-23.0.0.jar:./libs/graal-sdk-23.0.0.jar: \
--add-opens java.base/java.lang=ALL-UNNAMED \
--add-opens java.base/java.io=ALL-UNNAMED \
-cp ./powernukkitx.jar:./libs/* \
cn.nukkit.Nukkit

3.Run from docker image:

https://hub.docker.com/r/coolloong/powernukkitx

---

📌 Statement

PowerNukkitX is a modified and optimized version based on PowerNukkit and Nukkit, fixing its bugs, adding more feature support, such as LiteLoader (WIP) plugin compatibility.

• Please note that PowerNukkitX is not maintained by Cloudburst developers, it relies on the open source community to generate electricity with love. If you encounter any problems when using PowerNukkitX, you should first create an issue in this repository (please also note to read the rules in the Contribution Help Guide).

• We also recommend that you perform regular backups and other operations, and use the plug-ins made for PowerNukkitX and use stable version for deployment.

• Most Cloudburst Nukkit plugins are supported but they may not understand the new blocks and items and the new stuff that you can do with PowerNukkitX.

🧾 About Nukkit

Nukkit is nuclear-powered server software for Minecraft: Pocket Edition. It has a few key advantages over other server software:

• Written in Java, Nukkit is faster and more stable.
• Having a friendly structure, it's easy to contribute to Nukkit's development and rewrite plugins from other platforms into Nukkit plugins.
• Nukkit is under improvement yet, we welcome contributions.

---

🛠 Creating Plugins

• Add PowerNukkitX to your dependencies (it is hosted by Maven Central, so you don't need to specify a custom repository) .

Click here to see full Gradle Example

repositories {
    mavenCentral()
}

dependencies {
    compile group: 'cn.powernukkitx', name: 'powernukkitx', version: '1.20.10-r1'
}

Click here to see full Maven Example

<dependencies>
    <dependency>
        <groupId>cn.powernukkitx</groupId>
        <artifactId>powernukkitx</artifactId>
        <version>1.20.10-r1</version>
    </dependency>
</dependencies>

---

🛠 Build JAR file

• git clone https://github.com/PowerNukkitX/PowerNukkitX
• cd PowerNukkitX
• git submodule update --init
• ./mvnw clean package

• The compiled JAR can be found in the target/ directory.
• Please check how to use the compiled JAR file when you run it.
• To run the jar please see How to use.

🧐 Contributing

Please read the CONTRIBUTING guide before submitting any issue. Issues with insufficient information or in the wrong format will be closed and will not be reviewed.

---

🌐 Links

• 🌐 PowerNukkitX Website
• 👩🏽‍💻 PowernNukkitX Document library
• 💬 PowerNukkitX Discord
• 💾 Download PowerNukkitX Released Build
• 💾 Download PowerNukkitX Snapshot Build
• 🔌 Cloudburst Nukkit Plugins
• 🔌 PowerNukkit Plugins

🎨 Statistics

⭐ Stargazers over time

2019 - 2023 © BlocklyNukkit | PowerNukkitX