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

Updated Documentation about clientside eud connections

Valmo Trindade
2025-06-17 19:28:04 -03:00
parent a7ccca7f24
commit 78b95ed881
2 changed files with 20 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -6,27 +6,28 @@ This guide assumes that i have already understood the player's step by step to u
## 3Den Editor Setup
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:
Assuming that you already have your OpenTAKServer, FreeTAKServer or OG 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, now here is a arma 3 side stepguide:
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.
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.
## 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.
### Tips
* 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 same callsign, soo after the game session ends is recommended to purge the server data 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
* 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.
if you are facing problems, or want some help, please join our [Discord](https://discord.com/invite/svK64PCycU) and let's check this out.
## Known Issues
* Sometimes the WebSocket for connecting into SIMTAK and the TCP Socket for connecting into a TAK Server won't work if you had a previous game session opened, in order for the sockets to work, it must be runned once when game starts, soo after leaving a game session, restart your Arma 3 server or client if the socket didn't work properly.
* Sometimes the UDP Socket for clientside or the TCP Socket for serverside connections won't work if you had a previous game session opened, in order for the sockets to work, it must be runned once when game starts, soo after leaving a game session, restart your Arma 3 server or client if the socket didn't work properly.

68
Arma-3-Players-Guide.md

@@ -1,70 +1,26 @@
# ARMATAK Player's 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 ask your mission maker to link your unit into the ARMATAK CoT Router module, and it will be streamed on the TAK Server as a fake device connected to the server. The other and more complex way is to use SIMTAK, that will change your phone's location 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 location into it.
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.
ATAK -> Android App for Situation Awareness
ARMATAK -> Arma 3 mod that sends the player's position to a websocket connection
SIMTAK -> App that will connect into a websocket and mock the device's location based on information provided by the websocket.
CoT -> Cursor Over Time, is the marker designation on ATAK, you can have player's CoTs, NATO 2525c CoTs, custom draw CoTs...
* 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.
## Don't be doxxed
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 connected on TAK Server or VPN.
## Installation
### ATAK Installation
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). If you are not going to use SIMTAK, just go to your connections and add the desired TAK Server instance that your game session will use and you are good to go **using ATAK without SIMTAK is the easiest way to play with ARMATAK and can fit most of the newcomers**, but you will see a CoT as third person instead of yourself that is playing, that's why we have the feature to mock your phone's location.
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).
### ARMATAK Installation
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.
### SIMTAK Installation
## Usage
SIMTAK is not authorized to be on Google Play Store yet, here is a step by step about how to install it:
1. Download the [ARMATAK mod from Steam Workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=3301306282).
2. Open the Mod content folder (right click on the mod in the Arma 3 launcher -> Open Folder -> I understand)
3. Move the simtak.apk file to your android phone
4. Open the simtak.apk file on your phone, it's a android app installation package, in order to install a app from outside the playstore, you must explict authorize that.
5. Enable Developer mode on your phone
6. On Developer options (inside the settings), define SIMTAK as Default Fake Location App
### Samsung Devices
If you are using a Samsung device, there is a "Adaptive Battery" feature for battery saving that will break SIMTAK or apps that runs services on background. In order to solve it, users must follow the "Solution for users" tab on [this website](https://dontkillmyapp.com/samsung).
## ARMATAK and SIMTAK usage
**Remember to disable Battleye before starting the game**, after stating the game, right on briefing screen or inside the game already, ARMATAK's websocket should be running by default, but you can check if it's up and running on the log located in:
```path
<your arma 3 mod folder>/armatak.log
```
It should be getting something like this:
```log
2024-12-12T02:46:04.470687400-03:00 armatak::websocket - WebSocket server started.
2024-12-12T02:46:04.471617600-03:00 ws - Listening for new connections on 0.0.0.0:4152.
```
"0.0.0.0" means that your Socket connection is runnning on LAN, soo the phone must be on the same network as the computer running Arma 3. You can get your phone and open SIMTAK, it should look like this:
![Simtak Start](./data/simtak_start.png)
On the server address, add your websocket address connection, if ARMATAK is running fine, it should be like this:
```ip
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. **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)
If you cannot see the "Not Initialized" message, you're probably using a Samsung Phone with adaptive battery enabled, [check the installation step](#samsung-devices) to handle it. Now, you can press the "Start Tracking" button in order to connect to the WebSocket and start mocking the location.
![ATAK OK](./data/simta_success.png)
After started the connection, you should see those "Connection Server Success" messages, and then a message containing the player's information will be prompt every second, you can now switch to the ATAK app (without closing the SIMTAK app).
![ATAK OK](./data/atakok.png)
Arma 3 is opened with ARMATAK on your loaded mods, your phone has ATAK already connected to the TAK Server/VPN, if you wan't 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.