Better Docs for Workflow

[zstreeter]

Hi there, thanks so much for this great plugin! I'm trying to setup everything in my Unreal project but have some questions.

I'm not understanding how this plugin knows where my Unreal Engine is located. I see :UnrealGenWithEngine supposedly parses my Unreal Engine but how does it know where to look where I installed Unreal from source? After running this command the following json file is generated

{
    "version" : "0.0.2",
    "_comment": "dont forget to escape backslashes in EnginePath",
    "EngineDir": "",
    "Targets":  [
        {
            "TargetName" : "PrimePal-Editor",
            "Configuration" : "DebugGame",
            "withEditor" : true,
            "UbtExtraFlags" : "",
            "PlatformName" : "Win64"
        },
        {
            "TargetName" : "PrimePal",
            "Configuration" : "DebugGame",
            "withEditor" : false,
            "UbtExtraFlags" : "",
            "PlatformName" : "Win64"
        },
        {
            "TargetName" : "PrimePal-Editor",
            "Configuration" : "Development",
            "withEditor" : true,
            "UbtExtraFlags" : "",
            "PlatformName" : "Win64"
        },
    ]
}

[shortened for brevity]

Then running :UnrealGen to generate my projects json file, it asks for a number and I'm not sure what this means and doesn't seem to like me just testing with 1. Doesn't seem like my LSP has knowledge of all the header files after running both.

Running the build command it says there isn't a .bat file. I'm on linux so perhaps I need to change something to look for a bash script?

I think good documentation would help for general questions like mine. Also, any advice would be great! Thanks in advance!

[zadirion]

It's "EngineDir" which needs to be filled in by hand
Also the plugin unfortunately does not officially support linux. There are unofficial forks of the project I believe that attempted a linux port, you might have luck with them. Or you may offer to port it to linux, and your contribution would be greatly appreciated!

[corybsa]

I'm in the same boat as OP. I'm on Windows, filled in the EngineDir property and my LSP can't even parse my own project's files. Not sure what I'm doing wrong.