Install
Install the modlock command.
Install the modlock command by running the line for your computer.
Windows, in PowerShell:
irm https://raw.githubusercontent.com/paralin/modlock/master/install.ps1 | iexmacOS or Linux, in a terminal:
curl -fsSL https://raw.githubusercontent.com/paralin/modlock/master/install.sh | shOr with npm, into a project:
npm install --save-dev @modlock/modlock
npx modlock new my-modWhen you install with npm, run every command through npx, as in
npx modlock dev.
You need nothing else to write a mod in TypeScript, JavaScript, Luau or Python;
a Go mod also needs Go. The first time you run modlock,
it downloads the game server. To move to a newer release later, run
modlock update.
modlock is not found
On Windows, a terminal that was already open keeps the PATH it started with.
Close it and open a new one, or for a terminal inside VS Code, close the whole
editor. On macOS or Linux, when the install directory is not on your PATH,
the installer prints a line for you to add to your shell's startup file.
Next: make your first mod.
Download it by hand
Download the file for your computer from the
latest release, rename it
to modlock (modlock.exe on Windows), and put it in a directory on your
PATH. On macOS or Linux, make it runnable with chmod +x modlock.
| Your computer | File |
|---|---|
| Windows | modlock-windows-amd64.exe |
| Mac with Apple silicon | modlock-darwin-arm64 |
| Mac with an Intel processor | modlock-darwin-amd64 |
| Linux, x86-64 | modlock-linux-amd64 |
| Linux, ARM64 | modlock-linux-arm64 |
Windows SmartScreen and macOS warn about a program downloaded in a browser,
which the install lines above avoid. On a Mac, clear the warning with
xattr -c modlock. Run modlock from a terminal, because double-clicking it
only prints how to install it.
To run Modlock from a clone, see Building Modlock.