{"id":16658030,"url":"https://github.com/doughsay/room.js-client","last_synced_at":"2025-03-23T14:31:27.832Z","repository":{"id":18600972,"uuid":"21805866","full_name":"doughsay/room.js-client","owner":"doughsay","description":"Client for room.js server","archived":false,"fork":false,"pushed_at":"2023-08-14T16:26:56.000Z","size":3305,"stargazers_count":4,"open_issues_count":19,"forks_count":6,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-14T22:12:38.307Z","etag":null,"topics":["moo","mud","mud-client"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/doughsay.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2014-07-14T03:05:07.000Z","updated_at":"2023-10-27T17:34:26.000Z","dependencies_parsed_at":"2024-10-12T10:02:57.178Z","dependency_job_id":"c01499d1-430d-4b25-b588-e2003fee28d9","html_url":"https://github.com/doughsay/room.js-client","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doughsay%2Froom.js-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doughsay%2Froom.js-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doughsay%2Froom.js-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doughsay%2Froom.js-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/doughsay","download_url":"https://codeload.github.com/doughsay/room.js-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245115845,"owners_count":20563247,"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":["moo","mud","mud-client"],"created_at":"2024-10-12T10:02:52.925Z","updated_at":"2025-03-23T14:31:26.795Z","avatar_url":"https://github.com/doughsay.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Room.js Client\n==============\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/doughsay/room.js-client.svg)](https://greenkeeper.io/) [![Travis](https://img.shields.io/travis/doughsay/room.js-client.svg)](https://travis-ci.org/doughsay/room.js-client) [![Code Style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://standardjs.com/) [![Codecov](https://img.shields.io/codecov/c/github/doughsay/room.js-client.svg)](https://codecov.io/gh/doughsay/room.js-client) [![David](https://img.shields.io/david/doughsay/room.js-client.svg)](https://david-dm.org/doughsay/room.js-client) [![David](https://img.shields.io/david/dev/doughsay/room.js-client.svg)](https://david-dm.org/doughsay/room.js-client?type=dev)\n\n\u003e **NOTE:** The master branch represents ongoing work and may have the client in a currently unstable state.  Please check the [releases](https://github.com/doughsay/room.js-client/releases) to get the most recent stable version.\n\nThis is the Room.js client. Please see the [Room.js Server](https://github.com/doughsay/room.js) project for details about running a server.\n\nDemo\n====\n\nhttp://roomjs.dose.ninja/\n\nClient-Side Commands\n====================\n\nThere are a few commands that are handled client-side that never get sent to the server. Below is a list of them with descriptions:\n\n* `.clear`: Clears the scrollback buffer of the client.\n* `.connect`: Connects to the server if there is not already a connection.\n* `.disconnect`: Disconnects from the server if there is a connection.\n* `.new tab`: Opens a new tab and connects to the server.\n* `.close tab`: Closes the current tab.\n\nConfiguration\n=============\n\nIn addition to the above client-side commands, there are also a few client-side configuration options that you can set. Below is a list of them with descriptions and possible values:\n\n* `.echo (on|off)`: (default: off) Turns on / off echo mode. When on, all commands sent to server will be repeasted as lines in the client.\n* `.space (on|off)`: (default: off) Turns on / off output spacing. When on, all output blocks from the server will be separated by an empty line.\n\nBuilding\n========\n\nTo build the client you need a few things set up first.\n\n### Requirements\n\n* nodejs \u003e= 6.0.0\n* [yarn](https://yarnpkg.com)\n\n### Install dependencies\n\nInstall the project dependencies using yarn:\n\n```\nyarn install\n```\n\n### Build the distributable files\n\nTo build the distributable index.html with all it's required files:\n\n```\nyarn build [serverUrl]\n```\n\nWhere serverUrl is an optional string of which server the client will connect to. (Default: http://localhost:8888)\n\nContributing\n============\n\nFirst, thanks for contributing! If you're going to contribute changes please make sure of the following before submitting a pull-request:\n\n* Make sure the code is lint free (`yarn lint`)\n* Make sure the tests pass (`yarn test`)\n* Build and check in a new dist folder with your changes (`yarn build`)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoughsay%2Froom.js-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoughsay%2Froom.js-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoughsay%2Froom.js-client/lists"}