Skip to content
This repository was archived by the owner on Jan 23, 2024. It is now read-only.

Commit d93a49e

Browse files
author
Jacalz
committed
Updates to TODO file and significant improvements to README.md
1 parent 7103aed commit d93a49e

File tree

2 files changed

+53
-38
lines changed

2 files changed

+53
-38
lines changed

Diff for: README.md

+51-35
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,65 @@
11
SC Controller [![Build Status](https://travis-ci.org/kozec/sc-controller.svg?branch=master)](https://travis-ci.org/kozec/sc-controller)
22
=============
33

4-
User-mode driver, mapper and GTK3 based GUI for Steam Controller, DS4 and similar controllers.
4+
User-mode driver, mapper and GTK3 based GUI for Steam Controller, DS4, Xbox 360 and similar controllers.
55

66
[![screenshot1](docs/screenshot1-tn.png?raw=true)](docs/screenshot1.png?raw=true)
77
[![screenshot2](docs/screenshot2-tn.png?raw=true)](docs/screenshot2.png?raw=true)
88
[![screenshot3](docs/screenshot3-tn.png?raw=true)](docs/screenshot3.png?raw=true)
99
[![screenshot3](docs/screenshot4-tn.png?raw=true)](docs/screenshot4.png?raw=true)
1010

11-
##### Features
12-
- Allows to setup, configure and use Steam Controller(s) without ever launching Steam
13-
- Supports profiles switchable in GUI or with controller button
14-
- Stick, Pads and Gyroscope input
15-
- Haptic Feedback and in-game Rumble support
16-
- OSD, Menus, On-Screen Keyboard for desktop *and* in games.
17-
- Automatic profile switching based on active window.
18-
- Macros, button cycling, rapid fire, modeshift, mouse regions...
19-
- Emulates XBox360 controller, mouse, trackball and keyboard.
11+
## Features
12+
- Allows to setup, configure and use Steam Controller(s) without ever launching Steam
13+
- Supports profiles switchable in GUI or with controller button
14+
- Stick, Pads and Gyroscope input
15+
- Haptic Feedback and in-game Rumble support
16+
- OSD, Menus, On-Screen Keyboard for desktop *and* in games.
17+
- Automatic profile switching based on active window.
18+
- Macros, button cycling, rapid fire, modeshift, mouse regions...
19+
- Emulates Xbox360 controller, mouse, trackball and keyboard.
2020

2121
Based on [Standalone Steam Controller Driver](https://github.com/ynsta/steamcontroller) by [Ynsta](https://github.com/ynsta).
2222

23-
##### Like what I'm doing?
23+
## Like what I'm doing?
2424

2525
[![Help me become filthy rich on Patreon](https://img.shields.io/badge/Help_me_become_filthy_rich_on-Patreon-Orange.svg)](https://www.patreon.com/kozec) <sup>or</sup> [![pay what you want with PayPal](https://img.shields.io/badge/pay_what_you_want_with-Paypal-yellow.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=77DQD3L9K8RPU&lc=SK&item_name=kozec&item_number=scc&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted)
26-
##### Packages
27-
- Ubuntu (deb-based distros): in [openSUSE Build Service](http://software.opensuse.org/download.html?project=home%3Akozec&package=sc-controller).
28-
- Fedora, SUSE (rpm-based distros): in [openSUSE Build Service](http://software.opensuse.org/download.html?project=home%3Akozec&package=sc-controller).
29-
- Arch, Manjaro: in [AUR](https://aur.archlinux.org/packages/sc-controller-git/)
30-
- Solus: search for `sc-controller` in Software Center
31-
- Exherbo: in [hardware](https://git.exherbo.org/summer/packages/input/sc-controller)
32-
- Void Linux: `xbps-install -S sc-controller`
33-
34-
##### To run without package
35-
- download and extract [latest release](https://github.com/kozec/sc-controller/releases/latest)
36-
- navigate to extracted directory and execute `./run.sh`
37-
38-
##### To install without package
39-
- download and extract [latest release](https://github.com/kozec/sc-controller/releases/latest)
40-
- `python2 setup.py build`
41-
- `python2 setup.py install`
42-
43-
44-
##### Dependencies
45-
- python 2.7, GTK 3.22 or newer and [PyGObject](https://live.gnome.org/PyGObject)
46-
- [python-gi-cairo](https://packages.debian.org/sid/python-gi-cairo) and [gir1.2-rsvg-2.0](https://packages.debian.org/sid/gir1.2-rsvg-2.0) on debian based distros (included in PyGObject elsewhere)
47-
- [setuptools](https://pypi.python.org/pypi/setuptools)
48-
- [python-pylibacl](http://pylibacl.k1024.org/) recommended
49-
- [python-evdev](https://python-evdev.readthedocs.io/en/latest/) strongly recommended
26+
27+
## Packages
28+
29+
### Ubuntu (deb-based distros):
30+
Found in [openSUSE Build Service](http://software.opensuse.org/download.html?project=home%3Akozec&package=sc-controller).
31+
32+
### Fedora, SUSE (rpm-based distros):
33+
Found in [openSUSE Build Service](http://software.opensuse.org/download.html?project=home%3Akozec&package=sc-controller).
34+
35+
### Arch, Manjaro (arch-based distros):
36+
Found in [AUR](https://aur.archlinux.org/packages/sc-controller-git/)
37+
38+
### Solus:
39+
Search for `sc-controller` in Software Center or run `sudo eopkg it sc-controller` from a terminal.
40+
41+
### Exherbo:
42+
Found in [hardware](https://git.exherbo.org/summer/packages/input/sc-controller)
43+
44+
### Void Linux:
45+
Run `xbps-install -S sc-controller` in a terminal.
46+
47+
48+
## Building the package by yourself
49+
50+
### Dependencies
51+
- python 2.7, GTK 3.22 or newer and [PyGObject](https://live.gnome.org/PyGObject)
52+
- [python-gi-cairo](https://packages.debian.org/sid/python-gi-cairo) and [gir1.2-rsvg-2.0](https://packages.debian.org/sid/gir1.2-rsvg-2.0) on debian based distros (included in PyGObject elsewhere)
53+
- [setuptools](https://pypi.python.org/pypi/setuptools)
54+
- [python-pylibacl](http://pylibacl.k1024.org/) is recommended
55+
- [python-evdev](https://python-evdev.readthedocs.io/en/latest/) is strongly recommended
56+
57+
### Installing
58+
- Download and extract [latest release](https://github.com/kozec/sc-controller/releases/latest)
59+
- `python2 setup.py build`
60+
- `python2 setup.py install`
61+
62+
63+
## Running with non distro-specific package
64+
- Download and extract [latest release](https://github.com/kozec/sc-controller/releases/latest)
65+
- Navigate to extracted directory and execute `./run.sh`

Diff for: TODO.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
List of (possibly) planned features in no particular order
1+
List of (possibly) planned features in no particular order:
22

33
- Multiple on-screen menus (and possibly keyboards) when using multiple controllers
44
- Injecting emulated xbox controller into wine
55

66
Hard stuff:
7-
- Support for other controllers ( #145 )
87
- Injecting emulated xbox controller into PlayOnLinux
98

109
Very hard stuff:
@@ -33,4 +32,4 @@ Very hard stuff:
3332
- Trigger settings
3433
- DPAD that acts only when clicked
3534
- 8-way DPAD
36-
- Selector for media keys
35+
- Selector for media keys

0 commit comments

Comments
 (0)