{"id":17347910,"url":"https://github.com/tuokri/tklserver","last_synced_at":"2025-03-27T11:21:46.070Z","repository":{"id":120622337,"uuid":"276035951","full_name":"tuokri/tklserver","owner":"tuokri","description":"Utility server for TKLMutator.","archived":false,"fork":false,"pushed_at":"2021-09-25T15:50:17.000Z","size":449,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-01T15:45:50.841Z","etag":null,"topics":["discord-integration","logging","rising-storm-2-vietnam","webhook"],"latest_commit_sha":null,"homepage":"","language":"Python","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/tuokri.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-30T08:02:27.000Z","updated_at":"2024-07-13T15:09:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"0f212c11-399b-4a0b-acad-7ea4b2824ff7","html_url":"https://github.com/tuokri/tklserver","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuokri%2Ftklserver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuokri%2Ftklserver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuokri%2Ftklserver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tuokri%2Ftklserver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tuokri","download_url":"https://codeload.github.com/tuokri/tklserver/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245832754,"owners_count":20679704,"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-integration","logging","rising-storm-2-vietnam","webhook"],"created_at":"2024-10-15T16:50:33.134Z","updated_at":"2025-03-27T11:21:46.065Z","avatar_url":"https://github.com/tuokri.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TKLServer - Discord webhook integration for TKLMutator\n\nTKLServer is a server for [TKLMutator](https://github.com/tuokri/rs2-tklogging)\nfor Discord webhook integration. TKLServer could also be called a Discord bot as it\nserves a similar purpose.\nTKLMutator is a Rising Storm 2: Vietnam server mutator, which provides kill logging\nutilities for server administrators.\n\n![Discord examples](discord_example.png)\n\n**Q:** Why is TKLServer needed?\n\n**A:** RS2: Vietnam mods (or rather the Unreal Engine version the game uses)\ndo not support HTTPS, which is required for Discord webhooks.\n\n## Installation option 1 (requires Git + Python 3.6 or newer)\n\n1. Clone TKLServer repository:\n\n    `git clone https://github.com/tuokri/tklserver`\n\n    `cd tklserver`\n\n2. Install requirements:\n\n    `pip install -r requirements.txt`\n\n3. Run the TKLServer:\n\n    `python run.py`\n\n4. Start RS2: Vietnam game server with TKLMutator enabled.\n\n## Installation option 2 (download repository zip, Python 3.6 or newer required)\n\n1. Download [repository package (zip)](https://github.com/tuokri/tklserver/archive/master.zip)\nand extract it. Then follow the same steps as option 1 but ignore the `git clone` command.\n\n## Installation option 3 (download executable, no Python or Git needed)\n\n1. Download latest package from [releases](https://github.com/tuokri/tklserver/releases).\n\n2. Extract it and run `tklserver.exe`.\n\n## Updating\n\nIf you used Git to install TKLServer, do a `git pull` in the TKLServer directory.\nAlternatively you can just download the newest one and extract\nit over the old files.\n\nDouble-check your settings in `tklserver.ini` after updating.\n\n## Configuration examples\n\n### One RS2 server and one Discord webhook URL\n\nOne RS2: Vietnam game server process and one TKLServer process on the\nsame dedicated server machine.\n\n![1-server-1-webhook](1-server-1-webhook.png)\n\n**tklserver.ini** (in tklserver directory)\n```ini\n[tklserver]\nport=8586\nhost=localhost\n\n[rs2server.0000]\nwebhook_url=YOUR_SECRET_DISCORD_WEBHOOK_URL_HERE\n```\n\n**ROMutator_TKLMutator_Server.ini** (in RS2 server directory under `ROGame\\Config`).\nIf the file does not exists, launch RS2 game server once with TKLMutator enabled.\n\n```ini\n[TKLMutator.TKLMutator]\nbLogTeamKills=True\nbLogKills=False\nbSendLogToServer=True\nTKLFileName=KillLog\n\n[TKLMutator.TKLMutatorTcpLinkClient]\nTKLServerHost=localhost\nTKLServerPort=8586\nMaxRetries=5\nUniqueRS2ServerId=0000\n```\n\n`UniqueRS2ServerId` in **ROGame_TKLMutator.ini** references `[rs2server.0000]` in **tklserver.ini**.\nThis needs to change only when support for multiple RS2: Vietnam game servers is needed.\n\n`TKLServerPort` in **ROGame_TKLMutator.ini** must match `port` in **tklserver.ini**.\n\n`bSendLogToServer` must be `True` in **ROGame_TKLMutator.ini**.\n\n---\n\n**More configuration examples (multi server configuration, etc.) may be added if there is demand.**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftuokri%2Ftklserver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftuokri%2Ftklserver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftuokri%2Ftklserver/lists"}