Easy4Form Documentation

Welcome to the Easy4Form documentation! Easy4Form is a powerful and easy-to-use library for creating forms for Bedrock Edition players in Minecraft servers.

Available Documentation

Main API Documentation (Most Recommended)

✅ Recommended: The main API documentation covers the proxy package that automatically handles compatibility and provides the best user experience.

• Main API Documentation Hub
• Main API Documentation

Version 2 (Recommended for New Projects)

⚠️ Note: While v2 is actively maintained and based on the new Cumulus interface, we recommend using the main proxy package for the best compatibility experience.

• v2 Documentation Hub
• v2 English API Documentation

Version 1 (Deprecated)

⚠️ Deprecated: v1 is based on the old Cumulus interface and is no longer maintained. Use only for legacy projects.

• v1 Documentation Hub
• v1 English API Documentation (Deprecated)

Recommendation

For all new projects, we strongly recommend using the main proxy package instead of directly using v1 or v2 packages. The proxy package:

• Automatically handles compatibility between different Cumulus versions
• Provides the best user experience
• Is actively maintained and updated
• Seamlessly switches between v1 and v2 implementations as needed

Quick Start

Using the Main Proxy Package (Recommended)

import cn.enderrealm.easy4form.api.Easy4FormAPI;

// The proxy automatically selects the best implementation
Easy4FormAPI.sendSimpleForm(player, "Title", "Content", buttons, response -> {
    // Handle response
});

Direct v2 Usage (Advanced)

import cn.enderrealm.easy4form.api.v2.Easy4FormAPI;

// Direct v2 usage for specific new interface features
Easy4FormAPI.sendSimpleForm(player, "Title", "Content", buttons, response -> {
    // Handle response
});

Form Types

Easy4Form supports all three form types available in Bedrock Edition:

1. Simple Forms: A list of buttons that players can click
2. Modal Forms: A dialog with two buttons (Yes/No, Confirm/Cancel, etc.)
3. Custom Forms: Forms with various input elements (text fields, toggles, sliders, dropdowns, etc.)

Language Support

Documentation is available in multiple languages:

• English: Complete API documentation and examples Complete API documentation and examples

Getting Help

If you need help or have questions:

1. Check the appropriate version documentation above
2. Look at the examples provided in each documentation
3. For migration help, see the Migration Guide