{"id":17347641,"url":"https://github.com/cryptiklemur/gateway","last_synced_at":"2025-06-12T14:04:42.548Z","repository":{"id":142597786,"uuid":"106945123","full_name":"cryptiklemur/gateway","owner":"cryptiklemur","description":null,"archived":false,"fork":false,"pushed_at":"2017-10-14T16:46:16.000Z","size":24,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-01T15:45:18.569Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Elixir","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cryptiklemur.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2017-10-14T16:45:39.000Z","updated_at":"2017-10-14T16:45:41.000Z","dependencies_parsed_at":"2023-05-02T08:30:39.712Z","dependency_job_id":null,"html_url":"https://github.com/cryptiklemur/gateway","commit_stats":null,"previous_names":["cryptiklemur/gateway"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cryptiklemur%2Fgateway","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cryptiklemur%2Fgateway/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cryptiklemur%2Fgateway/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cryptiklemur%2Fgateway/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cryptiklemur","download_url":"https://codeload.github.com/cryptiklemur/gateway/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245832747,"owners_count":20679702,"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":[],"created_at":"2024-10-15T16:49:38.943Z","updated_at":"2025-03-27T11:20:36.080Z","avatar_url":"https://github.com/cryptiklemur.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gateway\n\nThis is the umbrella project containing Mee6's real-time Discord stuff. Events are broadcasted through redis's pubsub facility.\n\n## Events\n\nEach events are in the form\n\n```json\n{\n  \"t\": \"EVENT_TYPE\",\n  \"d\": \"some data\",\n  \"g\": 159962941502783488,\n  \"s\": [0, 256],\n  \"ts\": 1507970959017\n}\n```\n\n- `t` is the event type (events types are listed below)\n- `d` is the data sent with the events (generally an object)\n- `g` is a guild snowflake id (optional)\n- `s` is a [shard_id, shard_count] info (optional)\n- `ts` is the timestamp when the event has been sent\n\nEvery guild related events listed bellow do not have a `s` parameter. The way the gateway is made, guilds don't know which shard they belong to.\n\nEvents are broadcasted to channels in the form `gateway.event.{event_type}` where `event_type` is actually what we call t here.\n\n## Events List\n\n### GUILD_JOIN\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003cth colspan=\"3\"\u003eGuild Join Structure\u003c/th\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eField\u003c/td\u003e\n    \u003ctd\u003eType\u003c/td\u003e\n    \u003ctd\u003eDescription\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eid\u003c/td\u003e\n    \u003ctd\u003esnowflake\u003c/td\u003e\n    \u003ctd\u003eGuild's id\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003ename\u003c/td\u003e\n    \u003ctd\u003estring\u003c/td\u003e\n    \u003ctd\u003eGuild's name\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eicon\u003c/td\u003e\n    \u003ctd\u003estring\u003c/td\u003e\n    \u003ctd\u003eIcon hash\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eowner_id\u003c/td\u003e\n    \u003ctd\u003esnowflake\u003c/td\u003e\n    \u003ctd\u003eOwner's user id\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eroles\u003c/td\u003e\n    \u003ctd\u003eid_map\u003c/td\u003e\n    \u003ctd\u003eMap of discord roles\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003elarge\u003c/td\u003e\n    \u003ctd\u003ebool\u003c/td\u003e\n    \u003ctd\u003eWhether it's a large guild\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eunavailable\u003c/td\u003e\n    \u003ctd\u003ebool\u003c/td\u003e\n    \u003ctd\u003eWhether the guild is unavailable\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003echannels\u003c/td\u003e\n    \u003ctd\u003eid_map\u003c/td\u003e\n    \u003ctd\u003eMap of discord channels\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n### GUILD_UPDATE\n\nSame as Guild Join structure\n\n### GUILD_LEAVE\n\nSame as Guild Leave structure\n\n### GUILD_MEMBER_UPDATE\n\nContains a Discord Member\n\n### GUILD_MEMBER_JOIN\n\nContains a Discord member\n\n### GUILD_MEMBER_UPDATE\n\nContains a list of Discord member\n\n### GUILD_MEMBER_LEAVE\n\nContains a Discord member\n\n### MESSAGE_CREATE\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003cth colspan=\"3\"\u003eGuild Join Structure\u003c/th\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eField\u003c/td\u003e\n    \u003ctd\u003eType\u003c/td\u003e\n    \u003ctd\u003eDescription\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eid\u003c/td\u003e\n    \u003ctd\u003esnowflake\u003c/td\u003e\n    \u003ctd\u003eGuild's id\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003ename\u003c/td\u003e\n    \u003ctd\u003estring\u003c/td\u003e\n    \u003ctd\u003eGuild's name\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eicon\u003c/td\u003e\n    \u003ctd\u003estring\u003c/td\u003e\n    \u003ctd\u003eIcon hash\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eowner_id\u003c/td\u003e\n    \u003ctd\u003esnowflake\u003c/td\u003e\n    \u003ctd\u003eOwner's user id\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eroles\u003c/td\u003e\n    \u003ctd\u003eid_map\u003c/td\u003e\n    \u003ctd\u003eMap of discord roles\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003elarge\u003c/td\u003e\n    \u003ctd\u003ebool\u003c/td\u003e\n    \u003ctd\u003eWhether it's a large guild\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eunavailable\u003c/td\u003e\n    \u003ctd\u003ebool\u003c/td\u003e\n    \u003ctd\u003eWhether the guild is unavailable\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003echannels\u003c/td\u003e\n    \u003ctd\u003eid_map\u003c/td\u003e\n    \u003ctd\u003eMap of discord channels\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n### COMMAND_EXECUTE\n\nSame structure as Message Create with 2 addition fields:\n\n- command_name `string`\n- text `string`\n\nFor example if someone sends `!foo bar hello world` the command_name would be `!foo` and text would be `bar hello world` \n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcryptiklemur%2Fgateway","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcryptiklemur%2Fgateway","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcryptiklemur%2Fgateway/lists"}