How to play AIDungeon on Windows

NOTE: This guide is now obsolete thanks to https://pastebin.com/UMUV0KTw and will only be kept up for archiving purposes.

Requirements:
For running it on CPU: A CPU that supports AVX instructions and at the very least 8GB of RAM, 16GB is recommended.
For running it on GPU: An Nvidia GPU with at least 12GB of VRAM, 24GB recommended, though some people report it working on 11GB 1080Ti cards.

Warning! The "install.sh" file is not used in this guide as it does not work on Windows.

1. Download Git from https://git-scm.com/downloads (click Windows).
2. Run the Git installer, keep the settings default.
3. Run Git Bash (a shortcut should've appeared on your desktop).
4. Copy and paste "git clone https://github.com/AIDungeon/AIDungeon/" without quotes into Git Bash. It will clone the Git of AIDungeon 2 and will put it at "C:/Users/YourUsername/AIDungeon". Advanced users can move this folder somewhere else, but make sure that you remember to navigate to this folder when required.
5. Download Python 3.6.8 (other versions might not work properly) https://www.python.org/downloads/windows/
6. Run the Python installer. Click "Customize", then "Next" and make sure that "Add Python to environment variables" is checked.
7. After that, open Command Prompt. To do that, either open Search and type in cmd (Windows 10) or press Win+R on your keyboard and type in cmd in the Run prompt (all Windows).
8. It should default to your user folder like "C:/Users/YourUsername/". Type in "cd AIDungeon". It should take you to the next folder.
9. Type in "python -m pip install -U pip". When it's done updating, type "pip install -r requirements.txt". All requirements for AIDungeon should now be installed.
10. Download the model with a torrent client. After downloading the .zip, extract the .torrent file in it and open it with you torrent client of choice (Google it if you don't have one). The torrent can be found here: https://github.com/AIDungeon/AIDungeon/files/3935881/model_v5.torrent.zip
11. Once the download is finished, go to where the model was downloaded and copy the entire model_v5 folder. Put it in your "AIDungeon\generator\gpt2\models" folder.
12. If you don't have the Command Prompt open anymore, open it again as per Step 7. To play the game, type in "cd AIDungeon", then "python play.py". Optionally, download https://drive.google.com/open?id=1Y2H8PNJnIG2Qi6L4auAEHBckQsWrdFv3 and put it in your AIDungeon folder. Then create a shortcut for it on your desktop for easy access.
13. It should be working after that. Give it some time to load and enjoy!

Optional: Install the mod by u/Mightyalex200 and @anon4. It includes hang detection, custom prompt is final, unrestriced mode, retry command and characters from u/Mightyalex200 and also now with local save/load, custom save names and an autosave you can load after a crash.
1. Download the file here https://cdn.discordapp.com/attachments/654059653407178802/655091110414254118/AIDungeonModded1b.zip and extract it's contents into your AIDungeon folder.
2. Open Command Prompt and type in "pip install func_timeout".
3. Once it's done, start the game. Instructions for all the new functions will be shown upon starting a game.

Errors, tips and tricks:
1. "The torrent link takes me to a blank page that says "File not found"!
- Use the alternative link here: https://drive.google.com/open?id=1OqUT-up97CDGMEJ6dEfROvU9gLhhs8tJ
2. "When I try to use any of the Python commands, it says Permission denied!"
- You didn't add Python to the environment tables as per Step 6. This can be fixed by running the Python installer again, clicking "Modify", then "Next", checking that option and clicking "Install".
3. "While trying to install requirements, tensorflow fails to install or tensorflow seems to install, but I get ModuleNotFoundError: No module named 'tensorflow.python.platform'."
- Try one of the other versions of Python listed in Step 5. If you get the second error, put the following line into Command Prompt: "pip install --upgrade --force-reinstall tensorflow==1.15". (Thanks to @Shyvor for this one.)
4. "When I try to run AIDungeon, I get the error UnicodeEncodeError: 'charmap' codec can't encode characters in position 3-5: character maps to <undefined>"
- Run the game in Command Prompt, not Git Bash.
5. "When I try to run AIDungeon, it says that encoder.json is missing!"
- That means the model files are missing, make sure you followed Steps 10 and 11 properly.
6. "When I try to run AIDungeon, I get the error ImportError: DLL load failed: A dynamic link library (DLL) initialization routine failed."
- Your CPU doesn't support AVX instruction sets. The only solution is to upgrade your CPU.
7. "When launching AIDungeon, I get a bunch of errors that tensorflow couldn't find a bunch of DLLs but the game still starts."
- This means your game is running in CPU mode, which is perfectly normal. But, if you're trying to run it in GPU mode, you need to check your CUDA installation. The tensorflow version used here only supports CUDA 10.0.
8. "While playing the game, I get either a Dst tensor is not initialized or OOM error."
- The game ran out of memory, which means you played it in GPU mode. To force CPU mode, navigate to where your CUDA bin folder is and delete cudnn64_7.dll.

If you need any more help, ping me @Audixas on the AIDungeon Discord: https://discord.gg/Dg8Vcz6