Merge pull request #26 from Cyrogon/main

Updated a few files

README.md

@@ -1,3 +1,17 @@
 # Stay In Tarkov Documentation
 
-https://docs.stayintarkov.com/
+This is the Stay In Tarkov documentation Repo, if you're looking for the docs, go here: https://docs.stayintarkov.com/
+
+# Contributing
+
+If you wish to contribute, the easier way is by using Visual Studio Code, and the extension "Run on Save" by emeraldwalk, found [here.](https://marketplace.visualstudio.com/items?itemName=emeraldwalk.RunOnSave) And open the workspace file, doing so will have the clear and build command run every time you save, making changes much easier and quicker to see.
+
+# Without Extension
+
+If you don't use VSCode or don't want an external extension, you can run the make.bat with the args `clean` and `html` to clear the build folder then build the docs again.
+
+# Localisation
+
+If you want to help localise Stay In Tarkov, check if the langauge you want to translate is already there, under the Locales folder. If it is you can edit the .po files and make a push request when done, otherwise you'll need to let someone in the Discord know so we can add it.
+
+* If you know how to use Sphinx and Sphinx-Intl to make locale files from the build, you can pull this project and make the locales yourself.

docs/locales/zh_CN/LC_MESSAGES/install.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: TestLocale 2.0\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-04-10 00:52+0100\n"
+"POT-Creation-Date: 2024-04-13 00:44+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language: zh_CN\n"
@@ -61,34 +61,40 @@ msgstr ""
 
 #: ../../source/install.rst:23
 msgid ""
+"**YOU MUST** run **LIVE** Tarkov at least once. If you don't, you forfeit"
+" all of you're mortal possessions to my dog."
+msgstr ""
+
+#: ../../source/install.rst:24
+msgid ""
 "**DON'T** install SIT in your original EFT game folder. **YOU HAVE BEEN "
 "WARNED!**"
 msgstr ""
 
-#: ../../source/install.rst:24
+#: ../../source/install.rst:25
 msgid ""
 "**ALWAYS** make sure you are able to run the game using the official game"
 " launcher before using SIT."
 msgstr ""
 
-#: ../../source/install.rst:25
+#: ../../source/install.rst:26
 msgid ""
 "**DON'T** take shortcuts. Follow this step by step. If you haven't, you "
 "will be **MOCKED**"
 msgstr ""
 
-#: ../../source/install.rst:30
+#: ../../source/install.rst:31
 msgid "Preparing the folder structure"
 msgstr ""
 
-#: ../../source/install.rst:32
+#: ../../source/install.rst:33
 msgid ""
 "Create the following folder structure on the drive of your choice, as "
 "long as it has enough space for |EFT|. The drive should have at least "
 "``60GB`` free space."
 msgstr ""
 
-#: ../../source/install.rst:35
+#: ../../source/install.rst:36
 msgid ""
 "**DO NOT** install the manager in a protected directory such as "
 "``system32``, ``Program Files``, and ``Program Files (x86)``, If you do I"

docs/locales/zh_CN/LC_MESSAGES/issues.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: TestLocale 2.0\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-04-10 00:52+0100\n"
+"POT-Creation-Date: 2024-04-13 00:44+0100\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language: zh_CN\n"
@@ -24,7 +24,7 @@ msgid "Common Issues"
 msgstr ""
 
 #: ../../source/issues.rst:10
-msgid "My Flea market doesn't have new offeres or trades?"
+msgid "Flea Market Issue"
 msgstr ""
 
 #: ../../source/issues.rst:13
@@ -230,3 +230,22 @@ msgstr ""
 msgid "|brs|"
 msgstr ""
 
+#: ../../source/issues.rst:138
+msgid "I'm getting \"Illegal Game Found\""
+msgstr ""
+
+#: ../../source/issues.rst:141
+msgid ""
+"In order to fix this issue you **MUST** follow every install step, "
+"properly, without skipping **anything**. I mean it, **ANYTHING**."
+msgstr ""
+
+#: ../../source/issues.rst:143
+msgid ""
+"If you are still getting the error, go `here. "
+"<https://www.escapefromtarkov.com/preorder-page>`_"
+msgstr ""
+
+#~ msgid "My Flea market doesn't have new offeres or trades?"
+#~ msgstr ""
+

docs/source/conf.py

@@ -19,7 +19,7 @@
 extensions = ['sphinxcontrib.video']
 templates_path = ['../templates']
 exclude_patterns = []
-
+html_css_files = ['css/custom.css']
 
 
 # -- Options for HTML output -------------------------------------------------

docs/source/install.rst

@@ -20,6 +20,7 @@ Getting started
 .. warning::
    * **DON'T** move your original EFT game folder following the installation.
    * **DON'T** change any of the files in your original EFT game folder.
+   * **YOU MUST** run **LIVE** Tarkov at least once. If you don't, you forfeit all of you're mortal possessions to my dog.
    * **DON'T** install SIT in your original EFT game folder. **YOU HAVE BEEN WARNED!**
    * **ALWAYS** make sure you are able to run the game using the official game launcher before using SIT.
    * **DON'T** take shortcuts. Follow this step by step. If you haven't, you will be **MOCKED**

docs/source/issues.rst

@@ -6,7 +6,7 @@ Common Issues
 
 .. _fleaissue:
 
-My Flea market doesn't have new offeres or trades?
+Flea Market Issue
 --------------------------------------------------
 
 
@@ -18,6 +18,8 @@ Follow these steps to correct the issue:
 
 3. Modify the ``messageWSUrlOverride`` field to include your local IP with the port ``:6969`` appended at the end (e.g., ``192.168.X.X:6969``).
 
+   * You can get your Local IP by opening ``cmd`` and typing ``ipconfig``
+
 4. Change ``useMessageWSUrlOverride`` to ``true``. Ensure the value ``true`` is in lowercase.
 
 5. Save the changes to the ``coopConfig.json`` file.
@@ -30,25 +32,13 @@ Follow these steps to correct the issue:
 
 If you're using Docker, follow these commands to update your IP configuration:
 
-1. Stop the SITCoop container:
-
-   .. code-block:: bash
-
-      docker stop sitcoop
-
-2. Retrieve your external IP address:
-
-   .. code-block:: bash
-
-      curl -4 icanhazip.com
-
-3. Edit the ``coopConfig.json`` file:
+1. Stop the SITCoop container using ``docker stop sitcoop``   
 
-   .. code-block:: bash
+2. Retrieve your external IP address using ``curl -4 icanhazip.com``
 
-      nano server/user/mods/SITCoop/config/coopConfig.json
+3. Edit the ``coopConfig.json`` file, using the command ``nano server/user/mods/SITCoop/config/coopConfig.json``
 
-   Update the file with the following configuration, replacing ``IP YOU GET FROM icanhazip.com`` with the IP address you obtained from the previous step:
+   Update the file with the following configuration, replacing ``messageWSUrlOverride`` with the IP you got from Step 2, and set ``useMessageWSUrlOverride`` to **TRUE**
 
    .. code-block:: json
 
@@ -57,14 +47,10 @@ If you're using Docker, follow these commands to update your IP configuration:
           "natHelperPort": 6971,
           "useUPNP": false,
           "useMessageWSUrlOverride": true, <--- SET THIS TO TRUE
-          "messageWSUrlOverride": "IP you get from icanhazip.com:6969"
+          "messageWSUrlOverride": "IP:6969"
       }
 
-4. Start the SITCoop container:
-
-   .. code-block:: bash
-
-      docker start sitcoop
+4. Start the SITCoop container using ``docker start sitcoop``
 
 By following these steps, you should be able to resolve the issue with the flea market not displaying new offers or trades in your AKI Server environment.
 
@@ -105,7 +91,7 @@ Aki.Server.exe Has Deleted itself
    For some reason windows defender is dectecting the Aki server as malware, this is a false postive, Aki have requested it not be flagged as malware, however this
    process can take more than a month to resolve, so in the meantime, add the server directory as an exeption to Windows Defender, like below:
 
-   (You will read Click 10 times, and you **WILL** enjoy it)
+   (You will read Click 9 times, and you **WILL** enjoy it)
 
 #. Open windows settings
 #. Click "Update and Security"
@@ -131,3 +117,13 @@ Aki.Server.exe Has Deleted itself
    </details>
 
 |brs|
+
+.. _naughty:
+
+I'm getting "Illegal Game Found"
+--------------------------------
+
+.. note::
+   In order to fix this issue you **MUST** follow every install step, properly, without skipping **anything**. I mean it, **ANYTHING**.
+
+   If you are still getting the error, go `here. <https://www.escapefromtarkov.com/preorder-page>`_