Installation Guide - ShockerAttack01/MinecraftCommandGenerator GitHub Wiki

Installation Guide

System Requirements

  • Operating System: Windows 10/11, macOS 10.15+ (WIP), or Linux (WIP)
  • Memory: 4GB RAM minimum (8GB recommended for better performance)
  • Processor: Dual-core CPU or better
  • Python Version: Python 3.7+ (ensure it is added to your PATH during installation)
  • Disk Space: At least 500MB of free space for installation
  • Internet Connection: Required for downloading updates and dependencies (future feature)

Installation Steps

1. Download the Application (WIP)

  1. Visit the Latest Release page.
  2. Download the appropriate version for your operating system.
  3. Extract the downloaded archive to your preferred location.

Alternative: Download the Source Code

  1. Click on the green "Code" button on the repository page.
  2. Select "Download ZIP."
  3. Extract the ZIP file to your preferred location.

2. Install Dependencies

Option 1: Use the Setup Script (Recommended)

  1. Run the provided Python setup script:
    python setup.py
    
    This script will:
    • Upgrade pip, setuptools, and wheel.
    • Install all required dependencies from requirements.txt.
    • Exit with an error message if any step fails.

Option 2: Manual Installation

  1. Install Python 3.7+ if not already installed:
    • Download Python.
    • During installation, ensure the "Add Python to PATH" option is checked.
    • Follow the installation instructions for your operating system.
  2. Verify the Python installation by running python --version (or python3 --version on some systems) in a terminal.
  3. Upgrade pip, setuptools, and wheel:
    pip install --upgrade pip setuptools wheel
    
  4. Install required Python packages:
    pip install -r requirements.txt
    

3. First Launch

Using the Precompiled Application (WIP)

  1. Navigate to the extracted folder.
  2. Run the application:
    • Windows: Double-click MCCommandGen.exe.
    • macOS: Open MCCommandGen.app.
    • Linux: Execute ./mccommandgen in a terminal.

Running from Source Code

  1. Open a terminal in the extracted folder.
  2. Run the following command:
    python minecraft_command_generator.py
    

4. Verify Installation

  1. The application should launch without errors.
  2. The main interface should appear.
  3. Test basic functionality by creating a simple command.

Troubleshooting

If you encounter issues during installation, check the following:

  1. Ensure Python is installed and the version is correct.
  2. Verify that your antivirus software is not blocking the application.
  3. Confirm you have sufficient permissions in the installation directory.
  4. Ensure all dependencies are installed using python setup.py or pip install -r requirements.txt.

For more help, see the Troubleshooting guide or report an issue.