bdspackmanager

Name	bdspackmanager JSON
Version	1.1.3 JSON
	download
home_page	https://github.com/DJStompZone/bdspackmanager
Summary	Command-line tool designed for managing resource and behavior packs on a Minecraft Bedrock Dedicated Server (BDS)
upload_time	2024-12-06 01:56:26
maintainer	DJ Stomp
docs_url	None
author	DJ Stomp
requires_python	<4.0,>=3.9
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # BdsPackManager

**BdsPackManager** is a command-line tool designed for managing resource and behavior packs on a Minecraft Bedrock Dedicated Server (BDS). It allows you to easily add, validate, update, and manage packs, ensuring your server is always up-to-date with the latest content.

## Features

- **Add Packs**: Supports adding `.mcpack`, `.mcaddon`, and directories containing valid `manifest.json` files.
- **Automatic Unzipping**: Automatically extracts and processes `.mcpack` and `.mcaddon` files.
- **Validation**: Ensures consistency between the packs listed in your server's configuration files and the actual content in the `resource_packs` and `behavior_packs` directories.
- **Version Updates**: Update the `@minecraft/server` dependency version in `behavior_packs` manifests to ensure compatibility with your server version.
- **Selective Updates**: Use `--update-only` to update versions for packs in a specific folder, including `.mcpack` files.
- **Configurable**: Specify the server directory using command-line arguments, a `.env` file, or `~/.bdspackrc` for a global configuration.
- **Interactive or Automatic**: Prompt for overwrites or use the `--force` flag to skip confirmation and automate updates.

## Installation

1. **Install via pip**:

    ```bash
    pip install bdspackmanager
    ```

2. **Set up your environment**:
    - Optionally, create a `.env` file in your project directory or a `~/.bdspackrc` file for global configuration:

      ```yaml
      BDS_DIRECTORY=/path/to/your/bedrock_server
      ```

    - The tool prioritizes the following configuration sources:
      1. Command-line arguments
      2. Environment variables from `.env` in the project directory
      3. Environment variables from `~/.bdspackrc`

## Usage

### Command-line Arguments

```bash
python -m bdspackmanager [OPTIONS] [PACKS...]
```

#### Options

- `PACKS...`: One or more paths to `.mcpack`, `.mcaddon`, or directories containing a valid `manifest.json`.
- `--bds-dir`: Specify the path to the Bedrock Dedicated Server directory (overrides `.env` and `~/.bdspackrc`).
- `--validate`: Validate and rescan JSON files for consistency with the actual content in the `resource_packs` and `behavior_packs` directories.
- `--update`: Update `@minecraft/server` dependency versions in all `behavior_packs`.
- `--update-only <dir>`: Update `@minecraft/server` dependency versions for packs in the specified folder, including `.mcpack` files.
- `--version <version>`: Specify the target version for `@minecraft/server` when using `--update` or `--update-only`.
- `--force`: Skip confirmation prompts when overwriting existing packs.

### Example Usage

1. **Adding a Pack**:

   ```bash
   python -m bdspackmanager /path/to/your_pack.mcpack 
   ```

2. **Validating Pack Consistency**:

   ```bash
   python -m bdspackmanager --validate 
   ```

3. **Updating All Behavior Packs**:

   ```bash
   python -m bdspackmanager --update --version "1.16.0-beta" 
   ```

4. **Updating Packs in a Specific Folder**:

   ```bash
   python -m bdspackmanager --update-only /path/to/pack_folder --version "1.16.0-beta"
   ```

---

### Global Configuration Support

BdsPackManager supports global configuration through the `~/.bdspackrc` file. This file behaves like `.env` and allows you to set environment variables for the tool. For example:

```bash
BDS_DIRECTORY=/path/to/your/bedrock_server
```

