Installation

Steps

1. Download the Mod and its Dependencies on Curseforge or Modrinth and place the file in mods folder

Curseforge

Modrinth

Mod folder: User/AppData/Roaming/.minecraft/mods

2. Install Natural Voice SAPI Adapter

https://github.com/gexgd0419/NaturalVoiceSAPIAdapter/releases/tag/v0.2

Download the zip file on bottom unpack and install. 

This file adds better voices to the mod. 

3. Setting the OpenAI API Key (Windows)

Get and Generate Your API Key:

• Visit OpenAI and create an account if you don’t already have one.

• Once logged in, go to your API settings and generate an API key.

• Important: OpenAI’s API requires prepaid credits to use. You will need to purchase credits before generating responses:

  • Example costs:

    • GPT-3.5-turbo: $0.002 per 1,000 tokens (affordable for casual use).

    • GPT-4: $0.03–$0.06 per 1,000 tokens (higher quality but more expensive).

  • Estimate your budget: Light use typically costs $5/month, while heavy use may range up to $30/month or more.

  • Responsible Use: Monitor your API usage and spending. OpenAI provides tools to track usage and set limits to avoid exceeding your budget.

Set the Key as an Environment Variable:

1. • Open the Start Menu and search for "Environment Variables."

   • Select "Edit the system environment variables" and click "Environment Variables."

   • Under "User Variables" (or "System Variables" for all users):

     • Click "New" and enter:

       • Variable Name: OPENAI_API_KEY

       • Variable Value: Paste your API key here.

   • Click OK to save.

Restart Your PC:

1. • Restart your computer to ensure the changes take effect.

   • Note: For first-time users, it may take a few minutes for the key to be recognized.

How the API Works:

1. • The mod sends villager input to OpenAI servers, which process it and return a response.

   • OpenAI services require prepaid credits, so you’ll need to purchase credits before usage.

Why It Costs:

1. • OpenAI charges per request based on the chosen model:

     • GPT-3.5-turbo: $0.002 per 1,000 tokens (affordable for casual use).

     • GPT-4: $0.03–$0.06 per 1,000 tokens (for higher-quality responses).

   • Typical costs for casual users are under $5/month, while frequent use may cost $10–$30/month.

With the key set and credits purchased, you’re ready to enjoy immersive villager interactions!