Create README documentation

[CAD97]

Working on getting the scripts working. Let's make it easier for the next cohort!

[CAD97]

Going to use this PR to dump everything I run into so we can map a clearer path through setup.

Initial state: installed latest Python, py -m pip install --upgrade pip, pip install wheel.

I cloned the repo as a subfolder in our project (@/TGP2BuildScripts/Build.py).

PS D:\p4\TGP2\Arcade-Racer\PigmentPenguins> py .\TGP2BuildScripts\Build.py -h
Traceback (most recent call last):
  File "D:\p4\TGP2\Arcade-Racer\PigmentPenguins\TGP2BuildScripts\Build.py", line 4, in <module>
    from Scripts.UpdateVersionNumber import update_version_number
  File "D:\p4\TGP2\Arcade-Racer\PigmentPenguins\TGP2BuildScripts\Scripts\UpdateVersionNumber.py", line 5, in <module>
    from P4 import P4, P4Exception
ModuleNotFoundError: No module named 'P4'

Alright, so who needs to provide the P4 module?

[CAD97]

Found the official p4python (which is not pip install p4; beware!). While not super easy to figure out, install instructions are provided in the system requirements file:

Installation via pip is provided as p4python. However, I'm getting a big wall of red text when trying to install...

PS D:\p4\TGP2\Arcade-Racer\PigmentPenguins> pip install p4python
Collecting p4python
  Using cached p4python-2020.1.2056111.tar.gz (78 kB)
