2. Getting Started

This page is meant to guide you to getting started with the script.

What is the script?

• This is a multi instance macro handler for Minecraft Speedrunning in version 1.16.1 on a random seed.
• It was made to make it easier to handle multi instance resetting and the script's OBS integration makes it easier to record your runs.
• The script is definitely difficult to test as there are many many edge cases where bugs might come up. So the best way to support the project is to test it as much as possible and report as many bugs as possible.

What is this written in?

• The script is written in Python3.
• All code in this script tries to follow PEP 8 conventions as much as possible.
• The code was formatted with black.

Why Python3? Its slow!

• Yes, Python3 is slower than other binary compiled languages. There is no going back on that. But it doesn't take away its ability to do things much easier than any other language.
• It was coded in Python3 because it just gives the programmer higher level access and has a lot of libraries that you can work with.
• MultiThreading makes Python3 perform much better though. I expect it to perform much better than AHK, but I might be completely wrong.

What distribution should I use to use this script?

• The script is distribution independent. It doesn't matter what distribution of GNU/Linux you use, as long as you have Python3, you are all good to go.
• Just make sure to follow your distribution's instructions to install the system-wide dependencies (like xdotool and wmctrl).

How do I get the best out of the script?

• The script is mainly tested on a linux-zen kernel.
• It seems to be performance optimized and I don't seem to have any issues with it.
• On the hardware that I run, the script runs usably with two instances.

What inspired me to make this script?

• The fact that a macro existed on Windows and didn't seem to exist at all on Linux.
• There also doesn't seem to be any interpreter to convert AHK calls on Windows to Linux (though some of them have come very close to doing that, but not quite yet).

Now that we are all clear about the background of the Project, Let's get started on the initial setup.