1
0
mirror of https://github.com/GeyserMC/PackConverter.git synced 2025-12-19 14:59:21 +00:00

Update README

This commit is contained in:
Aurora
2025-07-28 20:24:54 +01:00
parent 128f5ae372
commit 8c78d009b6

View File

@@ -1,13 +1,32 @@
# PackConverter # PackConverter
[![forthebadge made-with-java](https://forthebadge.com/images/badges/made-with-java.svg)](https://java.com/)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Discord](https://img.shields.io/discord/613163671870242838.svg?color=%237289da&label=discord)](http://discord.geysermc.org/) [![Discord](https://img.shields.io/discord/613163671870242838.svg?color=%237289da&label=discord)](http://discord.geysermc.org/)
[![HitCount](http://hits.dwyl.com/GeyserMC/PackConverter.svg)](http://hits.dwyl.com/GeyserMC/PackConverter)
PackConverter is a library for converting Java Edition resource packs to Bedrock Edition. PackConverter is a library for converting Java Edition resource packs to Bedrock Edition.
This is based on the Node.js module ConvertJavaTextureToBedrockApi by ozelot379. This is based on the Node.js module ConvertJavaTextureToBedrockApi by ozelot379.
**Please note, this project is still a work in progress and should not be used on production. Expect bugs!** **Please note, this project is still a work in progress and should not be used on production. Expect bugs!**
**This project also does not convert custom items fully, it will only convert the textures, not any mappings.**
If you are looking for a project to do so, you can take a look at [Rainbow](https://github.com/GeyserMC/Rainbow/).
## Usage
- Download Thunder, the PackConverter GUI, from the Actions tab on GitHub.
- Double-click on the JAR file to open up the UI, then select your java pack and hit convert!
## CLI Usage
You can also use PackConverter in a CLI, by downloading Thunder (See `Usage`) then running the jar file
with some parameters, an example can be seen below:
```bash
java -jar Thunder.jar nogui --input "C:\path\to\pack.zip"
```
You can also enable debug mode by adding `debug` as an additional argument, this also works for the GUI.
## Compiling
1. Clone the repo to your computer
2. Run gradlew build and locate to bootstrap/build folder.