iMinecraft

iMinecraft is a Minecraft BDS plugin for modifying features and world generation related content.

Important

The author is in school and may only have a day or two to write and commit code every half month or so!

Install

Usage

Config

OverallConfig

When you run the plugin for the first time, it will generate its corresponding configuration file. The config.json file is the overall configuration for the plugin, adhering to standard JSON format. The default content of config.json is as follows:

{
    "debug": false,
    "enable": true,
    "enable_log": true,
    "format_version": 0,
    "path": {
        "features_config": "config/features.json",
        "overall_config": "config/config.json"
    }
}

Its counterpart is explained as:

{
    // If true, debug mode is enabled.
    "debug": /* 'true' or 'false' */,
    // If true, the plugin is enabled.
    "enable": /* 'true' or 'false' */,
    // If true, plugin logging is enabled.
    "enable_log": /* 'true' or 'false' */,
    // Formatted version number for backward compatibility
    "format_version": /* 'integer' */,
    // Relative path to the accompanying file
    "path": {
        // Relative path to itself.
        "features_config": /* 'string' */,
        // Relative path to the feature configuration file.
        "overall_config": /* 'string' */
    }
}

FeaturesConfig

The features.json file will be used for configuring world generation and related aspects such as terrain features. The default content of features.json is as follows:

{
    "features": {
        "structures": {
            "village": {
                "enable": true,
                "min_town_separation": -1,
                "spawn": true,
                "specified_chunk_position": [],
                "town_spacing": -1
            }
        }
    }
}

Its counterpart is explained as:

{
    // Configuration of feature-related.
    "features": {
        // Configuration of structure-related features.
        "structures": {
            // The configuration of features related to villages.
            "village": {
                // Is this sub-configuration allowed?
                "enable": /* 'true' or 'false' */,
                // The setting of minimum town spacing,
                // with -1 indicating the use of the original default spacing.
                "min_town_separation": /* '-1' or integer */,
                // If set to false, village generation will be disabled.
                "spawn": /* 'true' or 'false' */,
                // Operating configuration at a specific chunk coordinate.
                "specified_chunk_position": [
                    /** Example.
                    {
                        // Whether to generate a village at this coordinate.
                        "spawn": 'true' or 'false',
                        // Is this sub-configuration allowed?
                        "enable": 'true' or 'false',
                        // chunk coordinate.
                        "position": [ 'integer', 'integer' ]
                    }
                    */
                ],
                // The setting of town spacing,
                // with -1 indicating the use of the original default spacing.
                "town_spacing": /* '-1' or integer */
            }
        }
    }
}

Star History

⭐Contributing⭐

Important

You can contribute to the iMinecraft project in the following ways

• ⭐ Add new functionality by pulling request contribution code
• ⭐ Help me modify or optimize documents
• ⭐ Feedback on GitHub Issues for problems, suggestions, etc.
• ⭐ Help us promote iMinecraft and support my development!

Very much looking forward to and welcoming your contribution!

iMinecraft follows the Code of Conduct.

Contributors

This project exists thanks to all the people who contribute.

License

Copyright © 2024 Lovelylavender4, All rights reserved.

This project is licensed under the LGPL-3.0 License - see the COPYING and COPYING.LESSER files for details.