UCR icon indicating copy to clipboard operation
UCR copied to clipboard

Wiki suggestions

Open DanTDBV opened this issue 6 years ago • 3 comments

I would suggest adding some more sections to the Wiki and making them editable by the users. This would make it possible to let us users help with the documentation and make it easier for new users to get to grips with UCR C++.

A Plugins section: With a list of plugins, with descriptions and guides for them. My thoughts are that the creator of the plugin, or users who have figured out how to use it, can write descriptions and guides.

An examples and do’s and don'ts for creating Plugins section:

A use section: This could be for guides on how to setting up and use HidGuardian Switching profiles with CLI Setting up switch states How to start UCR with a certain profile and the corresponding game or program from a desktop link and more like this.

A housekeeping section: What files to backup before doing a complete wipe and reinstall of Windows and other operating systems and what to change after the reinstall. List of, how and what to edit for certain gains and changes in userfiles like context.xml

Could be something like this:

Rename and move mappings in UCR C++

At the moment this is not possible in the gui, but can be done editing the context.xml file using Notepad++.

Remember to backup the file before editing.

Notepad++ is free, get it here: https://notepad-plus-plus.org/ After download install it.

To open the file in Notepad++: Right click context.xml, click Edit with Notepad++

To rename a mapping: Find the mapping name you have ie. <Mapping> <Title>Button 2</Title> and change it to what you want ie. <Mapping> <Title>Button 2 Lock target</Title>

To move a mapping: Mark everything from <Mapping> to </Mapping>

Hit Crtl X

If you want to move the mapping to the top of the profile: Find <Mappings> Place the cursor behind <Mappings>| Hit Enter and align the cursor with the front of <Mapping> |
<Mapping> Hit Crtl V or Shift Insert

If you want to move the mapping anywhere else: Find the </Mapping> you want your mapping to be below. Place the cursor behind </Mapping>| Hit Enter Hit Crtl V or Shift Insert

Save the file and you are good to go.

These suggestions and the guide where inspired by the “Let user rename mappings” and “Allow to move mappings” suggestions here: https://github.com/Snoothy/UCR/issues/53

Thank you so very much for this very useful software.

DanTDBV avatar Feb 23 '19 19:02 DanTDBV

We are aware of this, but it's a good suggestion nonetheless. Documentation will be hosted on https://readthedocs.org/ in the future (TBD), and its contents will be updatable by pull request

Snoothy avatar Feb 25 '19 19:02 Snoothy

Ditto on the CLI stuff. I have yet to figure out how to run a profile from the command line. The apparent p= seen in the code isn't working for me.

juanitogan avatar Aug 12 '19 09:08 juanitogan

D'oh. Was inspired to try -p <profile> and -profile <profile> and those work. And -p with no profile name shuts UCR down. Nice.

juanitogan avatar Aug 12 '19 09:08 juanitogan