Yandere AI Girlfriend Simulator (Demo) - API SETUP Tutorial

Welcome and thank you for your interest in our game demo, Yandere AI Girlfriend Simulator! To play the demo, you'll need to use your own OpenAI API key and Azure Speech Service key (although the latter is optional but recommended). 

We apologize for any inconvenience this may cause, but as a small team of two, we've found that allowing you to use your own key and cover your own fee is the most practical approach for now. This way, it allows us to share our experimental findings with you as soon as we develop them.

[Cost for online services] We do not get any revenue from OpenAI or Azure. On the other hand, if you register a brand new account on OpenAI, it should give you $5 free credit to spend for the first 3 months, which can support at least 10+ rounds of play. Same thing on Azure, you can choose Free F0 tier on Azure Speech and get 5 hours free voice generating service each month (I actually never run out of the 5 hours limit yet..). The cost overall should be cheap (I played over 2 hundred rounds during development but OpenAI only charges me $18) But always be aware of the server cost though (you can adjust the spend limit on OpenAI platform as well)!

OPENAI API

OpenAI/ChatGPT is the core technology that allows us to create real-time dialogues, unique reactions, and endless solutions in the game.  So you have to use it to get the immersive experience.

To set up the OpenAI API key for the game, follow these steps:

1. Go to https://platform.openai.com/account/api-keys,  sign up or login. 
2. Create your secret key and copy it.
3. Paste the key into the designated space for the OpenAI API key in the game.
4. Add a payment method. BE AWARE OF THE USAGE AND FEES.
5. Quit and restart the game

BE WARNED! OpenAI is a pay as you go service. so make sure to read and understand their terms and pricing before committing.

If you have any issues setting up the account, refer to the OpenAI website for solutions.

If you experience any issues, here are some common causes and solutions:

• If the game keeps showing "thinking" it could indicate a connection issue or an issue with your OpenAI account. 
• Your 3-month free trial may have expired.
• You may not have a payment method set up. Remember, OpenAI is a paid service.
• Check if your key is still working. OpenAI may revoke it if they find it's been leaked publicly.
• Check your WiFi or VPN.
• It's possible that OpenAI is down  (don’t remember happened before, ChatGPT did)
• Some people mentioned that you have to use Gmail to login, but we logged in with Microsoft account and it worked just fine. 

Azure Speech Services API

This service is used for the text-to-speech function in the game. Which means, it’s optional, without it, you won’t be able to hear the voice. But we highly recommend using it, because we specially picked and tuned the voice, and it greatly enhances the experience. 

To set up the Azure Speech Services API key for the game, follow these steps:

1. Sign in or start free to Microsoft Azure (https://azure.microsoft.com/en-us/products/cognitive-services/text-to-speech/#overview) 
2. Search “speech services”
3. Click “Create speech service”.  If you have already created something before, there won't be this button, and I'm sure you'll be able to figure out the rest. 
4. Fill out the required information according to the guidance, and make sure you select "Free F0" for the pricing tier
5. Review and create
6. Wait until the deployment is done
7. Go to resources and find the key and region name. Copy and paste them into the corresponding blanks in the game.
8. You might need to quit and restart the game

BE WARNED! Azure is also a pay as you go service. Make sure to read and understand their terms and pricing before committing.

However, you likely won't use Azure as frequently as OpenAI, as it only runs when generating speech. During our development process, we were pleasantly surprised to find that we haven't exceeded the free limit yet.

But read the terms and pricing carefully and check the usage as you check your credit card.

Troubleshoot:

While we haven't heard of many issues with setting up Azure API, please let us know if you run into any trouble and we'll do our best to look into it.

FUTURE PLAN

We're aware that setting up the API keys can be a hassle, and we're actively seeking solutions to eliminate that pain for you. We're also dedicated to fixing any bugs (yeah we noticed that embrassed typo) and improving the overall user experience. Other than those, we're planning on adding  more features, stories, and even new mechanisms powered by ChatGPT. 

If you have any feedback or ideas you'd like to share with us, please don't hesitate to leave a comment, send us an email (vivyhasadream@gmail.com) (with [YAGS] in the subject). Our team will try to respond more. We developed this game in less than one month and there's a long way to go, we appreciate your support and can't wait to see what the future holds.

Thanks for staying with us forever and ever journey. Until next time, stay safe, and remember to keep your yandere tendencies in check (just kidding... or are we?).