valmojr/armatak
1
0
Fork 0
mirror of https://github.com/valmojr/armatak.git synced 2026-06-13 15:43:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Docs for mTLS update

Valmo
2026-03-26 04:25:17 -03:00
parent 076c792441
commit 1ccdc3a74c
4 changed files with 178 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

113
Arma-3-Mission-Maker-Guide.md

@@ -1,29 +1,106 @@
# Mission Maker's Guide
# Mission Maker Guide
## Running the TAK Server
This guide covers the current server-side ARMATAK workflow for 3DEN and Zeus, you don't need to setup a full TAK Server in order to play Arma 3 with ARMATAK, but connecting the Arma Server to a TAK Server allows you to stream more game data than the player's location itself. This guide won't get deep into a TAK Server configuration, you may have many options, the simplest one is paying a group at [IronTAK](https://irontak.com)
This guide assumes that i have already understood the player's step by step to use ARMATAK, especially for helping newcomers as the mission maker. In order to fully run ARMATAK, you must have already configured a TAK Server (i highly recommend you to use [OpenTAKServer](https://docs.opentakserver.io/)) instance correctly. It's not a easy job for newcomers to the TAK environment but i always try to give a light on it. Check if your desired map is [already supported by ARMATAK](https://discord.com/channels/1261763286064562226/1262521841822470165), if not, you can [help to integrate it](https://discord.com/channels/1261763286064562226/1335297747435393146/1335297747435393146)
## Before You Start
## 3Den Editor Setup
You need:
- an Arma 3 mission with ARMATAK loaded
- a TAK-compatible backend such as TAK Server, IronTAK or OpenTAKServer.
- at least one TAK client already connected, so you can verify the feed
Assuming that you already have your OpenTAKServer, OG TAK Server or whatever instance up and running, connect your ATAK/WinTAK/iTAK to test the connection between your device, the communication between the ARMATAK Socket and the TAK Server os done using a TCP Connection (at least for now), remember to check if it`s enabled, now here is a arma 3 side stepguide:
ARMATAK can publish through two transport modes:
- `CoT Router (TCP)`
- `CoT Router (Authenticated)`
1. Open the mission in the 3den Editor and go to the Modules tab.
2. Select the "Team Awareness Kit -> ARMATAK CoT Router" to your scenario
3. Place it anywhere on the Map, in the current state of this project, there will be no different behavior on the location, this module will transmit every **linked** unit or vehicle connected to it, just remember to link the units, not the groups.
4. Double Click on the module icon to fill your TAK Server instance informations with address (without any protocol like http as preffix) and the port number (default for TCP is 8088, only TCP is supported for now), pay attention on it, if you are using a dedicated server, be sure to add a address reachable by the dedicated server, if the machine running the Arma 3 Server is the same as the one running the TAK Server instance, insert localhost on it, if the TAK server and Arma 3 Server are in different local network it must be the external ip address, etecetera...
5. If everything is ok, when you start your scenario you will get this message on the top right corner and the markers will be showed in the real map location for every module linked entity on the session, player units will stop being sent by the serverside armatak module when the unit player connects his EUD to the clientside module (to avoid duplicated markers), but it's up to the player to connect his EUD to the TAK Server and configure group side, role and callsign.
Use the authenticated mode unless you intentionally want a legacy unauthenticated TCP feed.
## Which Module Should You Use
### CoT Router (TCP)
Use this only if your server exposes unauthenticated TCP ingress.
Fields:
- `TAK Server Address`
- `TAK Server TCP Port`
Typical port:
- `8088`
### CoT Router (Authenticated)
This is the recommended mode.
Fields:
- `TAK Server Address`
- `Enrollment HTTPS Port`
- `Enrollment Username`
- `Enrollment Password`
Typical port:
- `8446` for enrollment
## 3DEN Setup
1. Open your mission in the 3DEN editor.
2. Go to the modules list.
3. Place either `CoT Router (TCP)` or `CoT Router (Authenticated)`.
4. Fill only the fields required by that module.
5. Sync the module to the entities you want to export.
Notes:
- Sync units and vehicles, not groups.
- The module position on the map does not change behavior.
- The Arma server must be able to reach the TAK server address you configure.
## Zeus Setup
1. Using Zeus, use the CoT Router module, it will ask for the TAK Server and used port (remember that it must be a unsecure TCP connection), you should get a "Connected to Socket" message.
2. Use the Mark Entity module on the entities you want to mark, be aware that groups are not allowed, you must select each unit, vehicles or static props are allowed.
3. Same advise about user's EUD connected is applied.
The same router modes are available in Zeus:
- `CoT Router (TCP, Zeus)`
- `CoT Router (Authenticated, Zeus)`
### Tips
After opening the dialog:
1. Fill the required fields.
2. Confirm the connection.
3. Use `Mark Entity` on the units or vehicles you want to publish.
* Both FreeTAKServer and OpenTAKServer won't work well with many markers sent by a single connection, errors are expected, test your mission a few times.
* OpenTAKServer link with ARMATAK won't output 2 CoTs with the exact same callsign and id, soo after the game session ends is recommended to purge the open tak server data on the web ui and restart it.
* There is a severe change that the socket will disconnect in long time persitent missions, and the player/server admin will have to manually restart the server using the CoT Router zeus module, i am working on it.
Notes:
- `Mark Entity` is entity-based, not group-based.
- Units, vehicles and relevant world objects can be exported depending on the available CoT conversion path.
if you are facing problems, or want some help, please join our [Discord](https://discord.com/invite/svK64PCycU) and let's check this out.
## What Gets Published
The server-side router currently emits CoT for:
- infantry units
- vehicles
- autonomous vehicles and drones
- digital pointers
- selected custom markers and draw data exposed by the addon
The router runs continuously while the mission is active and republishes the synced entities on a timed loop.
## Recommended IronTAK Setup
If you use IronTAK:
- create a technical user for the session or server
- assign that user only to the groups that should receive the feed
- use `CoT Router (Authenticated)`
That gives the session a real authenticated identity and lets IronTAK apply normal group scope and ACL logic.
## Troubleshooting
If nothing appears in TAK:
- confirm the TAK client itself is connected and healthy
- confirm the Arma server can resolve and reach the configured host
- if you are using `CoT Router (TCP)`, confirm unauthenticated TCP is actually enabled on the server
- if you are using `CoT Router (Authenticated)`, confirm enrollment credentials are valid
- check `armatak.log` on the Arma side for transport errors
If the feed worked but later stopped:
- restart the router module through Zeus
- verify the TAK backend is still accepting the target transport
- inspect `armatak.log` and server logs together
If you need help, join the [Discord](https://discord.gg/svK64PCycU).

71
Arma-3-Players-Guide.md

@@ -1,28 +1,71 @@
# ARMATAK Player's Guide
# Player Guide
For the newcomers to the TAK environment: ATAK (Android Team Awareness Kit) is a Situation Awareness application used by many military, law enforcement and concerned citizens in the world. In game, you can use it as a realistic blue force tracker to know where your allies are, where they are pointing and share information. If you have never used it, take some time to test it before you join a game session that will use ATAK with ARMATAK. Using the ARMATAK mod, you have two ways to use ATAK, the first and simple one is to connect to the TAK Server or network defined by your mission maker, you will be able to see the points as in "third person" view, it won't mock your phone's info, but you will be able to see stuff. The other and a bit more complex way is to connect your Arma 3 to the ATAK UDP Socket, that will change your phone's location, bearing and speed into the game's location and there is no better way to simulate a phone in the arma 3 scenario that moving the phone's geoinformation into it.
ARMATAK can be used in two different ways from a player's perspective:
- passive viewing, where the mission server publishes the game state and you just connect your TAK client on the same network to check it.
- active EUD integration, where your own ATAK device follows your in-game position, pretending that your phone's GPS is pointing to Altis (or whatever map you want).
* ATAK -> Android App for Situation Awareness
* ARMATAK -> Arma 3 mod that sends the player's position to a websocket connection
* CoT -> Cursor Over Time, is the marker designation on ATAK, you can have player's CoTs, NATO 2525c CoTs, custom draw CoTs...
* EUD -> End User Device, your phone, tablet, desktop or any device that will use ATAK.
## Basic Terms
## Don't be doxxed
- `ATAK`: Android Team Awareness Kit
- `TAK`: the broader ecosystem and protocol family
- `CoT`: Cursor on Target XML used to exchange entities, markers and events
- `EUD`: end-user device such as a phone, tablet or laptop running a TAK client
Be advised, since in most cases you will be sending your phone's location to the TAK Server/Network, it's highly recommended to hide your real location using a Fake GPS app. ARMATAK Client Socket will work even when you are using it because it will connect directly into the ATAK app. ATAK will only shows your in game location when Arma 3 is running and ARMATAK is connected to the ATAK Socket, if somehow your game crashes or your phone's socket disconect, you will send your real location to everyone.
## What You Need
- ARMATAK loaded in Arma 3
- a TAK client such as ATAK, WinTAK or iTAK
- the TAK server or network details provided by the mission maker
## Third Person EUD
If the mission maker is running the server-side CoT router, the simplest path is:
1. Connect your TAK client to the mission's TAK server.
2. Join the Arma session.
3. Watch the feed in TAK.
In this mode, you do not need to connect your phone directly to Arma. The Arma mission server is already exporting the data for you.
## First Person EUD
If the mission uses the client-side ARMATAK workflow, you can connect your own ATAK device to Arma and have it reflect your in-game movement.
Typical flow:
1. Connect the TAK client to the correct TAK server or network.
2. Open Arma 3 with ARMATAK loaded.
3. Use the ARMATAK action to connect to your EUD.
4. Enter your device local network address when prompted.
5. Confirm the TAK client is now following the in-game location instead of the real device location.
6. If you are playing on single player, you are good to go, if not, your phone must connect to the same TAK Server, local network or VPN as the other players.
## Privacy Warning
If you are using the client-side EUD integration, be careful with your real location.
If the EUD link drops and your TAK client falls back to the physical device GPS, you may start transmitting your real position again. If that matters for your setup, use a fake GPS workflow or test on a controlled network first. IronTAK will filter your real location if needed, but other TAK Server providers won't.
## Installation
### ATAK Installation
### TAK Client
ATAK-CIV is publicly available on [Play Store](https://play.google.com/store/apps/details?id=com.atakmap.app.civ&hl=pt_BR), download and authorize the permissions on your phone (there are many of them, but it quite makes sense because of the functions required).
ATAK-CIV is publicly available on the [Play Store](https://play.google.com/store/apps/details?id=com.atakmap.app.civ&hl=pt_BR).
### ARMATAK Installation
### ARMATAK
ARMATAK is publicy available in the Arma 3 Steam Workshop and Github, just subscribe on Steam Workshop and Steam should handle the installation of ARMATAK.
ARMATAK is available through the Arma 3 Steam Workshop and GitHub releases.
## Usage
## Troubleshooting
Arma 3 is opened with ARMATAK on your loaded mods, your phone has ATAK already connected to the TAK Server/VPN, if you want to just see the points in third person, you are good to go with the mission maker's defined entities to be displayed on TAK Server, BUT, if you wan't to go full deep into ATAK, there will be a ACE Self action called "Connect to EUD", this action will popup a form asking for your phone's local network address (if you are not connected to the same LAN in your computer and laptop this will make things way harder, you have to forward the phone's UDP socket port). Check this video to illustrate, after getting the "EUD Connected" message, you are good to go.
If you do not see the mission feed:
- confirm your TAK client is connected to the correct server
- confirm the mission maker actually enabled a CoT router module
- confirm you are in the right groups or channels if the TAK Server enforces transmission scope
If your EUD integration is not working:
- confirm your device and PC can reach each other
- confirm the address entered in Arma is correct
- check whether a VPN, firewall or separate LAN is blocking the socket
## Video Example
[![Watch the video](https://www.youtube.com/watch?v=uJeEk__O_NA/0.jpg)](https://www.youtube.com/watch?v=uJeEk__O_NA)

24
Home.md

@@ -1,9 +1,27 @@
# Project Concept
# ARMATAK
![ARMATAK FRAME LOGO](https://media.githubusercontent.com/media/valmojr/armatak/main/picture.png)
ARMATAK allow players to check in game information on a ATAK device, using your phone as a real Blue Force Tracker with 3D imagery and video feed from the player's PoV. This mod needs a configured ATAK Server in order to work, check the documentation on GitHub or hop on Discord to get it working.
ARMATAK is an Arma 3 addon that bridges game data into the TAK ecosystem.
It supports two different workflows:
- client-side EUD integration, where a player's device follows their in-game position
- server-side CoT routing, where an Arma mission or dedicated server publishes entities directly to a TAK-compatible server
## What It Can Do
- Send unit, vehicle, pointer and marker CoT from Arma 3 to TAK.
- Mirror Arma session data into ATAK, WinTAK or other TAK-compatible clients.
- Use a simple legacy TCP route when your server exposes an unauthenticated TAK ingress.
- Use TAK-style client certificate enrollment and then publish over authenticated mTLS.
## Main Guides
- [Mission Maker Guide](./Arma-3-Mission-Maker-Guide)
- [Player Guide](./Arma-3-Players-Guide)
- [Authenticated CoT Router Guide](./Authenticated-CoT-Router)
- [Video Streaming Guide](./Video-Streaming-Guide)
## Get in Touch
[Join the Discord Server for ARMATAK!](https://discord.gg/svK64PCycU)
[Join the Discord Server for ARMATAK!](https://discord.gg/svK64PCycU)

9
_Sidebar.md

@@ -1,10 +1,11 @@
# ARMATAK
This is a Arma 3 addon for streaming unit locations to TAK End User Devices.
Arma 3 addon for streaming game data into the TAK ecosystem.
* [Home](./)
* [Player's Step guide](./Arma-3-Players-Guide)
* [Mission Maker's Step guide](./Arma-3-Mission-Maker-Guide)
* [Video Stream Step guide](./Video-Streaming-Guide)
* [Player Guide](./Arma-3-Players-Guide)
* [Mission Maker Guide](./Arma-3-Mission-Maker-Guide)
* [Authenticated CoT Router](./Authenticated-CoT-Router)
* [Video Streaming Guide](./Video-Streaming-Guide)
![image](https://github.com/user-attachments/assets/174fc70e-b8fb-4579-967a-6e79dce84038)