diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index 9dd9cae..ee1a64c 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -25,7 +25,7 @@ jobs: - name: Generate token id: generate_token - if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository + if: github.event_name != 'pull_request' uses: actions/create-github-app-token@v2 with: app-id: ${{ secrets.TAKARO_CI_APP_ID }} @@ -34,13 +34,13 @@ jobs: repositories: takaro - name: Setup Node.js for TypeDoc - if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository + if: github.event_name != 'pull_request' uses: actions/setup-node@v4 with: node-version: '24.11.0' - name: Configure AWS credentials - if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository + if: github.event_name != 'pull_request' uses: aws-actions/configure-aws-credentials@v4 with: aws-access-key-id: ${{ secrets.AWS_ECR_CI_ACCESS_KEY_ID }} @@ -48,11 +48,11 @@ jobs: aws-region: eu-west-3 - name: Login to ECR - if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository + if: github.event_name != 'pull_request' run: aws ecr get-login-password | docker login --username AWS --password-stdin ${{ secrets.AWS_ECR_REGISTRY }} - name: Generate TypeDoc from main Takaro repo - if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository + if: github.event_name != 'pull_request' env: GH_TOKEN: ${{ steps.generate_token.outputs.token }} ECR_REGISTRY: ${{ secrets.AWS_ECR_REGISTRY }} @@ -77,7 +77,7 @@ jobs: uses: docker/setup-buildx-action@v3 - name: Login to Github Container Registry - if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository + if: github.event_name != 'pull_request' uses: docker/login-action@v3 with: registry: ghcr.io @@ -93,7 +93,7 @@ jobs: cache-to: type=inline sbom: true file: ./Dockerfile - push: ${{ github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository }} + push: ${{ github.event_name != 'pull_request' }} tags: ${{ steps.meta.outputs.tags }} labels: ${{ steps.meta.outputs.labels }} build-args: | diff --git a/docs/supported-games/community/astroneer.md b/docs/supported-games/community/astroneer.md index 603dc53..2054d54 100644 --- a/docs/supported-games/community/astroneer.md +++ b/docs/supported-games/community/astroneer.md @@ -87,3 +87,7 @@ The bridge should connect to Takaro and to Astroneer RCON. Keep the bridge runni Check the bridge window or `takaro-bridge.log`. Takaro should show the Astroneer server online after the WebSocket and RCON connections succeed. For the upstream guide, see the [Takaro Astroneer Bridge documentation](https://mad-001.github.io/takaro-astroneer-bridge/). + +## Version sync note + +The upstream Astroneer repository has had version drift between `package.json`, the public docs page, and GitHub Releases. When troubleshooting, check the downloaded bridge files and the latest repository state instead of relying on one version string alone. diff --git a/docs/supported-games/community/dayz.md b/docs/supported-games/community/dayz.md index 667f35b..2c20ece 100644 --- a/docs/supported-games/community/dayz.md +++ b/docs/supported-games/community/dayz.md @@ -88,3 +88,7 @@ Start the bridge first, then start the DayZ server. The bridge will register wit ## How Takaro Connects to Your DayZ Server DayZ's Enforce Script `RestApi` is HTTP-only, but Takaro's gameserver protocol is WebSocket-only. The DayZ-Bridge sidecar bridges the two: it connects to `wss://connect.takaro.io/`, listens on `127.0.0.1:8088` for the mod, forwards in-game events as Takaro `gameEvent` messages, and translates inbound Takaro requests (kicks, bans, teleports, item grants, broadcasts) into HTTP poll responses the mod consumes. For more details about how the generic connector works, see [Connection Architecture](/advanced/connection-architecture). + +## Release sync note + +The current upstream release checked for this page is `v0.1.14`, which added ammo and magazine item-list fixes. If item sync behaves differently, compare the installed release against the upstream release notes. diff --git a/docs/supported-games/community/eco.md b/docs/supported-games/community/eco.md index 31afc2e..77a4350 100644 --- a/docs/supported-games/community/eco.md +++ b/docs/supported-games/community/eco.md @@ -57,3 +57,7 @@ Restart the Eco server after saving `TakaroConfig.json`. The plugin connects to Open the Takaro dashboard and check that the Eco server appears online. If it does not, check the Eco server logs and confirm that `registrationToken` is correct. For the upstream guide, see the [Takaro Eco Integration documentation](https://mad-001.github.io/takaro-eco-integration/). + +## Version sync note + +The current upstream release checked for this page is `v1.2.1`. Some upstream README/changelog text may still mention older versions, so prefer the release package and `VERSION` file when validating installs. diff --git a/docs/supported-games/community/index.mdx b/docs/supported-games/community/index.mdx index 033ec53..b7b8e48 100644 --- a/docs/supported-games/community/index.mdx +++ b/docs/supported-games/community/index.mdx @@ -7,24 +7,24 @@ import GameCard, { GameCardGrid } from '@site/src/components/GameCard'; # Community Games -Games supported through community-maintained integrations. These connectors are developed and maintained by community members. +Games supported through community-maintained integrations. These connectors are developed and maintained by community members and usually connect to Takaro through the Generic game server type. @@ -36,8 +36,20 @@ Games supported through community-maintained integrations. These connectors are /> + + diff --git a/docs/supported-games/community/palworld.md b/docs/supported-games/community/palworld.md index 4496166..1189f9e 100644 --- a/docs/supported-games/community/palworld.md +++ b/docs/supported-games/community/palworld.md @@ -101,3 +101,7 @@ Restart the Palworld server after installing UE4SS and TakaroChat. Check the bridge logs after startup. The bridge should connect to Takaro and to the Palworld REST API. If Takaro does not show the server online, verify the registration token, REST API port, and admin password. For the upstream guide, see the [Palworld Bridge documentation](https://mad-001.github.io/Palworld-Bridge/). + +## Module sync note + +The Palworld repository also ships optional Takaro module exports under `TakaroModules/`. If Discord death notifications or player commands behave differently than described, compare the installed module export with the bridge version because the public docs and bundled modules can drift. diff --git a/docs/supported-games/community/soulmask.md b/docs/supported-games/community/soulmask.md new file mode 100644 index 0000000..0ef8133 --- /dev/null +++ b/docs/supported-games/community/soulmask.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 60 +title: Soulmask +--- + +# Soulmask + +Soulmask is supported through the community-maintained [Soulmask Bridge](https://mad-001.github.io/SoulmaskBridge/). + +:::info Community integration +This connector is maintained outside the Takaro core repo. Treat the bridge repository and latest release as the source of truth when the docs and module exports disagree. +::: + +## Current bridge status + +- Repository: [mad-001/SoulmaskBridge](https://github.com/mad-001/SoulmaskBridge) +- Latest checked package/release version: `v1.0.0` +- Install type: Node.js bridge using Soulmask RCON and `WS.log` parsing +- Takaro server type: `Generic` + +## Supported features + +- Player tracking from `WS.log` +- Chat forwarding after enabling `Set_OutputChats 1` +- Player list and reachability checks +- Server messaging, kick, ban, unban, shutdown, and raw command execution +- Empty inventory/item-list responses where Soulmask RCON cannot expose structured data + +:::warning Command sync note +The public docs mention “save world via Takaro”. The bridge source exposes shutdown through `SaveAndExit` and allows raw RCON through `executeCommand`; if you need a standalone save action, verify it in the installed bridge version first. +::: + +## Setup reference + +Use the community install guide for the full procedure: [Soulmask Bridge docs](https://mad-001.github.io/SoulmaskBridge/). diff --git a/docs/supported-games/community/voxel-turf.md b/docs/supported-games/community/voxel-turf.md new file mode 100644 index 0000000..5cfa50c --- /dev/null +++ b/docs/supported-games/community/voxel-turf.md @@ -0,0 +1,38 @@ +--- +sidebar_position: 20 +title: Voxel Turf +--- + +# Voxel Turf + +Voxel Turf is supported through the community-maintained [Voxel Turf Server Manager](https://mad-001.github.io/Voxel-Turf-Server-Manager/). + +:::info Community integration +This connector is maintained outside the Takaro core repo. Treat the bridge repository and latest release as the source of truth when the docs and module exports disagree. +::: + +## Current bridge status + +- Repository: [mad-001/Voxel-Turf-Server-Manager](https://github.com/mad-001/Voxel-Turf-Server-Manager) +- Latest checked release: `v2.4.1` +- Required game version: Voxel Turf `1.9.9` beta branch +- Install type: self-contained `winmm.dll` launcher plus `TakaroConnector` Lua mod +- Takaro server type: `Generic` + +## Supported features + +- Player join, leave, chat, and death events +- Server lifecycle log events for start, save, and stop +- Admin actions: kick, ban, unban, broadcast, give item, teleport, inventory read, and raw command execution +- Item catalog sync for Takaro shop/give-item pickers +- In-game `/takarostatus` admin status command + +## Important install notes + +- The latest release no longer requires a separate Node.js process or manually run `bridge.exe`; the release notes describe a self-contained `winmm.dll` flow. +- Keep update scripts pinned to `app_update 526340 -beta beta`. Updating back to Voxel Turf `1.9.8` breaks the connector API. +- Takaro item sync runs on its normal schedule, so shop items can take up to about an hour to appear after first connection. + +## Setup reference + +Use the community install guide for the full procedure: [Voxel Turf Server Manager docs](https://mad-001.github.io/Voxel-Turf-Server-Manager/). diff --git a/static/img/games/soulmask.jpg b/static/img/games/soulmask.jpg new file mode 100644 index 0000000..a7bcb0f Binary files /dev/null and b/static/img/games/soulmask.jpg differ diff --git a/static/img/games/voxel-turf.jpg b/static/img/games/voxel-turf.jpg new file mode 100644 index 0000000..87336a0 Binary files /dev/null and b/static/img/games/voxel-turf.jpg differ