Skip to content

Commit

Permalink
Rename "SC-Controller" to "SC Controller" in all user-facing places, …
Browse files Browse the repository at this point in the history
…also some grammar and linter fixes
  • Loading branch information
C0rn3j committed Oct 6, 2024
1 parent e6efa6d commit 451a294
Show file tree
Hide file tree
Showing 15 changed files with 53 additions and 69 deletions.
12 changes: 6 additions & 6 deletions ADDITIONAL-LICENSES
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
All images in images/ directory, profile files in default_profiles/
and profile_examples/ and menu files in default_menus/ directories
are licensed under CC0 license - https://creativecommons.org/publicdomain/zero/1.0/
are licensed under the CC0 license - https://creativecommons.org/publicdomain/zero/1.0/

Images in images/menu-icons subdirectories are licensed as described
in 'LICENSES' files in their respective subdirectories.
in the 'LICENSES' files in their respective subdirectories.

lib/jsonencoder.py is licensed under PSFL, https://www.python.org/download/releases/2.7/license/
scripts/gamecontrollerdb.txt is taken from Simple DirectMedia Layer library and licensed under zlib license.
lib/xwrappers.py and lib/vdf.py are part of SC-Controller, licensed under GPL2 as rest of the project.
lib/jsonencoder.py is licensed under the PSFL, https://www.python.org/download/releases/2.7/license/
scripts/gamecontrollerdb.txt is taken from the Simple DirectMedia Layer library and licensed under the zlib license.
lib/xwrappers.py and lib/vdf.py are part of SC Controller, licensed under GPL2 like the rest of the project.

Everything else is licensed under GPL2, as described in 'LICENSE' file.
Everything else is licensed under GPL2, as described in the 'LICENSE' file.
28 changes: 14 additions & 14 deletions docs/menu-file.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
SC-Controller menu file specification
SC Controller menu file specification
----------------------------------------

Menu file contains json-encoded list with menu items (actions), submenus,
Menu file contains json-encoded list with menu items (actions), submenus,
separators and menu generators.

### Menu Items


Every menu item is defined by action, in same way as action would be defined
[in profile file](profile-file.md#Action_definition) with one additional
`id` key. `id` specifies action ID and can be anything, but each menu item
Expand All @@ -17,16 +17,16 @@ displayed on screen. If `name` is not specified, title is auto-generated.
Example:

[{
"id": "item1",
"action": "profile('Desktop')",
"name": "Switch to Desktop profile",
"id": "item1",
"action": "profile('Desktop')",
"name": "Switch to Desktop profile",
}, {
"id": "item2",
"action": "turnoff()",
"name": "Turn controller OFF",
"id": "item2",
"action": "turnoff()",
"name": "Turn controller OFF",
}]

specifies menu with two items.
specifies menu with two items.

### Submenus

Expand All @@ -41,7 +41,7 @@ that order.
Example:

[{
"submenu": "profiles.menu",
"submenu": "profiles.menu",
"name": "All Profiles"
}]

Expand All @@ -63,9 +63,9 @@ Example:
[{
"generator": "profiles"
}, {
"id": "item2",
"action": "turnoff()",
"name": "Turn controller OFF",
"id": "item2",
"action": "turnoff()",
"name": "Turn controller OFF",
}]

specifies menu with list of all profiles, followed by one normal menu item.
Expand Down
20 changes: 10 additions & 10 deletions docs/profile-file.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
SC-Controller profile file specification
SC Controller profile file specification
----------------------------------------

Profile file contains json-encoded dictonary with specific keys. Missing keys are substituted with defaults, unknown keys are ignored. See [Desktop.sccprofile](../default_profiles/Desktop.sccprofile) for example.
Expand Down Expand Up @@ -57,9 +57,9 @@ levels among which is action executed.
Example:

"trigger_left": {
"action": "button(BTN_LEFT)",
"action": "button(BTN_LEFT)",
"levels": [127, 255]
},
},

Sets action that presses left mouse button, but only if trigger
is roughly half-pressed.
Expand Down Expand Up @@ -88,10 +88,10 @@ Example:
"pad_left": {
"ring": {
"inner": { "action": "XY(axis(Axes.ABS_X), raxis(Axes.ABS_Y))" },
"outer": { "action": "XY(axis(Axes.ABS_RX), raxis(Axes.ABS_RY))" },
"outer": { "action": "XY(axis(Axes.ABS_RX), raxis(Axes.ABS_RY))" },
"radius": 0.4
}
},
},

