Skip to content

Using the Releases (I just want to play around!)

Jump to bottom
teddybear082 edited this page Jun 17, 2023 · 4 revisions

Using the Releases

Quick Start PCVR

Download the release marked PCVR. Unzip somewhere, keeping the files in a folder (don't unzip them to loose files - the folder is only single-zipped).

The PCVR release is pre-configured so that if you are on Windows, it will just use locally running software instead of using any paid for API keys. It uses Whisper.cpp running locally on your computer for speech to text recognition, a GPT-4-all model for AI response generation, and Godot's local text to speech created in Godot 4. Note that you need to have English text to speech installed on your computer to use this. Other options for all of these steps can be found in the ADVANCED USE OPTIONS Wiki page.

Download LLM for PCVR version to work

The **one step **you have to take for quick start of the Windows PCVR version to work is to download the "llm" - "large language model" used for the AI responses, since that it too big to put in a Github repo. The release is pre-configured to use the GPT4all "Groovy" model, which is licensed for commercial and non-commercial use. You can download it directly from gpt4all here: Groovy and it is 3-4 gb. You can read more about the gpt4all open source project on their website here: GPT4All Website. Once you download that model, put it in the same directory as the godot4ai-npc.exe you downloaded from the PCVR release.

Edit Config File and Run Godot Exe with PCVR Headset Running

Open the ai_npc_api_keys.cfg file in a text editor. If you don't want to use any paid services, then set the following variables in the config file:

[ai_npc_options]

ai_npc_controller_tts_choice=0
ai_npc_controller_ai_brain_choice=2
ai_npc_controller_stt_choice=3

This will use a local whisper install for speech to text, GPT4all as mentioned above for AI, and your windows native text to speech.

Then just run godot4-ai-npc.exe with your VR Headset on and connected to VR and everything should run. If you have any issues, post an issue to Github or find me on the Godot discord XR channel.

Instructions are located inside the experience in VR, but basically just point at the NPC, click your trigger to start your microphone, say something, then press trigger again while pointing at the NPC to end your microphone to send your speech to the NPC. You can also walk close to the NPC and press the B/Y button instead to start / stop your mic.

Quick Start Quest

To use the Quest native release, download that release marked for Quest. You will find a apk file and a .cfg file. You will need to take some steps to get up and running, and this will require you to get free API keys.

Steps to get started as easy and free as possible here follow; note that other options for all of these steps can be found in ADVANCED USE OPTIONS wiki page.

  1. Get a free API key from Wit.ai here - Wit.ai . Create an account, click on "new app" and create a title for your App, it can be anything. Your app will then be on the "My apps" list. Click on it. There will now be a sidebar on the left side of the page. Click on "Management" then click on "Settings." Now on the page will appear various items, including the Server Access Token. Copy that Server Access Token somewhere as you will need it below.

  2. Get a free API key and create or use an existing character on Convai.com here - Convai.com. Create an account, go to the "Dashboard". If you want to use a premade character, just click on one of the characters and copy its "Character's ID" as you will need that below. If you want to create your own character, click on "Create a New Character" and follow the fields to create a name, backstory, etc. for your character. Once created, again click on it and copy its "Character's ID" as you will need that below. Then go back to the dashboard, click on your username in the top right corner, and click on "My Profile." There you will see "Your API Key." Unhide it and copy it as you will need that below.

  3. Now open the ai_npc_api_keys.cfg file that came in the Quest release you downloaded from here. Preferably open this in a coding specific file editor like notepad++ but in theory windows' normal notepad editor should work. You're going to be paying attention to the top section called "[api_keys]".

  4. Copy your API keys into the cfg file. Copy your Wit.ai "Server Access Token" into the wit_ai_token = field in between the quote marks. Copy your Convai "Character's ID" into the convai_character_id = field in between the quote marks. Copy your Convai "Your API Key" into the convai_api_key = field in between the quote marks.

  5. Save the config file.

  6. Open SideQuest, and use the "Install APK file from Folder" option, select the .apk from the release and download it to your quest.

  7. Go to unknown sources on your Quest and run the program (should be called "godot4-ai-npc") once. Be sure to say "Yes" to microphone permissions. Then exit out by clicking both of your grab buttons. Right now nothing else will work because the game doesn't have your required API keys loaded up.

  8. Open SideQuest again and click on "Manage files in the Headset." Navigate to android, data, the godot4-ai-npc game file, then to documents. In documents you may already see a ai_npc_api_keys.cfg file. This is the blank one generated by the game. Drag the ai_npc_api_keys.cfg file you created that has your API keys in it into the folder. It will overwrite the old one.

  9. Now run the godot4-ai-npc game from unknown sources again and all should work, you should be talking to your convai character. Instructions are located inside the experience in VR, but basically just point at the NPC, click your trigger to start your microphone, say something, then press trigger again while pointing at the NPC to end your microphone to send your speech to the NPC. You can also walk close to the NPC and press the B/Y button instead to start / stop your mic.

Clone this wiki locally