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

updated documentation for v0.9.0

Valmo Trindade
2025-02-01 04:24:03 -03:00
parent 1eaac0544b
commit 3d07c7abfb
3 changed files with 21 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,21 +1,27 @@
# Mission Maker's Guide
## Running OpenTAKServer
## Running the TAK Server
This guide assumes that i have already mastered 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 OpenTAKServer instance correctly. It's not a easy job for newcomers to the TAK environment but i will try to give a light on it: OpenTAKServer is stable on Ubuntu 22.04, the installer probably won't work on other linux distribution or version, you can install it on a old laptop, Raspberry Pi, AWS or whatever, check the [OTS Installation Documentation](https://docs.opentakserver.io/#installation/installation/) for more intel about this.
This guide assumes that i have already mastered 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.
## In Game Setup
With your OTS instance up and running, connect your ATAK/iTAK to test it, i also recommend you to use any HTTP client to test the OTS API, that's what will be used to pass the ARMATAK Markers and then let's run ARMATAK on your fancy tactical milsim operation, just remember this is a Work in Progress Arma 3 Addon:
![image](./data/init_config.png)
Assuming that you already have your OpenTAKServer, FreeTAKServer or USG TAK Server 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:
1. Open your mission in the 3den Editor and go to the Modules tab.
2. Select the "ARMATAK Core" 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 or linked units to the module, it will mark every player or controlled drone by it.
![image](./data/module.png)
4. Double Click on the module icon to fill your OpenTAKServer instance informations, pay attention on it, if you are using a dedicated server, be sure to add a adress reachable by the dedicated server, if the machine running the Arma 3 Server is the same as the one running the OTS instance, insert localhost on it, etecetera... The Username and Password must be a valid OTS user with API access.
![20240822014015_1](./data/atak_connected.jpg)
5. If everything is ok, when you start your scenario you will get this message on the top right corner and the marker will be showed in the real map location for every player on the session.
![image](./data/atakok_phone.png)
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. Also, remember that if a player is going to use the SIMTAK connection, linking the module wil make it mark a duplicated CoT.
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, etecetera...
5. If everything is ok, when you start your scenario you will get this message on the top right corner and the marker will be showed in the real map location for every module linked entity on the session.
if you are facing problems, or want some help, please join our [Discord](https://discord.com/invite/svK64PCycU) and let's check it.
### Tips
* Both FreeTAKServer and OpenTAKServer won't work well with many markers sent by a single connection, errors are expected, test your mission many time.
* TAK Server link with ARMATAK won't output 2 CoTs with the same callsign, soo after the game session ends is recommended to purge the server data and restart it.
* I am really trying to bypass this, but 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 script
```sqf
"armatak" callExtension ["cot_router:start",[<your_tak_instance_address:port>]];
```
if you are facing problems, or want some help, please join our [Discord](https://discord.com/invite/svK64PCycU) and let's check this out.

2
Arma-3-Players-Guide.md

@@ -56,7 +56,7 @@ On the server address, add your websocket address connection, if ARMATAK is runn
ws://<your address>:4152
```
If your computer running Arma 3 with ARMATAK and your phone are on the same Wifi router, the computer local address should be able to connect (ipconfig on command prompt and you will can check it), if your cellphone is not on the same network as your computer, you will have to port forward the port 4152 to your computer in order to allow external connections to ARMATAK socket. After pressing the connect button, you should check the following screen:
If your computer running Arma 3 with ARMATAK and your phone are on the same Wifi router, the computer local address should be able to connect (ipconfig on command prompt and you will can check it), if your cellphone is not on the same network as your computer, you will have to port forward the port 4152 to your computer in order to allow external connections to ARMATAK socket. **Remember, SIMTAK must connect into your computer's address, not the server address (unless you are the host)**. After pressing the connect button, you should check the following screen:
![ARMATAK INIT](./data/simtak_initialized.png)

10
Home.md

@@ -2,15 +2,7 @@
![ARMATAK FRAME LOGO](https://media.githubusercontent.com/media/valmojr/armatak/main/picture.png)
ARMATAK is a server side Arma 3 addons for streaming unit positions to TAK Clients in sessions on real locations maps. It basically sends HTTP requests to a OpenTAKServer API instance from your Game Server, converting the useful information as HTTP Requests right into the OpenTAKServer REST API as TAK entities soo the players can connect their WinTAK/ATAK/iTAK and game using the TAK features as a Blue Force Tracker or mission planning tool for Arma 3.
## Disclaimers
1. If you read the Project concept, there is a obvious limitation on using ARMATAK: it converts the Arma 3 Map location to a real world location, so let's use the Arma 3 Vanilla Maps (Altis...) as an examples, whatever the map developer had done different for real life, won't be showed by your TAK client map imagery, and there are MANY changes to be done in Arma 3 maps just for gameplay proposes, even when simulating real locations.
2. Another thing to consider is that this addon is running using the OpenTAKServer API, check the [OTS Docs](https://docs.opentakserver.io/) for more information. Both ARMATAK and OpenTAKServer are on development projects, don't expect a stable experience using it.
3. The TAK ecosystem have a slow learning curve (so does Arma), some YouTube channels i recommend is The [TAK Syndicate](https://www.youtube.com/@thetaksyndicate6234), [ATAK Maps](https://www.youtube.com/@ATAKMap) and [T Rex Labs](https://www.youtube.com/playlist?list=PLF9F26zKtAJ3d0jPgi80seK8-bSzlE2L9) to start learning, i don't think it's the perfect tool for situation awareness, but is the best tool we have publicly available right now, just remember that you must focus on data feeds, packages, planning and map editing tools, that is what you will use on ARMATAK addon.
4. Also, the whole TAK environment is developed to give information for the client, not remove information, so by using ARMATAK, that points to a single FTS instance, you have to assume that every user will be displayed on the TAK platform, even the ones on the other side, and the other side will can connect just by using the same address as the dedicated server, i wish i can have a different approach that could make possible using ARMATAK on PvP sessions, but that is what we have for now.
5. It is strongly recommended to use a dedicated OpenTAKServer instance;
ARMATAK is a server side Arma 3 addons for streaming unit positions to TAK Clients in sessions on real locations maps. It can be runned both as a clientside mod or a serverside mod, when runned serverside, it will create a TCP Socket connection between Arma 3 and the TAK Server, sending the game session information into it. When used clientside, Arma 3 will host a websocket server that you can connect to your phone and mock the phone's location to the player's in game location.
## Get in Touch