{"id":19821612,"url":"https://github.com/oestrich/gossip-ranvier","last_synced_at":"2025-07-30T16:36:58.056Z","repository":{"id":138757555,"uuid":"140115580","full_name":"oestrich/gossip-ranvier","owner":"oestrich","description":"A ranvier bundle for Gossip","archived":false,"fork":false,"pushed_at":"2018-12-31T02:08:05.000Z","size":12,"stargazers_count":3,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-01T12:40:45.708Z","etag":null,"topics":["mud"],"latest_commit_sha":null,"homepage":"https://gossip.haus/","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/oestrich.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2018-07-07T20:40:49.000Z","updated_at":"2020-12-14T20:44:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"be7d6e02-5b4b-40a5-ad4b-106bae93d216","html_url":"https://github.com/oestrich/gossip-ranvier","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/oestrich/gossip-ranvier","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oestrich%2Fgossip-ranvier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oestrich%2Fgossip-ranvier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oestrich%2Fgossip-ranvier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oestrich%2Fgossip-ranvier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oestrich","download_url":"https://codeload.github.com/oestrich/gossip-ranvier/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oestrich%2Fgossip-ranvier/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267899901,"owners_count":24163001,"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","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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"],"created_at":"2024-11-12T10:29:42.344Z","updated_at":"2025-07-30T16:36:58.041Z","avatar_url":"https://github.com/oestrich.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gossip Client for Ranvier\n\nThis bundle is a sample implementation of a client to the [Gossip Network][gossip].\n\nTo enable:\n\n- Register for an account on [gossip.haus][gossip], and then register your game\n  - You will get a Client ID and Client Secret from this step, you will use it in the configuration below\n- Clone to your bundles folder\n- Add the `\"gossip-ranvier\"` bundle in `ranvier.json`\n- Add the following configuration to `ranvier.json`\n\n```json\n{\n  \"gossip\": {\n    \"url\": \"wss://gossip.haus/socket\",\n    \"clientId\": \"CHANGE ME\",\n    \"clientSecret\": \"CHANGE ME\"\n  }\n}\n```\n\nThe channels configuration key is set up as an object with the remote channel as the key, and the local channel as the value.\n\n## Adding new channels\n\nYou can add new channels by creating more `GossipChannel` objects. They will automatically be detected and join the network.\n\nNote that remote channel names are validated before subscribing. They must be a single word of letters only and a maximum of 15 characters.\n\n## Fake Player\n\nIn order for messages to be broadcast into your game, the bundle makes a fake player object as follows:\n\n```javascript\nlet player = {\n  isGossip: true,\n  name: \"player@RemoteGame\",\n  getBroadcastTargets: () =\u003e {\n    return [];\n  }\n};\n```\n\nMake sure this works for your game and extend as needed.\n\n## Sign In/Sign Out\n\nIn your fork of Ranvier, you will need to emit the `spawn` event on your player characters when they sign into the game, and you will also need to emit the `quit` event when they quit the game, if you want to take advantage of Gossip's sign in/sign out messaging.\n\n[gossip]: https://gossip.haus/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foestrich%2Fgossip-ranvier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foestrich%2Fgossip-ranvier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foestrich%2Fgossip-ranvier/lists"}