README

CameraUtils is a PocketMine-MP virion designed to help developers/users use Camera Features.

🔌 Installation

Add CameraUtils to your project via Composer:

composer require ninjaknights/camerautils

🔌 Basic Setup

Before using the API, you must register it in your plugin’s onLoad() or onEnable() method:

<?php

use ninjaknights\CameraUtils\APIRegistry;
use ninjaknights\CameraUtils\preset\PresetRegistry;
use ninjaknights\CameraUtils\CameraPlayer;

class MyPlugin extends PluginBase implements Listener{
	public function onEnable(): void {
		// Register CameraUtils API
		if(!APIRegistry::isRegistered()){
			APIRegistry::register($this);
		}
		// Register default camera presets
		PresetRegistry::registerDefaults();
		// Custom Preset should be registered along side this
		PresetRegistry::registerPreset(new MoviePreset());
		// It should be a class extending ninjaknights\CameraUtils\preset\types\CustomPreset
		// class MoviePreset extends CustomPreset{}
	}

	public function onJoin(PlayerJoinEvent $e): void {
		// Implement a single instance for the player
		// you can still use $a = (new CameraAPI($player))->play();
		// instead of the below one if you want to create temp instances of the class
		CameraPlayer::init($e->getPlayer());
		// You can then do CameraPlayer::get($player)->play();
	}
}

🔧 Usage & Examples

Check out our detailed examples and documentation:

📁 Example Code: See the examples/ folder for practical implementations
📖 Detailed Guide: USAGE.md for comprehensive documentation

📮 Contributing

Found a bug or wish to suggest some changes? Open an issue
Want to contribute? Fork the repository and make a pull request!

💬 Get Help & Connect to Us

📜 License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.

ninjaknights / camerautils

Maintainers

Details