When present, `~/.bdspackrc` is automatically loaded and used as a fallback if a `.env` file is not found in the project directory. You can override these settings with command-line arguments.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/DJStompZone/bdspackmanager",
    "name": "bdspackmanager",
    "maintainer": "DJ Stomp",
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": "85457381+DJStompZone@users.noreply.github.com",
    "keywords": null,
    "author": "DJ Stomp",
    "author_email": "85457381+DJStompZone@users.noreply.github.com",
    "download_url": "https://files.pythonhosted.org/packages/d2/1c/42b89f11f7fe8643bd1bf684188472fa62a58a41db21e81e338362492849/bdspackmanager-1.1.3.tar.gz",
    "platform": null,
    "description": "# BdsPackManager\n\n**BdsPackManager** is a command-line tool designed for managing resource and behavior packs on a Minecraft Bedrock Dedicated Server (BDS). It allows you to easily add, validate, update, and manage packs, ensuring your server is always up-to-date with the latest content.\n\n## Features\n\n- **Add Packs**: Supports adding `.mcpack`, `.mcaddon`, and directories containing valid `manifest.json` files.\n- **Automatic Unzipping**: Automatically extracts and processes `.mcpack` and `.mcaddon` files.\n- **Validation**: Ensures consistency between the packs listed in your server's configuration files and the actual content in the `resource_packs` and `behavior_packs` directories.\n- **Version Updates**: Update the `@minecraft/server` dependency version in `behavior_packs` manifests to ensure compatibility with your server version.\n- **Selective Updates**: Use `--update-only` to update versions for packs in a specific folder, including `.mcpack` files.\n- **Configurable**: Specify the server directory using command-line arguments, a `.env` file, or `~/.bdspackrc` for a global configuration.\n- **Interactive or Automatic**: Prompt for overwrites or use the `--force` flag to skip confirmation and automate updates.\n\n## Installation\n\n1. **Install via pip**:\n\n    ```bash\n    pip install bdspackmanager\n    ```\n\n2. **Set up your environment**:\n    - Optionally, create a `.env` file in your project directory or a `~/.bdspackrc` file for global configuration:\n\n      ```yaml\n      BDS_DIRECTORY=/path/to/your/bedrock_server\n      ```\n\n    - The tool prioritizes the following configuration sources:\n      1. Command-line arguments\n      2. Environment variables from `.env` in the project directory\n      3. Environment variables from `~/.bdspackrc`\n\n## Usage\n\n### Command-line Arguments\n\n```bash\npython -m bdspackmanager [OPTIONS] [PACKS...]\n```\n\n#### Options\n\n- `PACKS...`: One or more paths to `.mcpack`, `.mcaddon`, or directories containing a valid `manifest.json`.\n- `--bds-dir`: Specify the path to the Bedrock Dedicated Server directory (overrides `.env` and `~/.bdspackrc`).\n- `--validate`: Validate and rescan JSON files for consistency with the actual content in the `resource_packs` and `behavior_packs` directories.\n- `--update`: Update `@minecraft/server` dependency versions in all `behavior_packs`.\n- `--update-only <dir>`: Update `@minecraft/server` dependency versions for packs in the specified folder, including `.mcpack` files.\n- `--version <version>`: Specify the target version for `@minecraft/server` when using `--update` or `--update-only`.\n- `--force`: Skip confirmation prompts when overwriting existing packs.\n\n### Example Usage\n\n1. **Adding a Pack**:\n\n   ```bash\n   python -m bdspackmanager /path/to/your_pack.mcpack \n   ```\n\n2. **Validating Pack Consistency**:\n\n   ```bash\n   python -m bdspackmanager --validate \n   ```\n\n3. **Updating All Behavior Packs**:\n\n   ```bash\n   python -m bdspackmanager --update --version \"1.16.0-beta\" \n   ```\n\n4. **Updating Packs in a Specific Folder**:\n\n   ```bash\n   python -m bdspackmanager --update-only /path/to/pack_folder --version \"1.16.0-beta\"\n   ```\n\n---\n\n### Global Configuration Support\n\nBdsPackManager supports global configuration through the `~/.bdspackrc` file. This file behaves like `.env` and allows you to set environment variables for the tool. For example:\n\n```bash\nBDS_DIRECTORY=/path/to/your/bedrock_server\n```\n\nWhen present, `~/.bdspackrc` is automatically loaded and used as a fallback if a `.env` file is not found in the project directory. You can override these settings with command-line arguments.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Command-line tool designed for managing resource and behavior packs on a Minecraft Bedrock Dedicated Server (BDS)",
    "version": "1.1.3",
    "project_urls": {
        "Homepage": "https://github.com/DJStompZone/bdspackmanager",
        "Repository": "https://github.com/DJStompZone/bdspackmanager"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6ad8537fddf251833f8a579ffaa8b6b450180fc261958c440f4018c15a3c6d88",
                "md5": "bd7f21bdace41b34eff7cd06980d0361",
                "sha256": "0c391fe8ff8466e46ddfd57a52cbcd0c483e3359dfa24b7f1399b5a5c4aa1c70"
            },
            "downloads": -1,
            "filename": "bdspackmanager-1.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bd7f21bdace41b34eff7cd06980d0361",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 9658,
            "upload_time": "2024-12-06T01:56:24",
            "upload_time_iso_8601": "2024-12-06T01:56:24.769962Z",
            "url": "https://files.pythonhosted.org/packages/6a/d8/537fddf251833f8a579ffaa8b6b450180fc261958c440f4018c15a3c6d88/bdspackmanager-1.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d21c42b89f11f7fe8643bd1bf684188472fa62a58a41db21e81e338362492849",
                "md5": "246040d02f5ef652960cfae222af6d51",
                "sha256": "0960356b28f6498ce315af6574b8d83d659a6865186c5bed73af5851d773dcdc"
            },
            "downloads": -1,
            "filename": "bdspackmanager-1.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "246040d02f5ef652960cfae222af6d51",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 7344,
            "upload_time": "2024-12-06T01:56:26",
            "upload_time_iso_8601": "2024-12-06T01:56:26.354864Z",
            "url": "https://files.pythonhosted.org/packages/d2/1c/42b89f11f7fe8643bd1bf684188472fa62a58a41db21e81e338362492849/bdspackmanager-1.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-06 01:56:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "DJStompZone",
    "github_project": "bdspackmanager",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "bdspackmanager"
}