If this guide doesn't render properly, or it may be out of date, use the original file (How to Run EsoHype - how_to_run.md)

Want to run EsoHype? Intrigued by the language itself? Feel free to read this guide!

1. Download the GitHub repository as a .zip file, or click here to automatically start downloading. (You can also clone the Git repository instead, both work)
2. Assuming you have the downloaded .zip archive, extract it to a folder.
   • If you have 7-Zip, right click on the downloaded .zip file in File Explorer, and go to 7-Zip > Extract to "esohype\".\".
   • If you have WinRAR, the process is almost the same. Right click on the archive file (.zip) and click "Extract to esohype\" or similar.
3. Open up the newly created folder by your archive manager (7-Zip, WinRAR) which should be named something like "esohype".

If you're on Windows, you can open esohype.exe.

If you ever get this popup, just click "Run Anyway". This is Windows complaining because the executable doesn't have a signed certificate.

EsoHype will then ask for a script path. This is where your script is located. It must be located in the same folder or in a descendant folder for EsoHype to find it.

Note: If your .hyp file is in a descendant folder (a descendant folder where esohype.exe is located), for example, the folder /examples, then for the script path you would just type examples/.hypt;.hyp, for example: examples/fibonacci.hyp.

As of writing this, I'm unfamiliar with how macOS does things, so if the guide isn't that clear, sorry! These steps will primarily go through the Linux route, but it should be similar on macOS. Feel free to contribute and make a pull request.

Unfortunately, EsoHype installation on macOS/Linux is not that straight forward. You're going to need to follow these steps:

1. Make sure you have Lua installed on your system (recommended 5.3+) and added to your PATH environment variables.

   • If you're using macOS, consider Homebrew as an option. Then just type, in a terminal:

   brew update
   brew install lua
   
   
   • If you're using Linux, you can also use Homebrew but you should also consider using your package manager. For example:
     • Ubuntu: sudo apt update && sudo apt install -y lua5.4 liblua5.4-deva5.4-dev
     • Fedora/RedHat: sudo dnf update && sudo dnf install luatall lua
     • Arch Linux: sudo pacman -Syu && sudo pacman -S luan -S lua

2. Navigate to the folder where EsoHype is located and run this command in a terminal: lua esohype.lua or if that doesn't work, lua54 esohype.lua.

3. EsoHype will then ask for a script path. This is where your script is located. It must be located in the same folder or in a descendant folder for EsoHype to find it. Here's an image from Windows that should apply to macOS/Linux:

Note: If your .hyp file is in a descendant folder (a descendant folder where esohype.exe is located), for example, the folder /examples, then for the script path you would just type examples/.hypt;.hyp, for example: examples/fibonacci.hyp.

Not comfortable with the executable provided in the repository? No problem!

I won't write a guide for this, but if you want to, you can use rtc as an option (which the EsoHype executable uses).