Get started
Install and share mods
Install mods from a file, pasted code, a share code or a link, keep them up to date, and share your own.
Everything here happens in the Mods menu on the title screen.
Install a mod
There are four ways in. They all end at the same install prompt, so you always see what you are about to add.
Drop it on the game
Drag a .zip or .lua file onto the game window. This works on any screen, even in a world. The Mods menu opens with the install prompt. Drop one file at a time.
Pick a file
Click Import mod, then Choose a .zip or .lua file...
Paste code or a share code
Click Import mod, paste into the big box, and click Import pasted text. The box takes Lua code or a share code (the text that starts with ZEUS1:).
Give pasted Lua a -- name: line at the top. Without one, the mod is called Untitled Mod, and the next unnamed paste replaces it.
Download it from a link
Click Import mod, paste the link into the URL field and click Download. The link can point at a .zip, a .lua file or a text file with a share code in it.
The website has to allow downloads from other sites (CORS). Many file hosts do not, and then you get "Download failed". If that happens, download the file yourself and drop it on the game instead.
The install prompt
The prompt shows the mod's name, version, authors and description, and three warnings when they apply:
- what the mod asks for, like
networkto use the internet orclipboardto read your clipboard - that it replaces a mod you already have, if it has the same id
- that it was made for a different version of the game, which may still work
Click Install to add it. As the prompt says: only install mods from people you trust. Mods run code inside the game.
Try the examples
The Import screen has a few example mods under Examples. Install one, then click Edit code to see how it works. Reading other people's mods is one of the fastest ways to learn. The Examples page has more, ready to paste.
Manage your mods
Click a mod in the list to see its details and buttons.
| Button | What it does |
|---|---|
| Enable or Disable | turns the mod on or off |
| Settings | opens the mod's settings, if it has any. Only works while the mod is running |
| Log | everything the mod printed, and every error |
| Edit code | opens the mod in the code editor |
| Export .zip | downloads the mod as a zip |
| Share code | copies the whole mod as text |
| Reload | restarts the mod |
| Move up | moves the mod up the list. Mods higher up load first |
| Delete | removes the mod, its settings and its saved data |
Under each mod's name you see its status:
| Status | What it means |
|---|---|
| Enabled | it is running |
| Error | it failed to load or was stopped. The details show why, and Log has the full story |
| Paused (singleplayer only) | it is on, but you are on a server (see How mods run) |
| Not loaded | it is on but not running, usually because a mod it needs is off or missing. Click Reload |
| Disabled | it is off |
Reload all at the bottom restarts every mod at once.
Update a mod
Install the new version the same way you installed the first one. Because the id matches, the prompt says Update instead of Install.
Updating keeps the mod's settings and saved data, and its place in the list. Everything else is replaced, including any changes you made in the editor, so export your edits first if you want to keep them. Updating a mod that is turned off also turns it back on.
Share your mod
As a zip
Click Export .zip. You get a file named after the mod's id and version, like coolhud-1.2.0.zip, with all your edits in it. Send it to a friend, and they drop it on their game.
As a share code
Click Share code. The whole mod is copied to your clipboard as one line of text that starts with ZEUS1:. Paste it in a chat or a message, and your friend pastes it under Import mod.
The paste box holds up to 200,000 characters, which fits most Lua mods. For a bigger mod, save the code in a .txt file and import that file instead, or just share the zip.
Where mods are kept
Your mods, their settings and their saved data live in your browser, next to your singleplayer worlds. Every world uses the same mods.
Mods are not part of cloud saves. If you clear this site's data in your browser, your mods go with it, so export the ones you care about.



