Getting Started - ShockerAttack01/MinecraftCommandGenerator GitHub Wiki

Getting Started

Welcome to the Minecraft Command Generator! This guide will help you set up and start using the application.

Prerequisites

  • Python: Version 3.8 or higher
  • Git: Required for cloning the repository
  • Minecraft Java Edition: For testing generated commands

Installation

1. Clone the Repository

git clone https://github.com/ShockerAttack01/MinecraftCommandGenerator.git
cd MinecraftCommandGenerator

2. Create a Virtual Environment

python -m venv venv

3. Activate the Virtual Environment

  • Windows: 
    .\venv\Scripts\activate
  • Linux/Mac: 
    source venv/bin/activate

4. Install Dependencies

pip install -r requirements.txt

Running the Application

1. Start the Application

python minecraftcommandgenerator.py

2. Explore the Interface

  • Command Type Selection: Choose from various command categories.
  • Parameter Input Fields: Enter required and optional parameters.
  • Real-Time Validation: Ensure your command is error-free.
  • Command Preview: View the generated command in real-time.

Basic Usage

Creating Your First Command

  1. Select a command type from the dropdown menu.
  2. Fill in the required parameters.
  3. Watch the command preview update in real-time.
  4. Copy the generated command and paste it into Minecraft.

Using Item Search

  1. Click the item search field.
  2. Type to search for items.
  3. Use categories to filter results.
  4. Select an item from the suggestions.

Command Validation

  • Required fields are marked with *.
  • Invalid inputs are highlighted in red.
  • Hover over fields for help text.
  • Check the command preview for errors.

Common Tasks

Giving Items

  1. Select "Give Command."
  2. Choose a player.
  3. Search for an item.
  4. Set quantity and NBT data.
  5. Copy the command.

Applying Effects

  1. Select "Effect Command."
  2. Choose a player.
  3. Select an effect.
  4. Set duration and amplifier.
  5. Copy the command.

Troubleshooting

Common Issues

  1. Application won't start

    • Ensure Python is installed and the version is correct.
    • Verify the virtual environment is activated.
    • Check that dependencies are installed.

  2. Item search not working

    • Check your internet connection.
    • Verify item data files are intact.
    • Clear the search cache.

  3. Command validation errors

    • Check parameter types and ranges.
    • Verify player names.
    • Ensure item IDs are correct.

Next Steps

Support