diff --git a/docs/supported-games/community/astroneer.md b/docs/supported-games/community/astroneer.md index 603dc53..def2507 100644 --- a/docs/supported-games/community/astroneer.md +++ b/docs/supported-games/community/astroneer.md @@ -10,6 +10,10 @@ Takaro connects to your Astroneer dedicated server through the community-maintai For a product overview, see the [Astroneer server manager page](https://takaro.io/games/astroneer/). +:::note Version and module availability +Bridge, docs, and modules can be released separately. Use the upstream guide for setup, the GitHub releases page for bridge packages, and the Takaro module viewer for module availability. +::: + ## Prerequisites - An Astroneer dedicated server with file access diff --git a/docs/supported-games/community/dayz.md b/docs/supported-games/community/dayz.md index 667f35b..c0f5e98 100644 --- a/docs/supported-games/community/dayz.md +++ b/docs/supported-games/community/dayz.md @@ -8,6 +8,12 @@ import GameHero from '@site/src/components/GameHero'; Takaro connects to your DayZ server using the generic connector, the **@TakaroIntegration** server-side mod, and a small **DayZ-Bridge** Node.js sidecar that translates between the mod's HTTP and Takaro's WebSocket gameserver protocol. The integration enables real-time player events, player management, and remote server control. +For a product overview, see the [DayZ server manager page](https://takaro.io/games/dayz/). + +:::note Version and module availability +Bridge, docs, and modules can be released separately. Use the upstream guide for setup, the GitHub releases page for bridge packages, and the Takaro module viewer for module availability. +::: + ## Installation DayZ integration has two pieces: a server-side mod and a Node.js bridge sidecar. The mod is loaded via `-serverMod=`, so clients never download it. diff --git a/docs/supported-games/community/eco.md b/docs/supported-games/community/eco.md index 31afc2e..7eea908 100644 --- a/docs/supported-games/community/eco.md +++ b/docs/supported-games/community/eco.md @@ -10,6 +10,10 @@ Takaro connects to your Eco server through the community-maintained Takaro Integ For a product overview, see the [Eco server manager page](https://takaro.io/games/eco/). +:::note Version and module availability +Bridge, docs, and modules can be released separately. Use the upstream guide for setup, the GitHub releases page for bridge packages, and the Takaro module viewer for module availability. +::: + ## Prerequisites - An Eco server with file access diff --git a/docs/supported-games/community/index.mdx b/docs/supported-games/community/index.mdx index 033ec53..40ab477 100644 --- a/docs/supported-games/community/index.mdx +++ b/docs/supported-games/community/index.mdx @@ -28,6 +28,18 @@ Games supported through community-maintained integrations. These connectors are image="/img/games/eco.jpg" link="/supported-games/community/eco" /> + + + +Takaro connects to your Soulmask dedicated server through the community-maintained [Soulmask Bridge](https://mad-001.github.io/SoulmaskBridge/). The bridge runs next to the server, connects to Soulmask over RCON, watches server output, and connects outbound to Takaro. + +For a product overview, see the [Soulmask server manager page](https://takaro.io/games/soulmask/). + +:::info Community-supported integration +Soulmask support is maintained by the community. The Takaro team documents the setup path, but the game-specific bridge comes from the community project. +::: + +## Prerequisites + +- A Soulmask dedicated server with file access +- Node.js 18 or newer +- RCON enabled on the Soulmask server +- A Takaro registration token for a Generic game server +- The bridge IP allow-listed in Soulmask's `Engine.ini` + +## Enable Soulmask RCON + +Add RCON options to the Soulmask dedicated server startup command. The exact command depends on your host, but the upstream guide uses options like: + +```text +-rconport=25575 -rconpassword=your-password-here +``` + +Then allow the bridge host in `Engine.ini`: + +```ini +[Server.SafeIP] +IPList=127.0.0.1 +``` + +Use the IP address where the bridge runs. For a same-machine setup, `127.0.0.1` is usually enough. + +## Install the bridge + +Download the latest package from the [Soulmask Bridge releases page](https://github.com/mad-001/SoulmaskBridge/releases/latest) or follow the [upstream installation guide](https://mad-001.github.io/SoulmaskBridge/). + +If you clone the repository instead of using a packaged release, install and build it with Node.js: + +```bash +git clone https://github.com/mad-001/SoulmaskBridge.git +cd SoulmaskBridge +npm install +npm run build +``` + +## Configure Takaro + +Create or edit `TakaroConfig.txt` in the bridge folder: + +```ini +IDENTITY_TOKEN=my-soulmask-server +REGISTRATION_TOKEN=your-takaro-registration-token +TAKARO_API_URL=https://api.takaro.io +RCON_HOST=127.0.0.1 +RCON_PORT=25575 +RCON_PASSWORD=your-password-here +``` + +Use the same `RCON_PASSWORD` value as your Soulmask server startup command. + +To get a Takaro registration token, open the Takaro dashboard, add a game server, select **Generic** as the game type, and copy the registration token. + +## Start the bridge + +Start the Soulmask server, then start the bridge from the bridge folder. Keep the bridge running while the game server is online. + +The bridge should connect to Soulmask RCON and to Takaro. The server appears online in Takaro after the outbound connector connection succeeds. + +## What the bridge exposes + +The upstream project documents support for: + +- Player join and leave detection +- Chat forwarding +- Kick, ban, and unban actions +- Server messages +- Save and shutdown actions +- List bans +- Console command forwarding +- Automatic reconnect to RCON and Takaro + +Exact behavior depends on your bridge version and server configuration. + +## Verify the connection + +Check the bridge logs after startup. If Takaro does not show the server online, verify the Generic registration token, RCON host and port, RCON password, and the `[Server.SafeIP]` allow-list. + +For the upstream guide, see the [Soulmask Bridge documentation](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..2a0e06f --- /dev/null +++ b/docs/supported-games/community/voxel-turf.md @@ -0,0 +1,69 @@ +import GameHero from '@site/src/components/GameHero'; + + + +Takaro connects to your Voxel Turf server through the community-maintained [Voxel Turf Server Manager](https://mad-001.github.io/Voxel-Turf-Server-Manager/). The integration uses a Lua server mod, an auto-started bridge process, and Takaro's Generic connector. + +For a product overview, see the [Voxel Turf server manager page](https://takaro.io/games/voxel-turf/). + +:::info Community-supported integration +Voxel Turf support is maintained by the community. The Takaro team documents the setup path, but the game-specific bridge and Lua mod come from the community project. +::: + +## Prerequisites + +- A Voxel Turf dedicated server with file access +- Voxel Turf **1.9.9 beta** or newer, as listed by the upstream guide +- Node.js 18 or newer +- A Takaro registration token for a Generic game server + +The upstream guide notes that Voxel Turf 1.9.8 stable can run a server, but it does not expose the API required by the bridge. + +## Install the server manager + +Download the latest package from the [Voxel Turf Server Manager releases page](https://github.com/mad-001/Voxel-Turf-Server-Manager/releases/latest) or follow the [upstream installation guide](https://mad-001.github.io/Voxel-Turf-Server-Manager/). + +The community package includes the Lua mod and bridge files. Copy the mod files into your Voxel Turf server according to the upstream guide. + +## Configure Takaro + +Create or edit `TakaroConfig.txt` in the bridge folder: + +```ini +IDENTITY_TOKEN=my-voxel-turf-server +REGISTRATION_TOKEN=your-takaro-registration-token +TAKARO_API_URL=https://api.takaro.io +``` + +To get a Takaro registration token, open the Takaro dashboard, add a game server, select **Generic** as the game type, and copy the registration token. + +## Start the server + +Start your Voxel Turf server normally. The community setup auto-launches the bridge process with the server. + +After startup, the bridge should connect outbound to Takaro and the server should appear online in the Takaro dashboard. + +## What the bridge exposes + +The upstream project documents support for: + +- Player join and leave events +- Chat events and chat relay +- Death events +- Kick and ban actions +- Broadcast messages +- Give item, teleport, and inventory lookup actions +- Server start, stop, and world-save events +- Console command forwarding + +Exact behavior depends on your bridge version and what your Voxel Turf server exposes. + +## Verify the connection + +Check the Voxel Turf server console and bridge logs after startup. If Takaro does not show the server online, verify the Generic registration token, Node.js installation, and that you are running the Voxel Turf version required by the upstream guide. + +For the upstream guide, see the [Voxel Turf Server Manager documentation](https://mad-001.github.io/Voxel-Turf-Server-Manager/). diff --git a/docs/supported-games/index.mdx b/docs/supported-games/index.mdx index 310552e..6e9dcad 100644 --- a/docs/supported-games/index.mdx +++ b/docs/supported-games/index.mdx @@ -1,7 +1,7 @@ --- sidebar_position: 0 title: Supported Games -description: Takaro supports official and community-maintained game server integrations for Rust, 7 Days to Die, Minecraft, DayZ, Hytale, Palworld, Eco, and Astroneer. +description: Takaro supports official and community-maintained game server integrations for Rust, 7 Days to Die, Minecraft, DayZ, Hytale, Palworld, Eco, Astroneer, Voxel Turf, and Soulmask. --- import GameCard, { GameCardGrid } from '@site/src/components/GameCard'; @@ -58,6 +58,18 @@ Community integrations use Takaro's generic connector and are maintained by comm image="/img/games/eco.jpg" link="/supported-games/community/eco" /> + + + Soulmask + Stylized mask on a dark jungle background. + + + + + + + + + + + diff --git a/static/img/games/voxel-turf.svg b/static/img/games/voxel-turf.svg new file mode 100644 index 0000000..21a2dbb --- /dev/null +++ b/static/img/games/voxel-turf.svg @@ -0,0 +1,14 @@ + + Voxel Turf + Blocky city shapes on a dark purple background. + + + + + + + + + + +