Building wheels for collected packages: p4python
  Building wheel for p4python (setup.py) ... error
  ERROR: Command errored out with exit status 1:
   command: 'c:\users\christopher durham\appdata\local\programs\python\python39\python.exe' -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'C:\\Users\\Christopher Durham\\AppData\\Local\\Temp\\pip-install-50zt1l8e\\p4python_e45ccf63483841d180c07b752daf7c4b\\setup.py'"'"'; __file__='"'"'C:\\Users\\Christopher Durham\\AppData\\Local\\Temp\\pip-install-50zt1l8e\\p4python_e45ccf63483841d180c07b752daf7c4b\\setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' bdist_wheel -d 'C:\Users\Christopher Durham\AppData\Local\Temp\pip-wheel-cnvnv2wc'
       cwd: C:\Users\Christopher Durham\AppData\Local\Temp\pip-install-50zt1l8e\p4python_e45ccf63483841d180c07b752daf7c4b\
  Complete output (39 lines):
  running bdist_wheel
  running build
  running build_py
  creating build
  creating build\lib.win-amd64-3.9
  copying P4.py -> build\lib.win-amd64-3.9
  running build_ext
  ***********************************************
  ** Cannot build P4Python without SSL support **
  ***********************************************
  Traceback (most recent call last):
    File "<string>", line 1, in <module>
    File "C:\Users\Christopher Durham\AppData\Local\Temp\pip-install-50zt1l8e\p4python_e45ccf63483841d180c07b752daf7c4b\setup.py", line 475, in <module>
      do_setup()
    File "C:\Users\Christopher Durham\AppData\Local\Temp\pip-install-50zt1l8e\p4python_e45ccf63483841d180c07b752daf7c4b\setup.py", line 425, in do_setup
      setup(name=NAME,
    File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\site-packages\setuptools\__init__.py", line 165, in setup
      return distutils.core.setup(**attrs)
    File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\core.py", line 148, in setup
      dist.run_commands()
    File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\dist.py", line 966, in run_commands
      self.run_command(cmd)
    File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\dist.py", line 985, in run_command
      cmd_obj.run()
    File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\site-packages\wheel\bdist_wheel.py", line 299, in run
      self.run_command('build')
    File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\cmd.py", line 313, in run_command
      self.distribution.run_command(command)
    File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\dist.py", line 985, in run_command
      cmd_obj.run()
    File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\command\build.py", line 135, in run
      self.run_command(cmd_name)
    File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\cmd.py", line 313, in run_command
      self.distribution.run_command(command)
    File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\dist.py", line 985, in run_command
      cmd_obj.run()
    File "C:\Users\Christopher Durham\AppData\Local\Temp\pip-install-50zt1l8e\p4python_e45ccf63483841d180c07b752daf7c4b\setup.py", line 292, in run
      raise Exception("Parameter --ssl is needed")
  Exception: Parameter --ssl is needed
  ----------------------------------------
  ERROR: Failed building wheel for p4python
  Running setup.py clean for p4python
Failed to build p4python
Installing collected packages: p4python
    Running setup.py install for p4python ... error
    ERROR: Command errored out with exit status 1:
     command: 'c:\users\christopher durham\appdata\local\programs\python\python39\python.exe' -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'C:\\Users\\Christopher Durham\\AppData\\Local\\Temp\\pip-install-50zt1l8e\\p4python_e45ccf63483841d180c07b752daf7c4b\\setup.py'"'"'; __file__='"'"'C:\\Users\\Christopher Durham\\AppData\\Local\\Temp\\pip-install-50zt1l8e\\p4python_e45ccf63483841d180c07b752daf7c4b\\setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' install --record 'C:\Users\Christopher Durham\AppData\Local\Temp\pip-record-_ohgnd75\install-record.txt' --single-version-externally-managed --compile --install-headers 'c:\users\christopher durham\appdata\local\programs\python\python39\Include\p4python'
         cwd: C:\Users\Christopher Durham\AppData\Local\Temp\pip-install-50zt1l8e\p4python_e45ccf63483841d180c07b752daf7c4b\
    Complete output (41 lines):
    running install
    running build
    running build_py
    creating build
    creating build\lib.win-amd64-3.9
    copying P4.py -> build\lib.win-amd64-3.9
    running build_ext
    ***********************************************
    ** Cannot build P4Python without SSL support **
    ***********************************************
    Traceback (most recent call last):
      File "<string>", line 1, in <module>
      File "C:\Users\Christopher Durham\AppData\Local\Temp\pip-install-50zt1l8e\p4python_e45ccf63483841d180c07b752daf7c4b\setup.py", line 475, in <module>
        do_setup()
      File "C:\Users\Christopher Durham\AppData\Local\Temp\pip-install-50zt1l8e\p4python_e45ccf63483841d180c07b752daf7c4b\setup.py", line 425, in do_setup
        setup(name=NAME,
      File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\site-packages\setuptools\__init__.py", line 165, in setup
        return distutils.core.setup(**attrs)
      File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\core.py", line 148, in setup
        dist.run_commands()
      File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\dist.py", line 966, in run_commands
        self.run_command(cmd)
      File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\dist.py", line 985, in run_command
        cmd_obj.run()
      File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\site-packages\setuptools\command\install.py", line 61, in run
        return orig.install.run(self)
      File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\command\install.py", line 546, in run
        self.run_command('build')
      File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\cmd.py", line 313, in run_command
        self.distribution.run_command(command)
      File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\dist.py", line 985, in run_command
        cmd_obj.run()
      File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\command\build.py", line 135, in run
        self.run_command(cmd_name)
      File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\cmd.py", line 313, in run_command
        self.distribution.run_command(command)
      File "c:\users\christopher durham\appdata\local\programs\python\python39\lib\distutils\dist.py", line 985, in run_command
        cmd_obj.run()
      File "C:\Users\Christopher Durham\AppData\Local\Temp\pip-install-50zt1l8e\p4python_e45ccf63483841d180c07b752daf7c4b\setup.py", line 292, in run
        raise Exception("Parameter --ssl is needed")
    Exception: Parameter --ssl is needed
    ----------------------------------------
ERROR: Command errored out with exit status 1: 'c:\users\christopher durham\appdata\local\programs\python\python39\python.exe' -u -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'C:\\Users\\Christopher Durham\\AppData\\Local\\Temp\\pip-install-50zt1l8e\\p4python_e45ccf63483841d180c07b752daf7c4b\\setup.py'"'"'; __file__='"'"'C:\\Users\\Christopher Durham\\AppData\\Local\\Temp\\pip-install-50zt1l8e\\p4python_e45ccf63483841d180c07b752daf7c4b\\setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' install --record 'C:\Users\Christopher Durham\AppData\Local\Temp\pip-record-_ohgnd75\install-record.txt' --single-version-externally-managed --compile --install-headers 'c:\users\christopher durham\appdata\local\programs\python\python39\Include\p4python' Check the logs for full command output.

It looks like I'm missing SSL support?

[CAD97]

Here we go, an installer. This is not linked from the "Installing P4Python" page in a way that makes it easy to find.

And... installing that (via MSI) did not improve the situation. The P4 module is still missing.

[CAD97]

OK: installer wants Python 3.8, I had 3.9, and that was the issue. Pip install seems to be broken because of something different about how SSL is handled? Will add this to draft README later today and start laying rails.

[CAD97]

OK, I've documented my current understanding of setup and config.ini. Running the build script to test (and using Notepad++ to tail -f the log file), I'm hung on waiting for the p4 sync -f with no feedback. I am using network out the wazoo, so it's doing something, but I have no feedback.

[CAD97]

Oh... I told it to sync -f the entire TGP2 workspace (including the flash hacks)... whoops

[CAD97]

I'm getting an error on lighting build, specifying no maps to be built. It looks like we're trying to use None as a file path. Manually passing skip lighting for now, since I don't need to build lighting for no maps anyway.

Log

``` Building lighting for these maps: [2021.02.25-16.46.56:839][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'AllDesktop' [2021.02.25-16.46.56:859][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'Android' [2021.02.25-16.46.56:859][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'Android_ASTC' [2021.02.25-16.46.56:859][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'Android_DXT' [2021.02.25-16.46.56:859][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'Android_ETC2' [2021.02.25-16.46.56:859][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'AndroidClient' [2021.02.25-16.46.56:859][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'Android_ASTCClient' [2021.02.25-16.46.56:859][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'Android_DXTClient' [2021.02.25-16.46.56:859][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'Android_ETC2Client' [2021.02.25-16.46.56:859][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'Android_Multi' [2021.02.25-16.46.56:859][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'Android_MultiClient' [2021.02.25-16.46.56:878][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'IOSClient' [2021.02.25-16.46.56:878][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'IOS' [2021.02.25-16.46.56:886][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'Linux' [2021.02.25-16.46.56:893][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'LinuxNoEditor' [2021.02.25-16.46.56:900][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'LinuxClient' [2021.02.25-16.46.56:907][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'LinuxServer' [2021.02.25-16.46.56:914][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'LinuxAArch64NoEditor' [2021.02.25-16.46.56:922][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'LinuxAArch64Client' [2021.02.25-16.46.56:930][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'LinuxAArch64Server' [2021.02.25-16.46.56:952][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'Lumin' [2021.02.25-16.46.56:952][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'LuminClient' [2021.02.25-16.46.56:959][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'MacNoEditor' [2021.02.25-16.46.56:967][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'Mac' [2021.02.25-16.46.56:974][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'MacClient' [2021.02.25-16.46.56:982][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'MacServer' [2021.02.25-16.46.56:995][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'TVOSClient' [2021.02.25-16.46.56:995][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'TVOS' [2021.02.25-16.46.57:002][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'WindowsNoEditor' [2021.02.25-16.46.57:011][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'Windows' [2021.02.25-16.46.57:018][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'WindowsClient' [2021.02.25-16.46.57:026][ 0]LogTargetPlatformManager: Display: Loaded TargetPlatform 'WindowsServer' [2021.02.25-16.46.57:026][ 0]LogTargetPlatformManager: Display: Building Assets For Windows [2021.02.25-16.46.57:033][ 0]LogAudioDebug: Display: Lib vorbis DLL was dynamically loaded. [2021.02.25-16.46.57:092][ 0]LogShaderCompilers: Display: Using Local Shader Compiler. [2021.02.25-16.46.57:757][ 0]LogDerivedDataCache: Display: Max Cache Size: 512 MB [2021.02.25-16.46.57:801][ 0]LogDerivedDataCache: Display: Loaded Boot cache: C:/Users/Christopher Durham/AppData/Local/UnrealEngine/4.26/DerivedDataCache/Boot.ddc [2021.02.25-16.46.57:812][ 0]LogDerivedDataCache: Display: Pak cache opened for reading ../../../Engine/DerivedDataCache/Compressed.ddp. [2021.02.25-16.46.57:825][ 0]LogDerivedDataCache: Display: Performance to C:/Users/Christopher Durham/AppData/Local/UnrealEngine/Common/DerivedDataCache: Latency=0.02ms. RandomReadSpeed=280.69MBs, RandomWriteSpeed=107.87MBs. Assigned SpeedClass 'Local' [2021.02.25-16.46.58:445][ 0]LogUObjectGlobals: Warning: Failed to load '/Game/VehicleBP/VehicleOverview': Can't find file. [2021.02.25-16.46.58:445][ 0]LogUObjectGlobals: Warning: Failed to load '/Game/VehicleBP/VehicleOverview': Can't find file. [2021.02.25-16.46.58:445][ 0]LogUObjectGlobals: Warning: Failed to find object 'Class /Game/VehicleBP/VehicleOverview.VehicleOverview_C' [2021.02.25-16.46.58:897][ 0]LogAudioCaptureCore: Display: No Audio Capture implementations found. Audio input will be silent. [2021.02.25-16.46.58:897][ 0]LogAudioCaptureCore: Display: No Audio Capture implementations found. Audio input will be silent. [2021.02.25-16.46.59:682][ 0]LogContentCommandlet: Display: Lighing Build Quality is Production [2021.02.25-16.46.59:782][ 0]LogContentCommandlet: Display: Loading [2021.02.25-16.46.59:782][ 0]LogPackageName: Error: DoesPackageExist: DoesPackageExist FAILED: 'None' is not a standard unreal filename or a long path name. Reason: Path should start with a '/' [2021.02.25-16.46.59:783][ 0]LogUObjectGlobals: Warning: Failed to load '': Can't find file. [2021.02.25-16.46.59:792][ 0]LogContentCommandlet: Display: [REPORT] 0/1 packages were considered for resaving [2021.02.25-16.46.59:793][ 0]LogContentCommandlet: Display: [REPORT] 0/0 packages were resaved [2021.02.25-16.46.59:793][ 0]LogInit: Display: [2021.02.25-16.46.59:793][ 0]LogInit: Display: Warning/Error Summary (Unique only) [2021.02.25-16.46.59:793][ 0]LogInit: Display: ----------------------------------- [2021.02.25-16.46.59:793][ 0]LogInit: Display: LogPackageName: Error: DoesPackageExist: DoesPackageExist FAILED: 'None' is not a standard unreal filename or a long path name. Reason: Path should start with a '/' [2021.02.25-16.46.59:794][ 0]LogInit: Display: LogLuminAPIImpl: Warning: MLSDK not found. This likely means the MLSDK environment variable is not set. [2021.02.25-16.46.59:794][ 0]LogInit: Display: LogUObjectGlobals: Warning: Failed to load '/Game/VehicleBP/VehicleOverview': Can't find file. [2021.02.25-16.46.59:794][ 0]LogInit: Display: LogUObjectGlobals: Warning: Failed to find object 'Class /Game/VehicleBP/VehicleOverview.VehicleOverview_C' [2021.02.25-16.46.59:795][ 0]LogInit: Display: LogUObjectGlobals: Warning: Failed to load '': Can't find file. [2021.02.25-16.46.59:795][ 0]LogInit: Display: [2021.02.25-16.46.59:795][ 0]LogInit: Display: Failure - 1 error(s), 5 warning(s) [2021.02.25-16.46.59:795][ 0]LogInit: Display: Execution of commandlet took: 0.11 seconds [2021.02.25-16.46.59:856][ 0]LogShaderCompilers: Display: Shaders left to compile 0 [2021.02.25-16.46.59:923][ 0]LogHttp: Display: cleaning up 0 outstanding Http requests. [2021.02.25-16.47.00:068][ 0]LogContentStreaming: Display: There are 1 unreleased StreamingManagers Perforce error encountered ERROR: Failed to build the lighting ```

[CAD97]

Except for the lighting build issue, this should now be a full map to getting the build scripts running. I'm talking to steam, but the depot upload is failing; I believe this is a failure due to the upload scripts and not due to our scripts.