{"id":16813615,"url":"https://github.com/bmiddha/ts-rcon","last_synced_at":"2025-03-22T03:31:12.788Z","repository":{"id":35051557,"uuid":"200742370","full_name":"bmiddha/ts-rcon","owner":"bmiddha","description":"RCON client for Node.js written in TypeScript","archived":false,"fork":false,"pushed_at":"2023-01-08T00:31:08.000Z","size":713,"stargazers_count":8,"open_issues_count":26,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-18T07:32:13.009Z","etag":null,"topics":["csgo","es6","games","minecraft","node-rcon","nodejs","protocol","rcon","rcon-servers","source","tcp","tf2","typescript","udp"],"latest_commit_sha":null,"homepage":"https://bmiddha.github.io/ts-rcon","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/bmiddha.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":"2019-08-05T23:26:24.000Z","updated_at":"2024-08-22T20:50:16.000Z","dependencies_parsed_at":"2023-01-15T13:00:23.156Z","dependency_job_id":null,"html_url":"https://github.com/bmiddha/ts-rcon","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmiddha%2Fts-rcon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmiddha%2Fts-rcon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmiddha%2Fts-rcon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmiddha%2Fts-rcon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bmiddha","download_url":"https://codeload.github.com/bmiddha/ts-rcon/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244902929,"owners_count":20529114,"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":["csgo","es6","games","minecraft","node-rcon","nodejs","protocol","rcon","rcon-servers","source","tcp","tf2","typescript","udp"],"created_at":"2024-10-13T10:27:26.025Z","updated_at":"2025-03-22T03:31:12.185Z","avatar_url":"https://github.com/bmiddha.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ts-rcon\n\n[![npm](https://img.shields.io/npm/v/ts-rcon)](https://www.npmjs.com/package/ts-rcon) [![CI](https://github.com/bmiddha/ts-rcon/actions/workflows/main.yml/badge.svg)](https://github.com/bmiddha/ts-rcon/actions/workflows/main.yml)\n\nts-rcon is a simple library for connecting to RCON servers in node.js implemented in TypeScript.\nBased on [pushrax/node-rcon](https://github.com/pushrax/node-rcon).\nIt implements the protocol used by Valve's Source and GoldSrc engines,\nas well as many other game servers.\n\nIt was originally created to connect to Minecraft's RCON server.\n\n[RCON Protocol Docs](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol)\n\n## Installation\n\n```shell\nnpm install ts-rcon\nyarn add ts-rcon\n```\n\n## Usage\n\nSome games use TCP and some use UDP for their RCON implementation. To tell\nnode-rcon which protocol to use, pass it an options object like so:\n\n```javascript\nvar options = {\n  tcp: false, // false for UDP, true for TCP (default true)\n  challenge: false, // true to use the challenge protocol (default true)\n};\nclient = new Rcon(host, port, password, options);\n```\n\nHere's a non-exhaustive list of which games use which options:\n\n| Game             | Protocol | Challenge |\n| :--------------- | :------- | :-------- |\n| Any Source game  | TCP      | N/A       |\n| Minecraft        | TCP      | N/A       |\n| Any GoldSrc game | UDP      | Yes       |\n| Call of Duty     | UDP      | No        |\n\nSource games include CS:S, CS:GO, TF2, etc. GoldSrc games include CS 1.6, TFC,\nRicochet (lol), etc.\n\nIf there's a game you know uses a certain protocol, feel free to submit a pull\nrequest.\n\nPlease submit a bug report for any game you try that doesn't work!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbmiddha%2Fts-rcon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbmiddha%2Fts-rcon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbmiddha%2Fts-rcon/lists"}