defines inner ring binding controlling left stick and outer ring right stick
of emulated gamepad.
Expand Down Expand Up @@ -187,9 +187,9 @@ If set to True, enables OSD for action.
Example:

"X": {
"action": "button(Keys.BTN_EAST)",
"action": "button(Keys.BTN_EAST)",
"osd": true
},
},

enables OSD feedback for X button.

Expand Down Expand Up @@ -327,9 +327,9 @@ All keys are optional. Value for each key is [action definition](#Action_definit
Example:

"buttons": {
"A": { "action": "button(Keys.BTN_WEST)", },
"B": { "action": "osd('Hello world!')" },
"BACK": { "action": "button(Keys.KEY_LEFTCTRL) and button(Keys.KEY_A)" },
"A": { "action": "button(Keys.BTN_WEST)", },
"B": { "action": "osd('Hello world!')" },
"BACK": { "action": "button(Keys.KEY_LEFTCTRL) and button(Keys.KEY_A)" },
}


Expand Down
6 changes: 3 additions & 3 deletions glade/creg.glade
Original file line number Diff line number Diff line change
Expand Up @@ -889,10 +889,10 @@ That means your account lacks permissons needed to read controller exclusively.
<property name="hexpand">True</property>
<property name="label" translatable="yes">&lt;b&gt;DS4 Controller&lt;/b&gt;

SC-Controller supports DS4 controllers automatically
SC Controller supports DS4 controllers automatically
and requires no additional configuration. All you need
is to make sure "DS4 Controller Support" checkbox
is enabled in Settings or here:</property>
is to make sure that the "DS4 Controller Support" checkbox
is enabled in the Settings or here:</property>
<property name="use-markup">True</property>
<property name="wrap">True</property>
<property name="xalign">0</property>
Expand Down
8 changes: 4 additions & 4 deletions glade/global_settings.glade
Original file line number Diff line number Diff line change
Expand Up @@ -1464,7 +1464,7 @@ or even crash.</property>
<property name="visible">True</property>
<property name="can-focus">False</property>
<property name="margin-left">30</property>
<property name="label" translatable="yes">If enabled, any connected DualSense controller will be automatically used by SC-Controller</property>
<property name="label" translatable="yes">If enabled, any connected DualSense controller will be automatically used by SC Controller</property>
<property name="xalign">0</property>
<property name="yalign">0</property>
</object>
Expand Down Expand Up @@ -1497,7 +1497,7 @@ or even crash.</property>
<property name="visible">True</property>
<property name="can-focus">False</property>
<property name="margin-left">30</property>
<property name="label" translatable="yes">If enabled, any connected Dualshock4 controller will be automatically used by SC-Controller</property>
<property name="label" translatable="yes">If enabled, any connected Dualshock4 controller will be automatically used by SC Controller</property>
<property name="xalign">0</property>
<property name="yalign">0</property>
</object>
Expand All @@ -1512,7 +1512,7 @@ or even crash.</property>
<property name="visible">True</property>
<property name="can-focus">False</property>
<property name="margin-left">20</property>
<property name="label" translatable="yes">Controller listed here are automatically used by SC-Controller whenever they are connected.</property>
<property name="label" translatable="yes">Controllers listed here are automatically used by SC Controller whenever they are connected.</property>
<property name="xalign">0</property>
</object>
<packing>
Expand Down Expand Up @@ -2296,7 +2296,7 @@ grips, triggers, finger positions on both pads and stick angle.</property>
<object class="GtkLabel" id="label40">
<property name="visible">True</property>
<property name="can-focus">False</property>
<property name="label" translatable="yes">Display message about new version after SC-Controller upgrade</property>
<property name="label" translatable="yes">Display a message with changelog when SC Controller updates</property>
<property name="use-underline">True</property>
<property name="mnemonic-widget">cbShowOSD</property>
<attributes>
Expand Down
2 changes: 1 addition & 1 deletion glade/import_export.glade
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@
<object class="GtkLabel" id="lblBtImport">
<property name="visible">True</property>
<property name="can-focus">False</property>
<property name="label" translatable="yes">_Import SC-Controller Profile</property>
<property name="label" translatable="yes">_Import SC Controller Profile</property>
<property name="use-underline">True</property>
<attributes>
<attribute name="weight" value="bold"/>
Expand Down
5 changes: 1 addition & 4 deletions scc/gui/ae/dpad.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
SC-Controller - Action Editor - "DPAD or Menu"
"""SC Controller - Action Editor - "DPAD or Menu".
Setups DPAD emulation or menu display
"""
Expand Down
7 changes: 2 additions & 5 deletions scc/gui/ae/first_page.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
SC-Controller - Action Editor - First Page
"""SC Controller - Action Editor - First Page.
Provides links for quick settings.
"""
Expand All @@ -13,7 +10,7 @@
from scc.tools import nameof


import os, logging
import logging
log = logging.getLogger("AE.1st")

__all__ = [ 'FirstPage' ]
Expand Down
4 changes: 2 additions & 2 deletions scc/gui/importexport/export.py
Original file line number Diff line number Diff line change
Expand Up @@ -201,10 +201,10 @@ def on_btSaveAs_clicked(self, *a):
# Determine format
f = Gtk.FileFilter()
if self._needs_package():
f.set_name("SC-Controller Profile Archive")
f.set_name("SC Controller Profile Archive")
fmt = "sccprofile.tar.gz"
else:
f.set_name("SC-Controller Profile")
f.set_name("SC Controller Profile")
fmt = "sccprofile"
f.add_pattern("*.%s" % (fmt,))

Expand Down
2 changes: 1 addition & 1 deletion scc/gui/importexport/import_sccprofile.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class ImportSccprofile(object):
def on_btImportSccprofile_clicked(self, *a):
# Create filters
f1 = Gtk.FileFilter()
f1.set_name("SC-Controller Profile or Archive")
f1.set_name("SC Controller Profile or Archive")
f1.add_pattern("*.sccprofile")
f1.add_pattern("*.sccprofile.tar.gz")

Expand Down
16 changes: 4 additions & 12 deletions scc/gui/statusicon.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Syncthing-GTK - StatusIcon
"""
import locale
"""Syncthing-GTK - StatusIcon."""
import os
import sys
import logging

from gi.repository import GObject
Expand Down Expand Up @@ -34,10 +27,9 @@


class StatusIcon(GObject.GObject):
"""
Base class for all status icon backends
"""
TRAY_TITLE = _("SC-Controller")
"""Base class for all status icon backends."""

TRAY_TITLE = _("SC Controller")

__gsignals__ = {
"clicked": (GObject.SignalFlags.RUN_FIRST, None, ()),
Expand Down
2 changes: 1 addition & 1 deletion scc/osd/inputdisplay.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ def on_observe_failed(self, error):
if "Sniffing" in error:
log.error("")
log.error("=================================================================================")
log.error("[!!] Please, enable 'Input Test Mode' on 'Advanced' tab in SC-Controller settings")
log.error("[!!] Please, enable 'Input Test Mode' on 'Advanced' tab in SC Controller settings")
log.error("=================================================================================")
self.quit(3)

Expand Down
6 changes: 2 additions & 4 deletions scc/x11/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
#!/usr/bin/env python3
"""
SC-Controller - X11
"""SC Controller - X11.
Daemon-related stuff that really needs X server to work.
"""

# there is also absolutely nothing usefull in this file...
# there is also absolutely nothing useful in this file...
2 changes: 1 addition & 1 deletion scripts/69-sc-controller.rules
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This file allows SC-Controller application and daemon to access Steam Controller or its USB dongle.
# This file allows the SC Controller application and daemon to access the Steam Controllers and their USB dongle.
# This is done by allowing read/write access to all users. You may want to change this to something like
# MODE="0660", GROUP="games" to allow r/w access only to members of that group.

Expand Down
2 changes: 1 addition & 1 deletion scripts/sc-controller.appdata.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<image width="923" height="538">https://raw.githubusercontent.com/C0rn3j/sc-controller/master/docs/screenshot1.png</image>
</screenshot>
<screenshot>
<caption>SC-Controller in action</caption>
<caption>SC Controller in action</caption>
<image width="887" height="622">https://raw.githubusercontent.com/C0rn3j/sc-controller/master/docs/screenshot2.png</image>
</screenshot>
</screenshots>
Expand Down

0 comments on commit 451a294

Please sign in to comment.