latexandmore/SupCom/IMPORTANT-INSTRUCTIONS_AND_README.txt

Never execute any commands you do not understand!

*** WINDOWS ***
** If you already have an SCFA Folder/Installation **
1. Unpack the SupComFA-patchonly.zip somewhere (replace any older ones)
2. Change FAForever/fa_path.lua to $PFAD/SCFA (like M:/FA/SCFA, forward slashes are necessary)
3. execute forgedalliance.exe in FAForever/bin (NOT the one in the SCFA directory)
** Otherwise **
1. Unpack the SupComFA-full.zip somewhere (YOU DO NOT NEED THE patch-only.zip!!!)
2. execute forgedalliance.exe in FAForever/bin (NOT the one in the SCFA directory)
3. DON'T touch the fa_path.lua

*** LINUX TRY FIRST ***
- unpack
- winetricks d3dx9
- cd into /bin
- replace the resolution with the resolution of your screen and execute
    $ wine explorer /desktop=FA,1920x1080 ForgedAlliance.exe

*** LINUX EXTENDED ***
- you need wine32 bit and winetricks:
    $ sudo dpkg --add-architecture i386 && apt-get update && apt-get install wine32 && apt-get install winetricks
- you need the winetricks vcrun2010, dotnet40, corefonts, d3dx9, d3dx9_36
    $ export WINE=wine32
    $ winetricks vcrun2010 dotnet40 corefonts d3dx9 d3dx9_36
- put the X3DAudio1_2.dll in related into wine/system32 if it's not there already
    $ cp $PATH/related/3DAudio1_2.dll ~/.wine/drive_c/windows/system32/
- set your vram size in winetricks (use 512 if in doubt)
    $ winetricks videomemorysize=$YOURVRAM
- cd into bin dir and go wine ForgedAlliance.exe
    $ cd $PATH/SupComFA-full/bin/
    $ wine ForgedAlliance.exe

*** Common Errors on Windows ***
This game needs .NET-Framework 4.0 or higher and directX 9.c. Most PCs already
have both, some older might not.

*** Common Errors on Linux ***
-   AudioDLL blablabla is missing -> wine for WHATEVER reasonsometimes creates
    an empty version of that dll in .wine/dosdevices/ if you try to start the game
    without that dll, you have to replace it with the correct dll and start again
-   videomemorysize might default to 256, that will cause the game hang 
    during intro sequence or lead to blackscreen as soon as the game started
-   cant compile carthographic.fx/cant load it -> you forgot to install d3dx9_36
-   wine asking for some XML microsoft parser -> just follow wine instructions
-   wine saying that .wine is a 64 bit installation -> delete .wine, move it or
    select different director (i suppose there is an option for that)

*** Windowmanger Problems  ***
    - general displaying problems -> try to emulate a virtual desktop, this will fix it for many windowmangers:
        $ winecfg
      navigate to graphics, x Emulate virtual desktop and capture mouse, apply'nn  close
      --> in herbstluftwm windowed mode has higher FPS, why is beyond me 
      --> use Mod-F in herbstluft wm for fullscreen
    - you can start SupCom without a windowmanger:
        $ get a tty without a windowmanger (usually Ctrl-Alt-{2-5})
      if you just want to go with:
        $ startx wine32 /path/to/ForgedAlliance.exe
      you will have to change the path in fa_path.lua from ../SCFA/ to a full path
      if you don't want to do this or if you are playing from an usb stick you can
      start a terminal, cd into directory within that terminal and execute wine there:
        $ startx xterm
        $ cd /path/to/bin
        $ wine32 ForgedAlliance.exe
      i recommend you set the resolution ingame,

*** Performance under Linux ***
If you know what you are doing you can try this to imrpove CPU-wise performance:
        $ taskset -cp 0 (pgrep ForgedAlliance); sudo renice -2 -p (pgrep ForgedAlliance)
Graphics:
    - GTX460 60 FPS at high settings and 1920x1080 resolution
        Windowmanger impact (relative to above solution without windowmanger):
            - no manager        100%   
            - i3                100%
            - xfce              85%
            - kde               80%
            - herbstluftwm      75%
    - (not much) suprisingly my laptop (integrated Intel  HD4400)with better driver 
      support for linux performed only slightly worse at ~18 FPS which is more or
      less the same as with windows

*** Dual Screens under Linux? ***
Heavily depends on videodriver. If SupCom doesnt show you a second adapter, better forget it.

*** What is this? ***
It's a modified FAForever Client at version 0.12.0,
this version is know to run stable with most legacy version. The
gamefiles in the SCFA directory are an unpatched original CD version
however any official version (Steam aka 1.X/3599) and the Community
beta-Patch 3605 should work. Gamefiles that have been patched since
then are loaded from the files in FAForever/gamedata. The version of
those files is a variation of 3667.0 (no other will work).

*** Can I use the gamefiles to play online? ***
Yes, FAForever does not check CD keys (it could not even if it wanted to),
so you can use the SCFA "installation" within the SCFA directory. You have
to download the Official Client version from "faforever.com". It will promt
you for the location of the SCFA directory as soon as you try to play a game.

*** Can I play online with linux? ***
Yes, but it might be a little tricky to get the FAForever-Client to run on linux.
An easy solution could be to use the inofficial java client:
    http://faforever.github.io/downlords-faf-client/
Check the main Linux Thread on FAF Forums for usefull information:
    http://forums.faforever.com/viewtopic.php?f=2&t=4507&hilit=linux

*** Can I play online without the client? ***
Short answer: No, use the client.
Long answer: Yes, SupCom is p2p, so you can enter any IPv4 address in Multiplayer-Lan
and connect to it if the ports are forwarded correctly. (TCP 6112 + UDP 6112 and 9103)
Such a game has to be hosted like a normal Multiplayer-Lan game. You cannot however
join a game that is hosted via the FAFServer, that both the official and the
java client use. Even if you manage to join the game, you will desynchronize.
Also Steam has it's own multiplayer, but it suffers from unpatched bugs, horrible
state of gamebalance and nonexistant tech-support.
    
*** Handbook/Gameplay-Help ***
There is a pdf-Version of the original Handbook in the "related" directory, though the
Information you find there probably only of limited use (as they are very basic), try
    http://wiki.faforever.com/index.php?title=Main_Page 
for more Information.
If you like video tutorials, here is a good collection (if in doubt start with 5):
    https://www.youtube.com/watch?v=0QhM7oC-t7U&list=PLWe0mYs3ObwL36zemynMh5G4b-3s5vol0

*** Changes from default FAF-3667.0-12-pre2+1174 ***
- deleted various (for lanmode) obsolete files
- changed maps/mods origin from normal path to "../"
- changed lua.nxt2/lua/ui/dialogs/score.lua
    - EscapeHandler.SafeQuit() to ExitGame() [so it will quit to main menu instead of Desktop]
    - changed tooltip in the same file in line 426 and 460
- changed lua_path to point ../ instead of default gamefiles path
- removed report of teamkills in ui/dialogs/teamkill
- modified default keymap for legacy GAZ-UI