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

Install Guide for Ubuntu 18.04 #36

Open
cornernote opened this issue Sep 7, 2018 · 1 comment
Open

Install Guide for Ubuntu 18.04 #36

cornernote opened this issue Sep 7, 2018 · 1 comment

Comments

@cornernote
Copy link

Took time for a noob like me to find the right dependencies:

sudo apt install libconfig++-dev libtinyxml2-dev libudev-dev

Also had an issue where I had to manually create this folder:

sudo mkdir -p /root/.local/share/sidewinderd

I made a quick guide (for myself), but thought that info may help you improve the README:
https://gist.github.com/cornernote/81affe26bdb15b7c49f4cceaae2f703f

Once I got that figured out everything works perfectly. It even records the delays (which is sometimes useful and sometimes annoying, but I worked out how to remove them in the XML, so all good).

Thank you so much for providing this tool!!!

@tolga9009
Copy link
Owner

tolga9009 commented Sep 7, 2018

Hi!

Sorry you had to jump through hoops, in order to run sidewinderd. I wasn't able to maintain for quite some time.

We actually have Ubuntu installation instructions in the Wiki: https://github.com/tolga9009/sidewinderd/wiki/Installation. I agree though, it's not the first place you'd expect it. As there are many distros out there and we can't cover them all in README, I think it's a better solution to link to the Wiki and put the instructions there.

Feel free to edit and add pages to the Wiki. I think guides written by users are more user-friendly than guides written by devs.

As for your setup: you shouldn't use the root user in a single-user setup. Instead, configure /etc/sidewinderd.conf to use another user. sidewinderd will drop unneeded privileges in that case and run as your specified user. Your macro folder will then no longer be stored under /root/.local/share/sidewinderd, but under /home/<user>/.local/share/sidewinderd.

Recording delays between key actions can be useful in games. But I understand, they can be annoying in other scenarios. You can configure capture_delays in /etc/sidewinderd.conf according to your needs. The changes should only apply after restarting sidewinderd. A solution, where users could do this on-the-fly would be awesome, but I need a universal solution, which works across all keyboards.

The Arch Linux AUR package has a post-installation script, which advises the user to look into /etc/sidewinderd.conf, change the root user and make wanted changes. I think we need a way to communicate this not only to Arch Linux users, but everyone who uses sidewinderd.

I will keep this issue open as a reminder to improve configuration defaults and README overhaul.
Thanks for your contribution!

Cheers,
Tolga

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