Thanks to visit codestin.com
Credit goes to github.com

Skip to content

bozimmerman/Sip

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sip MUD Client

Sip is a stand-alone desktop client for MUD (Multi-User Dungeon) gaming. It is optimized for CoffeeMUD, 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.

Features

  • ANSI-TRUE: All the colors you could hope for.
  • MXP: Pictures, sounds, clickable text, and mini-frames.
  • MSP: Sound and Music
  • GMCP: Access server information out-of-band + Client.Login, Client.Media.
  • MSDP: Access server information out-of-band
  • Aliases: Customize your commands, or trigger a myriad of events.
  • Triggers: Cause a custom action when the mud sends a particular message.
  • Scripts (JavaScript): Go wild with customizing your mud client.
  • Timers: Cause some action to occur periodically, or after a delay.
  • MXP editor: Customize your screen layout or colors, have a window for TELLs, etc.
  • Media: Local images and sounds for your custom GUI.
  • Mapper: Built in API for building interactive visual area maps.
  • Plugins: Sweet bundles of all the above and media and more.

Screenshots

Sip Screen

Installation

  1. Download the Executable:

  2. Run Sip:

    • Double-click Sip-3.0.0.win64.exe to launch the app on Windows. No installation is required—this is a portable executable.

Usage

  1. Launch Sip:

    • Run Sip-3.0.0.win64.exe.
    • Optionally, use --dev to enable DevTools for troubleshooting:
      Sip-3.0.0.win64.exe --dev
      
  2. Connect to CoffeeMUD:

    • Sip automatically connects to coffeemud.net:23 (CoffeeMUD’s default telnet port).
    • If using a different server, use the Connect menu option under Window.
  3. Interact with the MUD:

    • View server output in the big black area.
    • Enter commands in the input field at the bottom (e.g., look, attack).
  4. Read the Help:

    • Help for the several features is available under the Help menu.

Building from Source

If you’d like to modify Sip and build your own .exe:

  1. Clone the Repository:

    svn checkout https://coffeemud.net/public/Sip

    cd Sip

  2. Install Dependencies:

    npm install

  3. Run in Development:

    npm start

  • Add --dev to open DevTools:
    npm start -- --dev
    
  1. Build the .exe:

    npm run dist:win

or

npm run dist:mac

or

npm run dist:linux

  • Outputs e.g. Sip-3.0.0.win64.exe in the dist/ folder.

Known Issues

  • None at the moment.

Contributing

Sip is a passion project, but contributions are welcome! Fork the repository, make your changes, and contact the author to review your changes.

License

Sip is released under the Apache 2.0 License.

Acknowledgments

  • Built with Electron for cross-platform desktop support.
  • Thanks to the CoffeeMUD community for their support and feedback.

Contact

For questions, bug reports, or feature requests, reach out via:


Sip: Savor the Experience! ☕

About

Sip is a desktop client for MUD (Multi-User Dungeon) gaming.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published