{"id":28630813,"url":"https://github.com/bozimmerman/sip","last_synced_at":"2025-06-12T13:08:20.960Z","repository":{"id":295750107,"uuid":"991111653","full_name":"bozimmerman/Sip","owner":"bozimmerman","description":"Sip is a desktop client for MUD (Multi-User Dungeon) gaming.","archived":false,"fork":false,"pushed_at":"2025-06-10T22:17:29.000Z","size":1492,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-10T22:32:32.011Z","etag":null,"topics":["mud-client","muds","text-games"],"latest_commit_sha":null,"homepage":"http://coffeemud.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bozimmerman.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-27T06:28:45.000Z","updated_at":"2025-06-10T22:13:03.000Z","dependencies_parsed_at":"2025-05-27T07:40:17.830Z","dependency_job_id":"c5500149-93ce-4e2c-b8de-bf96a7cf13bc","html_url":"https://github.com/bozimmerman/Sip","commit_stats":null,"previous_names":["bozimmerman/sip"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/bozimmerman/Sip","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bozimmerman%2FSip","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bozimmerman%2FSip/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bozimmerman%2FSip/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bozimmerman%2FSip/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bozimmerman","download_url":"https://codeload.github.com/bozimmerman/Sip/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bozimmerman%2FSip/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259470960,"owners_count":22862999,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mud-client","muds","text-games"],"created_at":"2025-06-12T13:08:13.810Z","updated_at":"2025-06-12T13:08:20.951Z","avatar_url":"https://github.com/bozimmerman.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sip MUD Client\r\n\r\nSip is a stand-alone desktop client for MUD (Multi-User Dungeon) gaming.  It is optimized for [CoffeeMUD](http://www.coffeemud.net/), but can be used with others.  Originally launched as a Java AWT client over 20 years ago, Sip has been reimagined for today’s players.\r\n\r\n## Features\r\n\r\n- ANSI-TRUE: All the colors you could hope for.\r\n- MXP: Pictures, sounds, clickable text, and mini-frames.\r\n- MSP: Sound and Music\r\n- GMCP: Access server information out-of-band + Client.Login, Client.Media.\r\n- MSDP: Access server information out-of-band\r\n- Aliases: Customize your commands, or trigger a myriad of events.\r\n- Triggers: Cause a custom action when the mud sends a particular message.\r\n- Scripts (JavaScript): Go wild with customizing your mud client.\r\n- Timers: Cause some action to occur periodically, or after a delay. \r\n- MXP editor: Customize your screen layout or colors, have a window for TELLs, etc. \r\n- Media: Local images and sounds for your custom GUI.\r\n- Mapper: Built in API for building interactive visual area maps.\r\n- Plugins: Sweet bundles of all the above and media and more.\r\n\r\n## Screenshots\r\n\r\n![Sip Screen](https://zimmers.net/home/mud/sip.jpg)\r\n\r\n## Installation\r\n\r\n1. **Download the Executable**:\r\n   - Download `Sip-3.0.0.win64.exe` from [GitHub Releases](https://github.com/bozimmerman/sip/releases)\r\n\r\n2. **Run Sip**:\r\n   - Double-click `Sip-3.0.0.win64.exe` to launch the app on Windows. No installation is required—this is a portable executable.\r\n\r\n## Usage\r\n\r\n1. **Launch Sip**:\r\n   - Run `Sip-3.0.0.win64.exe`.\r\n   - Optionally, use `--dev` to enable DevTools for troubleshooting:\r\n     ```\r\n     Sip-3.0.0.win64.exe --dev\r\n     ```\r\n\r\n2. **Connect to CoffeeMUD**:\r\n   - Sip automatically connects to `coffeemud.net:23` (CoffeeMUD’s default telnet port).\r\n   - If using a different server, use the `Connect` menu option under `Window`.\r\n\r\n3. **Interact with the MUD**:\r\n   - View server output in the big black area.\r\n   - Enter commands in the input field at the bottom (e.g., `look`, `attack`).\r\n\r\n4. **Read the Help**:\r\n   - Help for the several features is available under the `Help` menu.\r\n\r\n## Building from Source\r\n\r\nIf you’d like to modify Sip and build your own `.exe`:\r\n\r\n1. **Clone the Repository**:\r\n\r\n   svn checkout https://coffeemud.net/public/Sip\r\n   \r\n   cd Sip\r\n\r\n2. **Install Dependencies**:\r\n\r\n   npm install\r\n\r\n3. **Run in Development**:\r\n\r\n   npm start\r\n\r\n- Add `--dev` to open DevTools:\r\n  ```\r\n  npm start -- --dev\r\n  ```\r\n\r\n4. **Build the .exe**:\r\n\r\n   npm run dist:win\r\n   \r\nor\r\n\r\n   npm run dist:mac\r\n\r\nor\r\n\r\n   npm run dist:linux\r\n\r\n- Outputs e.g. `Sip-3.0.0.win64.exe` in the `dist/` folder.\r\n\r\n## Known Issues\r\n\r\n- None at the moment.\r\n\r\n## Contributing\r\n\r\nSip is a passion project, but contributions are welcome! Fork the repository, make your changes, and contact the author to review your changes.\r\n\r\n## License\r\n\r\nSip is released under the [Apache 2.0 License](LICENSE).\r\n\r\n## Acknowledgments\r\n\r\n- Built with [Electron](https://www.electronjs.org/) for cross-platform desktop support.\r\n- Thanks to the CoffeeMUD community for their support and feedback.\r\n\r\n## Contact\r\n\r\nFor questions, bug reports, or feature requests, reach out via:\r\n- Contact: https://www.zimmers.net/email/form-page.html\r\n- Development Home Page: http://www.coffeemud.org\r\n- Support forum: http://coffeemud.net:27744/forum.cmvp?journal=Support\u0026journalpage=0\r\n- GitHub: [bozimmerman](https://github.com/bozimmerman)\r\n\r\n---\r\n\r\nSip: Savor the Experience! ☕\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbozimmerman%2Fsip","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbozimmerman%2Fsip","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbozimmerman%2Fsip/lists"}