updated Player's guide

Arma-3-Players-Guide.md

@@ -1,24 +1,59 @@
-![ATAK phone](https://www.mvrsimulation.com/sites/default/files/m-img/s-2023/ATAK_Integration.jpg)
+# ARMATAK Player`s Guide
 
-For the Arma 3 players, starting on ATAK environment is a little bit of a mess, the app is not user friendly and most of the configuration are not out of the packaged done. Before jumping into a Arma 3 game sessions using ARMATAK, i highly recommend you to spend some time playing with the ATAK app doing this stuff:
+It's highly recommended to configure ARMATAK stuff locally BEFORE you're joining a multiplayer session.
 
-## Introduction for Arma 3 Players using ARMATAK and OpenTAKServer  
+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.
 
-* Install map imagery with the data packages from [ATAK Maps releases](https://github.com/joshuafuller/ATAK-Maps).  
-* Check out some ATAK tutoriais/introduction from [TRex Arms](https://www.youtube.com/watch?v=WXuQERL_e8M&list=PLH2nRtwLhBm-EUXR-_17QrkVRbnJBK7az), [COTAK](https://www.youtube.com/watch?v=GVMSY_oPg10), [TAK Syndicate](https://www.youtube.com/watch?v=NF_FugV94DY), and many others
-* Draw some info on the map  
-* Try to send video feeds from your computer or cellphone  
+## Installation
 
-## iPhone Users Instructions
+### ATAK Installation
 
-1. Buy a android phone  
-2. Follow the Steps bellow  
+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, it quite makes sense because of the functions required).
 
-## Android Users Instructions
+Steps:
 
-1. Download and install ATAK-CIV from the [Play Store](https://play.google.com/store/apps/details?id=com.atakmap.app.civ).  
-2. Open ATAK and go to Settings > Network Preferences > TAK Servers > Add.  
-3. Insert the OTS instance connection information (the briefing diary or your mission maker should be able to provide you that).  
-4. Grab and install the Data Packages from the OTS instance for mapping and mission information if provided.
-5. Send some messages using GeoChat to your buddies to check your server connection.  
-6. Start your game and have fun with enhanced situation awareness.
+1. Download the [ARMATAK mod from Steam Workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=3301306282).
+2. Open the Mod content folder
+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.  
+
+**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
+
+Just by starting a game (even on briefing screen), ARMATAK's websocket will 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.
+```
+
+Then 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. 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 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)

Home.md

@@ -10,8 +10,8 @@ ARMATAK is a server side Arma 3 addons for streaming unit positions to TAK Clien
 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 server;
+5. It is strongly recommended to use a dedicated OpenTAKServer instance;
 
 # Get in Touch
 
-[Join the Discord Server for ARMATAK!](https://discord.gg/svK64PCycU)
+[Join the Discord Server for ARMATAK!](https://discord.gg/svK64PCycU)