Skip to content

Commit f0bd783

Browse files
authored
Update README.md
1 parent 9f35646 commit f0bd783

File tree

1 file changed

+3
-58
lines changed

1 file changed

+3
-58
lines changed

README.md

Lines changed: 3 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
A minimalistic Python-based Snap Tapping program compatible with all keyboards and supports:
88

99
## General (very short) overview of functionalities
10+
For more info see [Wiki](https://github.com/wasiejen/Free-Snap-Tap/wiki)
1011

1112
<img src="https://github.com/user-attachments/assets/c730d4ed-d16c-43ca-8368-409fb661b399" alt="crosshair" width="200"/>
1213
<img src="https://github.com/user-attachments/assets/abbed088-8271-4160-98b6-ca770d12757c" alt="crosshair" width="250"/>
@@ -44,6 +45,7 @@ A minimalistic Python-based Snap Tapping program compatible with all keyboards a
4445
13. [Crosshair] `<arg>-crosshair` or `<arg>-crosshair=*pixel delta x*,*pixel delta y*`
4546
- displays a simple crosshair as overlay and can be controlled on a per game basis
4647

48+
Function Documentation V1.1.3 now in the [Wiki](https://github.com/wasiejen/Free-Snap-Tap/wiki).
4749

4850
## Example for a config file:
4951

@@ -186,7 +188,7 @@ v : suppress # v will always suppressed
186188

187189
```
188190

189-
## For function documentation and usage see the wiki
191+
## For function documentation and usage see the [Wiki](https://github.com/wasiejen/Free-Snap-Tap/wiki)
190192

191193
## How Free Snap Tap Works
192194

@@ -240,63 +242,6 @@ or navigate to the Free-Snap-Tap repo folder and type in:
240242
python ./free_snap_tap.py
241243
```
242244

243-
## [Configuration]
244-
245-
- text file can be changed from default "FSTconfig.txt" to any file you want to, with the help of the startargument `-file=*file_name*`
246-
- all startarguments can be used either with a .bat file, by adding them to the link to the .exe or .py file, or by including them in the config file with `<arg>*start_argument*`, e.g. `<arg>-nomenu`
247-
- focus app names can be defined in the config file via `<focus>*name of the app*`
248-
- everything BEFORE the first \<focus> will be seen as default start arguments and groupings and applied in general (evene outsite of focus apps) and to all following focus app groupings
249-
- everything following this \<focus> definition up until the next \<focus> will be applied when the focus app name given is found in the current active window
250-
251-
```bash
252-
<arg>-status_indicator=15
253-
#----------------------------------------
254-
### Counter Strike focus group
255-
<focus>Counter
256-
257-
#<arg>-debug
258-
#<arg>-crossover=40
259-
<arg>-tapdelay=6,4
260-
<arg>-aliasdelay=6,4
261-
#<arg>-nomenu
262-
#<arg>-nocontrols
263-
#<arg>-nodelay
264-
<arg>-crosshair
265-
# <arg>-crosshair=10,10
266-
267-
# Tap Groups
268-
a,d
269-
w,s
270-
271-
# Rebinds
272-
...
273-
```
274-
275-
### [Start Arguments]
276-
277-
Only the startargument `-file="filename" should now be used as start argument in the batch or in link.
278-
Everything else should be put in the config file and then can be applied on a per Game based as needed.
279-
- use the same arguments in the config just instead with \<arg> in front. See above example.
280-
281-
- `<arg>-nomenu` skips the menu and will be directly active
282-
- `<arg>-file="filename"`: (with or without "): custom save file
283-
- `<arg>-debug`: print out some debug info
284-
- `<arg>-nocontrols`: to start it without the controls on `DEL`, `END` and `PAGE_DOWN`keys enabled- start -
285-
- `<arg>-tapdelay="number, number"`: sets the default min and max delay of "number,number" ms for Tap_Groups
286-
- `<arg>-aliasdelay="number, number"`: sets the default min and max delay of "number,number" ms for Macros/Aliases
287-
- `<arg>-crossover="number"`: sets the probability of "number" percent for a crossover (can be set in a range of 0-100)
288-
- A crossover is key event reversal with delay - press and release are overlapping the time of delay
289-
- `<arg>-nodelay`: deactivates delay and crossover
290-
291-
- `<arg>-status_indicator=*size in pixel*`: a dot overlay that changes based on being active to green and on incative to red
292-
- `<arg>-crosshair` displays a simple crosshair as overlay and can be controlled on a per game basis in the center of the screen
293-
- `<arg>-crosshair=*pixel delta x*,*pixel delta y*`: changes centerpoint according the delta x and y values in pixels
294-
295-
**(deprecated)**
296-
Start Options: (add to the bat(ch) file or in a link after the *path*\free_snap_tap.exe)
297-
- use the start Arguments without \<arg>
298-
- everything still works as normal start arguments, but than could change in future
299-
300245
## Current Version Information
301246

302247
### NEW V1.0.1:

0 commit comments

Comments
 (0)