Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve installation documentation #27

Open
Swizzler121 opened this issue Dec 6, 2021 · 1 comment
Open

Improve installation documentation #27

Swizzler121 opened this issue Dec 6, 2021 · 1 comment

Comments

@Swizzler121
Copy link

Swizzler121 commented Dec 6, 2021

I provide the occasional assistance with Linux newbies on help forums. One brought this project to my attention when they were attempting to get one of their games working with their controller.

Your install documentation is a bit lacking, especially for new linux users:

  • download and extract the latest release

Does it matter where you extract it to? does it only temporarily use that folder, or will it live in that folder from then on? Possibly suggest a default location

Bonus points for explaining how to extract a .tar.gz file for newbies who have never encountered them before

  • if you are using Wine run winetricks --force setup_dumbxinputemu.verb

I don't use winetricks much, so even this is greek to me. Once again, does this require that the directory I extracted the files to need to stay the same before I run this setup? If so providing a default extract location would be helpful, as without it I might extract it to a temporary folder or the downloads folder.

bonus points for explaining you need to navigate to the directory you extracted the files to and run the command. Also might specify if the command needs to be run as sudo, or if running the command as sudo will cause problems (I know when I first started out on linux I ran a bunch of stuff on sudo I shouldn't have and broke things as a result)

  • otherwise copy all xinputXYZ.dll's next to the game executable and start the game

If a user does this, do the rest of the files still need to exist where they were extracted? answering the first question helps answer this one.

  • on Wine, dumbxinputemu uses evdev and ignores jsdev devices by default. That should work with almost everything, but you can control this behavior using XINPUT_NO_IGNORE_JS and XINPUT_IGNORE_EVDEV environment variables.

Don't have too much issue with this line, as it's just providing additional information.

When I downloaded the release archive, I immediately came upon an question I wasn't sure the answer to. Included in the archive are a 32 and 64 folder, I'm assuming referring to 32 bit and 64 bit. A normal pc user trying Linux for the very first time, might not know this, so explaining what these folders mean might help. Also, I'm not sure if it's referring to if the game is 32 or 64 bit, or if my Linux environment is 32 or 64 bit.

If it is referring to if my game is 32 or 64 bit, a guide on how to determine this, or even that a user needs to determine this before using your project, would be very helpful.

Not trying to be mean or hurtful, just trying to provide meaningful feedback on your install guide after finding out new users were struggling to understand it, but wanting to use your project!

@FrankReynoldsIII
Copy link

I have no idea what environment variables are or how to use them. I have a JS controller and I can't use it and I have no clue how to change it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants