Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions .github/workflows/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand All @@ -34,25 +34,25 @@ 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 }}
aws-secret-access-key: ${{ secrets.AWS_ECR_CI_SECRET_ACCESS_KEY }}
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 }}
Expand All @@ -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
Expand All @@ -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: |
Expand Down
4 changes: 4 additions & 0 deletions docs/supported-games/community/astroneer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 4 additions & 0 deletions docs/supported-games/community/dayz.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 4 additions & 0 deletions docs/supported-games/community/eco.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
22 changes: 17 additions & 5 deletions docs/supported-games/community/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<GameCardGrid>
<GameCard
title="Astroneer"
description="Space exploration and survival sandbox"
description="Native RCON bridge for player events, player list, reachability, and admin commands."
image="/img/games/astroneer.webp"
link="/supported-games/community/astroneer"
/>
<GameCard
title="DayZ"
description="Open-world post-apocalyptic survival game"
description="BattlEye RCON-backed moderation, item sync, player events, and server-side mod integration."
image="/img/games/dayz.jpg"
link="/supported-games/community/dayz"
/>
<GameCard
title="Eco"
description="Collaborative ecosystem simulation game"
description="Eco server mod for WebSocket integration, player events, chat, and admin commands."
image="/img/games/eco.jpg"
link="/supported-games/community/eco"
/>
Expand All @@ -36,8 +36,20 @@ Games supported through community-maintained integrations. These connectors are
/>
<GameCard
title="Palworld"
description="Creature collection and survival game"
description="Player tracking, admin actions, teleports, and Discord/chat relay through the community Palworld Bridge."
image="/img/games/palworld.avif"
link="/supported-games/community/palworld"
/>
<GameCard
title="Soulmask"
description="RCON and log-based bridge for player tracking, chat, moderation, and server commands."
image="/img/games/soulmask.jpg"
link="/supported-games/community/soulmask"
/>
<GameCard
title="Voxel Turf"
description="Join/leave/chat/death events, item catalog sync, admin actions, and server lifecycle logs."
image="/img/games/voxel-turf.jpg"
link="/supported-games/community/voxel-turf"
/>
</GameCardGrid>
4 changes: 4 additions & 0 deletions docs/supported-games/community/palworld.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
35 changes: 35 additions & 0 deletions docs/supported-games/community/soulmask.md
Original file line number Diff line number Diff line change
@@ -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/).
38 changes: 38 additions & 0 deletions docs/supported-games/community/voxel-turf.md
Original file line number Diff line number Diff line change
@@ -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/).
Binary file added static/img/games/soulmask.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/games/voxel-turf.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading