{"_rev":"6-e2f6fd5d6a5129589890c87c09883281","time":{"created":"2022-09-16T16:41:35.975Z","1.0.0":"2020-02-09T14:17:45.452Z","modified":"2022-09-16T16:41:36.459Z","1.0.1":"2020-02-09T16:19:56.343Z","1.3.8":"2022-09-16T16:41:36.332Z"},"_id":"@boranseckin/bridge","name":"@boranseckin/bridge","dist-tags":{"latest":"1.3.8"},"versions":{"1.3.8":{"name":"@boranseckin/bridge","version":"1.3.8","description":"Bridge - Simple Chat Service with Socket.io","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1","start":"node server.js"},"bin":{"bridge":"client.js","bridge-server":"server.js"},"author":{"name":"Boran Seckin"},"license":"MIT","dependencies":{"ansi-color":"^0.2.1","meow":"^6.1.1","socket.io":"^2.4.0","socket.io-client":"^2.3.0"},"devDependencies":{"eslint":"^7.7.0","eslint-config-airbnb-base":"^14.2.0","eslint-plugin-import":"^2.22.0","minimist":">=1.2.6"},"gitHead":"6a992e8848ef85bcac4d2f3a5925279d1e999dc3","_id":"@boranseckin/bridge@1.3.8","_nodeVersion":"16.17.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-JCXiUQebCv+7ufLyXs6DEH0uyiFByd1ihqKjT8qjO1mdQ8yw7IZE/rn0/2GMCZC86ZqRznp5tCExaGj/dRuFdw==","shasum":"ad742a457baa0c73f225d6f43847a6a8cf0633ca","tarball":"https://registry.npmjs.org/@boranseckin/bridge/-/bridge-1.3.8.tgz","fileCount":8,"unpackedSize":30731,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCdy4q2NMqsem18uW8wyeuCikyiQI5XDyXDclgvjvTbAwIgTL6T3yHqumXNgpWRKZTC4WI37AZx+IVSVPJSaZLDmVE="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjJKdAACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoblQ/9HrE/UTjfnt1JlaSTO0npI0bOk6Wor4Z/3bvYyG6m7qW12fHN\r\n2bBE76WkWmyLtdO80TkMA4AfvgMuoLirKbrLeqVOBmkMdhAnzW8cp5yaT6Vc\r\n+ZY6ZDBzv+YhGtdRaiu2zeOYydNO0ykeWQHh8FKFPeOecSO5p6VKzl67TIQP\r\nASzSBY5sTH24eMC21xkrd8u8apk512blMahETZGTatvaYZ1OMEAy/l0RWilb\r\n0shT/WEStBk0Ek4qkAX7Ky8+F1VSJEoLqJSIQgufRjtBA98YUuFYbUBDZHja\r\nuMfiTGGuMFThE1XZ4DWaQxLqzwxnibcQ3Sz5pzAVVwL1lNI/E9k1Hko9hOek\r\naZTWIu3Fupo3ePxickGH+SeSrwQaW0lz+JrIuRH3GCfZ2G1EWfjYwYg6GEqB\r\nQ4Gpf774rGxQTf7lWYYP+Of4rwzkacxAQZnnWY7qwpLOB9VVZlpJGnFAsXpj\r\nbkRr9vmTEAk6XbT6GrLdmdWCwJpdO1tG/LAypuMgP7oR49f7QdHLZSNfeJTh\r\nbYDOvM6V7rsWsjrNzebBKaIo1VQNUL9h1T+9YDKkhRYpf1jRIE6y7ejyIixZ\r\ndwRbq6LmXlbdx+dFQtKegG8IB0WrR5HQIVjjLy7hjDDqDF+kMm0To+9Hh1IF\r\nwQhu/87b5C/gU6dd4vRDulyGtZFBf5CCPTs=\r\n=7i2t\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"boranseckin","email":"boran@boranseckin.com"},"directories":{},"maintainers":[{"name":"boranseckin","email":"boran@boranseckin.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/bridge_1.3.8_1663346496036_0.21289084718024265"},"_hasShrinkwrap":false}},"maintainers":[{"name":"boranseckin","email":"boran@boranseckin.com"}],"description":"Bridge - Simple Chat Service with Socket.io","author":{"name":"Boran Seckin"},"license":"MIT","readme":"# Bridge - Simple Chat Service\n\n![GitHub package.json version](https://img.shields.io/github/package-json/v/boranseckin/bridge?style=for-the-badge)\n![Code Style](https://img.shields.io/badge/code%20style-airbnb-blue?style=for-the-badge)\n\nBridge is a basic CLI chat application using [Socket.io](https://socket.io/).\n\n## Features\n- Server, port and channel selection when started.\n- Username selection when first connected to the server.\n- Change usernames on the fly.\n- Unlimited room initialization and connection.\n- Whisper to other users in private.\n- Emote to draw attention.\n- Auto-reconnection when connection is interrupted.\n- Colors... Lots of colors!\n\n## Usage\nInstall the bridge package by running `npm install -g boranseckin/bridge`.\n\n### Client\n1. Run `npx bridge` to start the client.\n2. When prompted `Server:`, enter the server URL in the form of `<domain>:<port>/<channel>`.\n    - If you do not specify channel, it will be assumed `/`.\n    - If you do not specify port, it will be assumed `3636`.\n    - If you do not specify domain, it will be assumed `localhost`.\n3. When prompted `Username:`, enter the desired username.\n\n### Server\n1. Run `npx bridge-server` to start the server.\n    - If you want to change the default port (`3636`), use `-p <port>` argument.\n    - If you want to open multiple channels, use `-c <channel>` argument. You can use this argument as many times as you want.      The server will open one channel for each `-c` tag. The default channel (`/`) will be always open regardless the              additional channels.\n    \n    Example: `npx bridge-server -p 1111 -c super -c server`\n2. You will see the log of connections on your terminal.\n\n### Commands\nEverything starting with a forward slash (`/`) is assumed to be a command.\n\n- `/me <message>` is used to send emotes. If sent without a message, acts as a indicator.\n- `/w <to> <message>` is used to whisper to a specific user. `<to>` has to be an online user in the server.\n- `/username <username>` is used to change the username.\n- `/room <room>` is used to change the room. If the room name is empty, user will be assigned to the `#default` room.\n- `/ch <channel>` is used to change the channel. If the channel name is empty, user will be assigned to the `/` channel.\n- `/clear` is used to clear the chat for the user.\n- `/users` is used to list all online users with their room names and IDs.\n- `/id` is used to print user's ID.\n- `/server` is used to print server's address.\n- `/status` is used to print the connection status.\n- `/help` is used to print all the usable commands.\n- `/exit` is used to exit the program.\n\n## Dependencies\n- [socket.io](https://www.npmjs.com/package/socket.io)\n- [socket.io-client](https://www.npmjs.com/package/socket.io-client)\n- [ansi-color](https://www.npmjs.com/package/ansi-color)\n\n## Author\n- **Boran Seckin**\n\n## License\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.\n","readmeFilename":"README.md"}