Running your own server
Coming soon. OpenVMK is in early development and there's no public release yet. Setup instructions will be published with the first release. Join the Discord to hear when it lands.
Once it's out, getting a server running should look something like this:
# coming with the first release
git clone https://github.com/OpenVMK/OpenVMK.git
cd OpenVMK
npm install
npm start
All you'll need is Node.js. The TypeScript browser port comes with the game files it needs, so there's no archive to track down. Docker-based deployment is planned.
Want the original Shockwave files (.dcr / .cct casts) for preservation or research? They're available on request. Ask on Discord.
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
- NowMini games: Fireworks, Jungle Cruise and the Music Mixer in; Pirates and Haunted Mansion underway
- NowTypeScript port of the original client, running in the browser without Shockwave
- NextQuests and Hidden Mickeys
- NextDocker deployment and setup docs
- LaterFirst public release
Contributing
Code contributions are welcome once the initial code lands. In the meantime, these are all 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 development builds, compare them 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.