{"id":13466821,"url":"https://github.com/OceanicJS/Oceanic","last_synced_at":"2025-03-26T00:31:32.392Z","repository":{"id":54243256,"uuid":"522099717","full_name":"OceanicJS/Oceanic","owner":"OceanicJS","description":"A NodeJS library for interfacing with Discord.","archived":false,"fork":false,"pushed_at":"2024-10-26T00:29:49.000Z","size":13496,"stargazers_count":274,"open_issues_count":2,"forks_count":25,"subscribers_count":2,"default_branch":"dev","last_synced_at":"2024-10-29T20:33:27.067Z","etag":null,"topics":["discord","hacktoberfest","javascript","nodejs"],"latest_commit_sha":null,"homepage":"https://oceanic.ws","language":"TypeScript","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/OceanicJS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":".github/SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["DonovanDMC","Nuckyz"],"ko_fi":"Donovan_DMC"}},"created_at":"2022-08-07T02:37:46.000Z","updated_at":"2024-10-29T13:23:36.000Z","dependencies_parsed_at":"2023-09-27T16:20:39.235Z","dependency_job_id":"9c2ce8a9-5cfa-4ecb-acc3-aaf018090298","html_url":"https://github.com/OceanicJS/Oceanic","commit_stats":{"total_commits":624,"total_committers":10,"mean_commits":62.4,"dds":"0.28846153846153844","last_synced_commit":"77e7b1ddf9376b26749b868fcccd6951bfad5554"},"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanicJS%2FOceanic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanicJS%2FOceanic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanicJS%2FOceanic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanicJS%2FOceanic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OceanicJS","download_url":"https://codeload.github.com/OceanicJS/Oceanic/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245566098,"owners_count":20636390,"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":["discord","hacktoberfest","javascript","nodejs"],"created_at":"2024-07-31T15:00:50.398Z","updated_at":"2025-03-26T00:31:32.379Z","avatar_url":"https://github.com/OceanicJS.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg width=60% src=\"https://user-images.githubusercontent.com/68125679/193473284-e14ea33d-b086-4c28-870d-4221e766d775.png\"\u003e\n  \u003cbr\u003e\n  \u003ca href=\"https://npmjs.com/package/oceanic.js\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/oceanic.js.svg?style=flat-square\u0026color=informational\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://img.shields.io/github/stars/OceanicJS/Oceanic?color=yellow\u0026style=flat-square\"\u003e\n  \u003cimg src=\"https://img.shields.io/npm/dw/oceanic.js?color=red\u0026style=flat-square\"\u003e\n\u003c/p\u003e\n\n```js\nconst { Client } = require(\"oceanic.js\");\nconst client = new Client({ auth: \"Bot [TOKEN]\" });\n\nclient.on(\"ready\", async() =\u003e {\n    console.log(\"Ready as\", client.user.tag);\n});\n\n// if you do not add a listener for the error event, any errors will cause an UncaughtError to be thrown,\n// and your process may be killed as a result.\nclient.on(\"error\", (err) =\u003e {\n    console.error(\"Something Broke!\", err);\n});\n\nclient.connect();\n```\nFor more examples, see the [examples](https://github.com/OceanicJS/Oceanic/tree/dev/examples) folder on GitHub.\n\u003chr\u003e\n\n## Installation\nNodeJS **18.13.0** or higher is required.\n\n**See [Development Builds](#development-builds) if you wish to install in-dev versions.**\n\n```sh\nnpm i oceanic.js --omit=optional\n```\n\nIf you need voice support, add `--include=optional`. Voice support is currently provided by [@discordjs/voice](https://discord.js.org/#/docs/voice/main/general/welcome).\n\nSee the [examples](https://github.com/OceanicJS/Oceanic/tree/dev/examples) folder on GitHub for some examples, and visit [this site](https://docs.oceanic.ws) for documentation.\n\n### Development Builds\n```sh\nnpm i oceanic.js@dev\n```\n\nThe documentation under `dev` is always for the latest commit. If something isn't working that's in the documentation, you're likely looking at the wrong documentation.\n\n\u003chr\u003e\n\n### Optional Dependencies\nAll compression options are mutually exclusive.\n* `pako` - zlib Compression (gateway)\n* `zlib-sync` - zlib Compression (gateway, faster than pako)\n* `erlpack` - Encoding (gateway, alternative to JSON)\n\n## Links\n* [Examples](https://github.com/OceanicJS/Oceanic/tree/dev/examples)\n* [Latest Release Documentation](https://docs.oceanic.ws/latest)\n* [Development Documentation](https://docs.oceanic.ws/dev)\n* [Discord Server](https://discord.gg/xZ4AhdYrf9)\n* [Source](https://github.com/OceanicJS/Oceanic)\n","funding_links":["https://github.com/sponsors/DonovanDMC","https://github.com/sponsors/Nuckyz","https://ko-fi.com/Donovan_DMC"],"categories":["API Libraries"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOceanicJS%2FOceanic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOceanicJS%2FOceanic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOceanicJS%2FOceanic/lists"}