{"id":13674438,"url":"https://github.com/radj307/ARRCON","last_synced_at":"2025-04-28T14:31:24.237Z","repository":{"id":64080531,"uuid":"431674962","full_name":"radj307/ARRCON","owner":"radj307","description":"Lightweight Source RCON client that works on Windows, macOS, \u0026 Linux.","archived":false,"fork":false,"pushed_at":"2024-03-04T21:36:05.000Z","size":498,"stargazers_count":145,"open_issues_count":8,"forks_count":9,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-03-05T00:38:47.067Z","etag":null,"topics":["ark-survival-evolved","arrcon","cli","command-line","conan-exiles","csgo","minecraft","project-zomboid","rcon","rcon-cli","rcon-client","rcon-commands","remote-console","source-rcon","source-rcon-protocol","steam"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/radj307.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-11-25T01:15:35.000Z","updated_at":"2024-04-15T15:47:25.466Z","dependencies_parsed_at":"2024-02-01T01:26:29.286Z","dependency_job_id":"c771a5f7-a260-466f-9029-ccf21f38a7a4","html_url":"https://github.com/radj307/ARRCON","commit_stats":null,"previous_names":[],"tags_count":82,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radj307%2FARRCON","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radj307%2FARRCON/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radj307%2FARRCON/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radj307%2FARRCON/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/radj307","download_url":"https://codeload.github.com/radj307/ARRCON/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224120186,"owners_count":17259026,"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":["ark-survival-evolved","arrcon","cli","command-line","conan-exiles","csgo","minecraft","project-zomboid","rcon","rcon-cli","rcon-client","rcon-commands","remote-console","source-rcon","source-rcon-protocol","steam"],"created_at":"2024-08-02T11:00:50.408Z","updated_at":"2024-11-11T14:31:02.064Z","avatar_url":"https://github.com/radj307.png","language":"C++","funding_links":[],"categories":["Software","Application Recommendation"],"sub_categories":["Games - Administrative Utilities \u0026 Control Panels","🎮 Game Servers"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg\n       src=\"https://i.imgur.com/BdC2Qz9.png\"\n       alt=\"ARRCON Banner\"\n  /\u003e\n\u003c/p\u003e  \n\u003cp align=\"center\"\u003e\nA lightweight cross-platform RCON client compatible with \u003cb\u003eany game using the Source RCON Protocol\u003c/b\u003e.\u003cbr/\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/radj307/ARRCON/releases/latest\"\u003e\u003cimg alt=\"GitHub release (latest by date)\" src=\"https://img.shields.io/github/v/release/radj307/ARRCON?label=Latest+Version\u0026style=flat\"\u003e\u003c/a\u003e\n  \u003cnobr/\u003e\n  \u003ca href=\"https://github.com/awesome-selfhosted/awesome-selfhosted#games---administrative-utilities--control-panels\"\u003e\u003cimg alt=\"Mentioned in Awesome-Selfhosted\" src=\"https://awesome.re/mentioned-badge.svg\"\u003e\u003c/a\u003e\n  \u003cnobr/\u003e\n  \u003ca href=\"https://github.com/radj307/ARRCON/releases\"\u003e\u003cimg alt=\"Downloads\" src=\"https://img.shields.io/github/downloads/radj307/ARRCON/total?label=Downloads\u0026style=flat\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/radj307/ARRCON/actions/workflows/MakeRelease.yaml\"\u003e\u003cimg alt=\"Release Workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/radj307/ARRCON/MakeRelease.yaml?label=Build Status\u0026logo=github\u0026style=flat\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/radj307/ARRCON/releases\"\u003eDownloads\u003c/a\u003e\u0026nbsp\u0026nbsp|\u0026nbsp\u0026nbsp\u003ca href=\"https://github.com/radj307/ARRCON/wiki\"\u003eWiki\u003c/a\u003e\u0026nbsp\u0026nbsp|\u0026nbsp\u0026nbsp\u003ca href=\"https://github.com/radj307/ARRCON/issues\"\u003eIssues\u003c/a\u003e\n\u003c/p\u003e\n\n\n# Features\n  - Highly configurable\n  - **Cross-Platform:**\n    - Windows\n    - Linux\n    - macOS\n  - **Works for any game using the [Source RCON Protocol](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol)**\n  - **Handles large packets without issue**\n  - **Handles multi-packet responses without issue**\n  - **Supports Minecraft Bukkit's colorized text**\n  - You can set delays in the INI file or directly on the commandline\n  - Supports saving a server's connection info so you can connect to it with 1 word  \n    If you've ever used `ssh`'s `config` file, this will be very familiar. *(albeit with more sensible syntax)*\n    - This can be done in a text editor **or entirely from the commandline**\n  - Can be used as a one-off from the commandline, or in an interactive console\n    - Supports piped input using shell operators.  \n      For example; `echo \"help\" | ARRCON -S myServer` would send the `help` command to the `myServer` host\n      - Piped commands are sent _after_ any commands explicitly specified on the commandline\n  - You can write scripts and manually execute them with the `-f`/`--file` options in addition to shell scripts\n    - Commands are separated by newlines\n    - Commands from script files are sent _after_ any piped commands\n    - Line comments can be written using semicolons `;` or pound signs '#'\n  - Shows an indicator when the server didn't respond to your command\n    \n\n# Installation\nGet the latest version for your OS from the [releases](https://github.com/radj307/ARRCON/releases) page.  \nIf you're using the [Windows](#windows) or [MacOS](#macos) versions, see the additional information below.\n\nThere is no installation process required, simply extract the archive to a location of your choice, then run it using a terminal emulator.  \nIf you want to be able to run ARRCON from any working directory without specifying its location, you must [add the location to your environment's PATH variable](https://github.com/radj307/ARRCON/wiki/Adding-To-Path).\n\n\n## Windows\nOn newer versions of Windows, you may be required to \"unblock\" the executable before Windows will let you use it.  \nThis is because the executable isn't signed with a Microsoft-approved signing certificate, which costs upwards of [$300/year](https://docs.microsoft.com/en-us/windows-hardware/drivers/dashboard/get-a-code-signing-certificate#step-2-buy-a-new-code-signing-certificate).  \nTo unblock it, ___Right-Click___ on `ARRCON.exe` in the file explorer and click ___Properties___ at the bottom of the right-click menu.  \n![](https://i.imgur.com/LKLZPVX.png)  \nCheck the ___unblock___ box, then click ___Apply___.  \n\n## MacOS\n**If you're running macOS 10.9 or later, you must install `gcc` via [HomeBrew](https://brew.sh) or some other package manager!**  \nIf homebrew is installed, you can run this command to install and setup `gcc` automatically: `brew install gcc`\n\nThis is because Apple no longer includes `libstdc++` by default as of macOS 10.9 *(See [#11](https://github.com/radj307/ARRCON/issues/11))*, which is required for ARRCON to run.\n\n## Building from Source\nSee [here](https://github.com/radj307/ARRCON/wiki/Building-from-Source) for a brief guide on building ARRCON from source.\n\n\n# Usage\nARRCON is a CLI _(Command-Line Interface)_ program, which means you need to run it through a terminal.  \n\n__On Windows, you can use `cmd.exe` or `powershell.exe` by R+Clicking on the start menu and selecting \"Command Prompt\" or \"PowerShell\".__  \n\nFor more detailed usage instructions, see the [Getting Started](https://github.com/radj307/ARRCON/wiki) page on the wiki.\n\nTo see a list of commands, use `ARRCON -h` or `ARRCON --help`  \nTo see a list of environment variables, their current values, and a description of each, use `ARRCON --print-env`\n\n\n## Modes\n- ___Interactive Shell___  \n  ![](https://i.imgur.com/4d4Epkb.png)  \n  Opens an interactive console session. You can send commands and view the responses in real-time.\n  - Used by default when there are no command arguments.\n  - Connection remains open until you disconnect or kill the process, or if the server closes.\n- ___One-Shot___  \n  ![ARRCON Scripting Support](https://i.imgur.com/oPX47RD.png)  \n  This mode is designed for scripting, it sends commands directly from the commandline in sequential order before exiting.  \n  _(You can also open an interactive shell at the same time with the `-i` / `--interactive` options.)_\n  \n  Supported input methods:\n    - Commandline Parameters  \n      _These are any arguments that are __not__ short/long-opts and __not captured by__ short/long-opts._\n    - Shell Scripts\n    - Redirected input from STDIN\n    - Script Files  \n      Splits commands by line, and allows comments using a semicolon `;` or pound sign `#`.   \n      Comments are always considered line comments.  \n      _Use the '`-f`' or '`--file`' options to specify a scriptfile to load._\n\n# Contributing\n\nIf you want to add a new feature, fix a bug, or just improve something that annoys you, feel free to submit pull requests and/or issues.\n\n## Feedback \u0026 Requests\nFeel free to leave feedback on the issues tab!  \nThere are a number of premade templates for the following situations:\n- [Questions](https://github.com/radj307/ARRCON/issues/new?assignees=radj307\u0026labels=question\u0026template=question.md\u0026title=%5BQUESTION%5D+)\n- [Bug Reports](https://github.com/radj307/ARRCON/issues/new?assignees=radj307\u0026labels=bug\u0026template=bug-report.md\u0026title=%5BBUG%5D+%E2%80%A6)\n- [Protocol Support Requests](https://github.com/radj307/ARRCON/issues/new?assignees=radj307\u0026labels=bug%2C+enhancement%2C+support\u0026template=support-request.md\u0026title=Unsupported+Title%3A+%3Ctitle%3E)  \n  - __A note on Battleye's RCON protocol:__  \n    Battleye's RCON protocol requires sending \"keep-alive\" packets at least every 45 seconds to maintain the connection, which is better suited by a multithreaded GUI application, and as such will not be implemented in ARRCON.  \n    Other protocols or game-specific implementations however, will be considered.\n- [Feature Requests](https://github.com/radj307/ARRCON/issues/new?assignees=\u0026labels=enhancement%2C+new+feature+request\u0026template=request-a-new-feature.md\u0026title=%5BNEW%5D)\n- [Suggestions](https://github.com/radj307/ARRCON/issues/new?assignees=\u0026labels=\u0026template=change-an-existing-feature.md\u0026title=%5BCHANGE%5D+)\n- [Documentation Suggestions or Additions](https://github.com/radj307/ARRCON/issues/new?assignees=\u0026labels=documentation\u0026template=documentation-request.md\u0026title=%5BDOC%5D+)\n\n## Pull Requests\nFeel free to submit a pull request if you've added a feature or fixed a bug with the project!  \nContributions are always welcomed, I'll review it as soon as I see the notification.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fradj307%2FARRCON","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fradj307%2FARRCON","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fradj307%2FARRCON/lists"}