https://github.com/pmmp/pocketmine-c-chunkutils

PHP C extension implementing some chunk conversion methods for PocketMine-MP
https://github.com/pmmp/pocketmine-c-chunkutils

github-actions-enabled minecraft php-extension php8 pocketmine-mp

Last synced: about 23 hours ago
JSON representation

PHP C extension implementing some chunk conversion methods for PocketMine-MP

• Host: GitHub
• URL: https://github.com/pmmp/pocketmine-c-chunkutils
• Owner: pmmp
• License: lgpl-3.0
• Archived: true
• Created: 2017-02-18T16:59:28.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-02-07T13:43:55.000Z (over 3 years ago)
• Last Synced: 2024-09-26T10:00:14.624Z (about 23 hours ago)
• Topics: github-actions-enabled, minecraft, php-extension, php8, pocketmine-mp
• Language: PHP
• Homepage:
• Size: 17.6 KB
• Stars: 21
• Watchers: 6
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PocketMine-C ChunkUtils extension

[![Travis CI build status](https://travis-ci.org/dktapps/PocketMine-C-ChunkUtils.svg?branch=master)](https://travis-ci.org/dktapps/PocketMine-C-ChunkUtils)

[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/t3oeksuqf54a106g?svg=true)](https://ci.appveyor.com/project/dktapps/pocketmine-c-chunkutils)

This extension provides a C implementation of the [ChunkUtils class](https://github.com/pmmp/PocketMine-MP/blob/master/src/pocketmine/level/format/io/ChunkUtils.php) in PocketMine-MP. 

It is intended as a drop-in performance enhancement if the user is using Anvil-formatted worlds (Minecraft PC worlds).

### Why?

The PHP implementations of the chunk data conversion methods are (relatively) extremely slow. This extension provides chunk load time enhancements of up to 10-200x faster per chunk loaded or unloaded.

### Installation

__Requirements__

- PHP >=7.0

- PocketMine-MP 1.6.2dev with API 3.0.0-ALPHA3 or later 

To compile, you'll need to add the source to your ext source folder in your PHP source and compile PHP with the `--enable-pocketmine-chunkutils` option.

No core changes are needed to PocketMine-MP, simply enable the extension and run the server. With Anvil worlds, you should see a vast performance improvement.

#### Windows

Because compiling PHP on Windows isn't most people's bag, you can obtain a DLL for this extension from [AppVeyor](https://ci.appveyor.com/project/dktapps/pocketmine-c-chunkutils). Drop the DLL into the extensions directory for your PHP installation and add `extension=php_pocketmine_chunkutils.dll` to your php.ini.

## FAQ

- I'm using PMAnvil and/or McRegion worlds, will this extension provide a performance boost to those?

No. This extension provides a fast C replacement for a class which is used primarily by the Anvil chunk I/O provider. This extension simply accelerates Anvil chunk conversion to make PC worlds usable.