Skip to content

Latest commit

 

History

History
178 lines (147 loc) · 4.13 KB

INSTALLATION.md

File metadata and controls

178 lines (147 loc) · 4.13 KB

Installation

System Requirements

Minimum Requirements

  • OS: Windows 10/11 or Linux (Ubuntu 20.04 or newer)
  • CPU: Intel Core i5/AMD Ryzen 5 or better
  • RAM: 8GB
  • Storage: 4GB free disk space
  • Python: 3.9 or newer

Recommended Requirements

  • OS: Windows 11 or Linux (Ubuntu 22.04 or newer)
  • CPU: Intel Core i7/AMD Ryzen 7 or better
  • RAM: 16GB
  • Storage: 8GB free disk space
  • GPU: NVIDIA RTX 2060 6GB or better (with CUDA support)
  • Python: 3.9 or newer

Note: NVIDIA GPU with CUDA support is recommended for optimal performance with AI features, Stable Diffusion, and audio generation.

Installing Dependencies

Python

On Windows:

  1. Open PowerShell.
  2. Install Python: 
    winget install -e --id Python.Python.3.9
  3. Follow the installer instructions.
  4. Ensure Python is accessible: 
    python --version

On GNU/Linux:

  1. Open a terminal.
  2. Install Python: 
    sudo apt-get update -y
sudo apt-get install -y python3
  3. Verify the installation: 
    python3 --version

Git

On Windows:

  1. Open PowerShell.
  2. Install Git: 
    winget install -e --id Git.Git
  3. Verify Git installation: 
    git --version

On GNU/Linux:

  1. Open a terminal.
  2. Install Git: 
    sudo apt-get update -y
sudo apt-get install -y git
  3. Verify Git installation: 
    git --version

Setting up the Project

  1. Clone or fork the repository: 
    git clone https://github.com/Axlfc/RuneScript.git
    If you forked the repository: 
    git clone https://github.com/your_git_username/RuneScript.git
  2. Navigate to the project directory: 
    cd ScriptsEditor
  3. Create a virtual environment:
    • On Windows: 
      python -m venv .venv
    • On macOS and Linux: 
      python3 -m venv .venv
  4. Activate the virtual environment:
    • On Windows: 
      .\.venv\Scripts\activate
    • On macOS and Linux: 
      source .venv/bin/activate
  5. Install the required dependencies:
    • On Windows: 
      .\venv\Scripts\pip install -r requirements.txt
.\venv\Scripts\pip install -r src/models/requirements.txt
    • On macOS and Linux: 
      venv/bin/pip install -r requirements.txt
venv/bin/pip install -r src/models/requirements.txt

Setting up Models

Accessing Models on Hugging Face (TO-DO)

To use the stable-audio-open-1.0 model for audio generation in RuneScript:

  1. Create a Hugging Face Account:

  2. Request Access to the Model:

  3. Generate an API Token:

    • Generate an API token in your Hugging Face profile settings.

  4. Download the Model Files:

  5. Organize Models in the Repository:

    mkdir -p src/models/model/text
mkdir -p src/models/model/image
mkdir -p src/models/model/audio
    • Place .gguf files in src/models/model/text.
    • Place Stable Diffusion models in src/models/model/image.
    • Place Stable Audio models in src/models/model/audio.

Running RuneScript

Setting up the AI Assistant

  1. Place a valid .gguf file in src/models/model/text.
  2. Start the AI assistant server: 
    .\.venv\Scripts\python.exe -m llama_cpp.server --port 8004 --model .\src\models\model\qwen2.5-coder-1.5b-q8_0.gguf

Run RuneScript

  • On Windows: 
    .\.venv\Scripts\python main.py
  • On macOS and Linux: 
    .venv/bin/python main.py