Running your own server
OpenVMK is out. Download it from GitHub Releases, unzip it, and start it. No plugin needed, and on Windows nothing to install. Want to work on the code instead? See Running from source.
You'll need about 5 GB of free disk space: a 1.8 GB download that unpacks to about 3 GB.
- 1Download. Open the latest release and, under Assets, download
vmk-release.zip. Skip the "Source code" archives GitHub adds automatically; they don't contain the game. - 2(Optional) Check the download against the SHA-256 in the release notes. On Windows (PowerShell):
Get-FileHash vmk-release.zip. On macOS or Linux:shasum -a 256 vmk-release.zip. - 3Extract it to a folder of your choice, such as
Documents\OpenVMK. The game is about 340,000 small files, so Windows' built-in "Extract All" is very slow. 7-Zip is much faster, or from a terminal in the download folder runtar -xf vmk-release.zip(Windows PowerShell) orunzip vmk-release.zip(macOS or Linux). - 4Start it from inside the new
vmk-releasefolder (see the table below). - 5Wait for "VMK is running" (10–30 seconds). Your browser opens
http://127.0.0.1:5199/. Leave the window open while you play; closing it stops the server. - 6Create your account. The first account on a new server becomes the admin, with the staff panel at
/hk.
| You have | Do this |
|---|---|
| Windows | Double-click Start VMK.bat. Nothing to install: the release carries its own Node.js. |
| macOS / Linux | Install Node.js 22.5 or newer, then run sh start.sh in a terminal. |
| Linux, with Docker | Run docker compose up -d, then open http://<your-server>:5199. The Docker setup is still early, and reports are welcome. |
Windows may warn you because the file came from the internet. On "Windows protected your PC", click More info, then Run anyway. On "Open File – Security Warning", click Run.
Playing with friends?
The release includes SELF-HOSTING.md. It covers playing over your network, Docker with automatic HTTPS, running behind your own reverse proxy, every setting, backups, and troubleshooting.
Updating & uninstalling
Updating: stop the server, extract the new release next to the old one, copy your old data folder (your accounts, inventories and rooms) into it, and start the new one. Each release's notes also list the few files you can copy by hand from a recent version, and CHANGES.txt lists what's new.
Uninstalling: stop the server and delete the folder. Nothing is installed anywhere else.
Found a problem? Report it on GitHub Issues. Mention your operating system and attach the relevant file from the release's logs folder.
The release includes the game files the browser client needs. Want the original Shockwave files (.dcr / .cct casts) for preservation or research? They're available on request. Ask on Discord.
Running from source
The full source code is on GitHub under the GNU AGPL v3.0 or later. Running from source is for working on OpenVMK. To play or host a server for people, use the release: it's built, optimised and loads much faster.
You'll need Node.js 22.5 or newer and about 4.5 GB of disk. The clone is large (about a 600 MB download that checks out to about 3 GB and 143,000 files) because it carries the game's extracted art.
git clone https://github.com/OpenVMK/OpenVMK.git cd OpenVMK npm install npx vite build --config client/vite.config.ts node start.mjs
The game opens at http://127.0.0.1:5199/, and the first account you create becomes the admin. Rebuild the client after changing anything under client/src. On Windows, clone into a short path such as C:\OpenVMK; if checkout fails with "Filename too long", run git config --global core.longpaths true and clone again. The README has the rest: developer tools, cast packs, and re-extracting the game files.
Roadmap
- DoneGame file inventory and protocol documentation: 144 rooms mapped, 100+ client messages handled
- DoneAccounts, sign-in, avatar creation and persistence (SQLite)
- DoneNavigator, public rooms, guest rooms, room queues, chat, emotes and actions
- DoneFriends list and messenger
- DoneShops, credits, furni and posters, room editing, trading, pins, magic and FastPasses
- DoneCamera, photo album and photo walls
- DoneStaff admin panel and moderation tools
- DoneMini games: Pirates of the Caribbean, Haunted Mansion, Jungle Cruise, Castle Fireworks and the Street Party Music Game
- DoneThe Haunted Mansion's public rooms, with their wandering ghosts
- DoneTypeScript port of the original client, running in the browser without Shockwave
- DoneFirst release on GitHub Releases: October 18, 2026
- DoneFull source code published under the AGPL-3.0: October 22, 2026
- NowMagic Shop Checkers, the last mini game
- NextQuests and Hidden Mickeys
- LaterDocker deployment beyond the early Compose setup
Contributing
Pull requests are welcome. For anything bigger than a fix, say hello on Discord or open an issue first, so work isn't duplicated. Other contributions are just as useful:
Game files
Archived client files, casts (.cct / .dcr), text files and anything else from VMK, especially rare or late versions.
Research
Packet captures, protocol notes, screenshots, videos and recollections of how rooms, items and games worked.
Testing
Try the release, compare it to how you remember VMK, and report what's off.
For bugs and feature requests, use GitHub Issues so they stay searchable. Discussion, questions and development chat happen on Discord.