{"id":19821587,"url":"https://github.com/oestrich/gossip-elixir","last_synced_at":"2025-08-16T23:48:54.361Z","repository":{"id":57502842,"uuid":"140516223","full_name":"oestrich/gossip-elixir","owner":"oestrich","description":"An Elixir client for Grapevine","archived":false,"fork":false,"pushed_at":"2019-09-03T22:05:24.000Z","size":95,"stargazers_count":20,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-29T08:44:50.560Z","etag":null,"topics":["chat","elixir","gossip"],"latest_commit_sha":null,"homepage":"https://grapevine.haus/","language":"Elixir","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}},"created_at":"2018-07-11T03:23:12.000Z","updated_at":"2023-09-01T08:52:54.000Z","dependencies_parsed_at":"2022-09-01T23:22:56.704Z","dependency_job_id":null,"html_url":"https://github.com/oestrich/gossip-elixir","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oestrich%2Fgossip-elixir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oestrich%2Fgossip-elixir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oestrich%2Fgossip-elixir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oestrich%2Fgossip-elixir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oestrich","download_url":"https://codeload.github.com/oestrich/gossip-elixir/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224256880,"owners_count":17281618,"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":["chat","elixir","gossip"],"created_at":"2024-11-12T10:29:34.704Z","updated_at":"2024-11-12T10:29:35.462Z","avatar_url":"https://github.com/oestrich.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gossip\n\nA client for connecting to the Gossip MUD chat network. See [https://grapevine.haus/docs](https://grapevine.haus/docs) for more information.\n\n## Installation\n\nThe package can be installed by adding `gossip` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [\n    {:gossip, \"~\u003e 0.6\"},\n  ]\nend\n```\n\n## Configuration\n\nSet the following in your mix project's configuration. **Do not commit the client id and secret.** These should be in a `prod.secret.exs` file or similar that is ignored from your repo.\n\n```elixir\nconfig :gossip, :client_id, \"CLIENT ID\"\nconfig :gossip, :client_secret, \"CLIENT SECRET\"\nconfig :gossip, :callback_modules,\n  core: Callbacks.Core,\n  players: Callbacks.Players,\n  tells: Callbacks.Tells,\n  games: Callbacks.Games\n```\n\n## Callback Modules\n\nYou can opt into specific support flags on Gossip by configuring callback modules that follow the specific behaviours.\n\nSee a sample set of callbacks by viewing the `TestCallback` module for this client, [here](https://github.com/oestrich/gossip-elixir/blob/master/lib/gossip/test_callback.ex).\n\n### Core/Channels\n\nThe `channels` flag *must* be supported and can be set up by providing a callback module that has the `Gossip.Client.Core` behaviour.\n\n### Players\n\nThe `players` flag can be set up by providing a callback module that has the `Gossip.Client.Players` behaviour.\n\n### Tells\n\nThe `tells` flag can be set up by providing a callback module that has the `Gossip.Client.Tells` behaviour.\n\n### Games\n\nthe `games` flag can be set up by providing a callback module that has the `gossip.client.games` behaviour.\n\n## Telemetry Events\n\n- `[:gossip, :events, :channels, :broadcast]` - Received a `channels/broadcast` event\n- `[:gossip, :events, :channels, :send, :request]` - Sending a `channels/send` event\n- `[:gossip, :events, :core, :authenticate, :request]` - Received a response to `authenticate`\n- `[:gossip, :events, :core, :authenticate, :response]` - Sending an `authenticate` event\n- `[:gossip, :events, :core, :heartbeat, :request]` - Received a `heartbeat` event\n- `[:gossip, :events, :core, :restart]` - Received a `restart` event\n- `[:gossip, :events, :games, :connect]` - Received a `games/connect` event\n- `[:gossip, :events, :games, :disconnect]` - Received a `games/disconnect` event\n- `[:gossip, :events, :games, :status, :request]` - Sending a `games/status` event\n- `[:gossip, :events, :games, :status, :response]` - Received a response to `games/status`\n- `[:gossip, :events, :players, :sign_in]` - Received a `players/sign-in` event\n- `[:gossip, :events, :players, :sign_out]` - Received a `players/sign-out` event\n- `[:gossip, :events, :players, :status, :request]` - Sending a `players/status` event\n- `[:gossip, :events, :players, :status, :response]` - Received a response to `players/status`\n- `[:gossip, :events, :tells, :receive]` - Received a `tells/receive` event\n- `[:gossip, :events, :tells, :send, :request]` - Sending a `tells/send` event\n- `[:gossip, :events, :tells, :send, :response]` - Received a response to `tells/send`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foestrich%2Fgossip-elixir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foestrich%2Fgossip-elixir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foestrich%2Fgossip-elixir/lists"}