Getting Started with Scripts - trethore/MQS GitHub Wiki
Now that you have My QOL Scripts (MQS) installed, it's time to add your first script! This guide explains what scripts are, where to put them, and how to activate them in-game.
Scripts are simple text files with a .js
extension that contain JavaScript code. MQS reads these files and uses them to add new features to your game. A script could be anything from a small utility that tells you your coordinates to a complex new HUD element.
You don't need to know how to code to use scripts; you can download scripts made by others and use MQS to manage them.
When you first run Minecraft with MQS installed, it automatically creates a special folder for you. This is where you will place all your script files.
The folder is located at:
<Your Minecraft Folder>/my-qol-scripts/scripts/
For example, on Windows, this would typically be:
%appdata%\.minecraft\my-qol-scripts\scripts\
Follow these simple steps to add a new script to your game.
First, you need a script file. You can find scripts created by the community.
For this example, let's assume you've downloaded a file named my-cool-script.js
.
Move the my-cool-script.js
file into the .../my-qol-scripts/scripts/
folder that we located earlier.
There are two ways to get MQS to recognize your new script:
- Restart Your Game: MQS automatically discovers all scripts in the folder when Minecraft starts.
-
Refresh In-Game (Recommended): If your game is already running, you don't need to restart!
- Open the MQS menu by typing
/mqs
in chat. - Click the Refresh button (the one with the circular arrows icon). This will rescan your scripts folder.
- Open the MQS menu by typing
Once MQS has discovered your script, it will appear in the main GUI list, but it will be disabled by default.
- Open the MQS menu (
/mqs
). - Find your script in the list.
- Click the toggle switch on the right to enable it. The indicator will turn from red to green.
That's it! The script is now active. To disable it, simply click the toggle switch again.
You now know how to install the mod and manage scripts. The next section will give you a full tour of the main GUI.
➡️ Next Step: The Main GUI