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)
- Visit the Latest Release page.
- Download the appropriate version for your operating system.
- Extract the downloaded archive to your preferred location.
Alternative: Download the Source Code
- Click on the green "Code" button on the repository page.
- Select "Download ZIP."
- Extract the ZIP file to your preferred location.
2. Install Dependencies
Option 1: Use the Setup Script (Recommended)
- Run the provided Python setup script:
This script will:python setup.py
- Upgrade
pip
,setuptools
, andwheel
. - Install all required dependencies from
requirements.txt
. - Exit with an error message if any step fails.
- Upgrade
Option 2: Manual Installation
- 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.
- Verify the Python installation by running
python --version
(orpython3 --version
on some systems) in a terminal. - Upgrade
pip
,setuptools
, andwheel
:pip install --upgrade pip setuptools wheel
- Install required Python packages:
pip install -r requirements.txt
3. First Launch
Using the Precompiled Application (WIP)
- Navigate to the extracted folder.
- Run the application:
- Windows: Double-click
MCCommandGen.exe
. - macOS: Open
MCCommandGen.app
. - Linux: Execute
./mccommandgen
in a terminal.
- Windows: Double-click
Running from Source Code
- Open a terminal in the extracted folder.
- Run the following command:
python minecraft_command_generator.py
4. Verify Installation
- The application should launch without errors.
- The main interface should appear.
- Test basic functionality by creating a simple command.
Troubleshooting
If you encounter issues during installation, check the following:
- Ensure Python is installed and the version is correct.
- Verify that your antivirus software is not blocking the application.
- Confirm you have sufficient permissions in the installation directory.
- Ensure all dependencies are installed using
python setup.py
orpip install -r requirements.txt
.
For more help, see the Troubleshooting guide or report an issue.