-
Notifications
You must be signed in to change notification settings - Fork 0
/
keylab.txt
148 lines (94 loc) · 4.89 KB
/
keylab.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
*keylab.txt* A typing speed plugin to become faster at coding.
====================================================================================
*keylab.nvim*
Keylab.nvim is a plugin that enables you to practice typing on your
Neovim configuration. Boost your productivity by practicing your Neovim
keybindings and compete with yourself!
Read the Github Wiki to learn about installation, setup and configuration.
To find out more:
https://github.com/BooleanCube/keylab.nvim
====================================================================================
CONTENTS *keylab-contents*
1. INTRODUCTION......................|keylab|
2. FUNCTIONS.........................|keylab-functions|
3. COMMANDS..........................|keylab-commands|
====================================================================================
INTRODUCTION *keylab*
Keylab.nvim aims to aid new neovim users to boost their productivity
by practicing their keybinding configurations multiple times. If used
enough times, users will start to see an increase in their coding
speed.
Keylab.nvim also serves as a plugin to measure your coding speed.
Similar to https://www.speedtyper.dev/ (by codicocodes), except with
custom scripts and your personal vim configuration. Measure your true
coding speed on neovim and aim for even higher results. All languages
that your configuration support, are also supported.
This plugin was heavily inspired by my first application:
https://github.com/BooleanCube/NeovimKeys
This application written in Java helps new users get used to the classic
HJKL movement keys but nothing beyond that. Thus, keylab.nvim to complete
the tool.
Keylab.nvim offers many features and functionalities:
* Customizable configuration and setup
* Simple mechanics and free controls
* Multilingual support
* Clean documentation
* Efficient & optimized plugin
====================================================================================
FUNCTIONS *keylab-functions*
keylab.setup({opts}) *keylab.setup()*
Setup the keylab configuration using the values in {opts}
table.
Note:
Make sure to call this function before you use |keylab.start()|
Parameters: ~
• {opts} Configurable variables are the following:
• lines: The amount of lines you want the
script to be to measure your speed.
• correct_fg: The foreground color for
correct text.
• wrong_bg: The background color for wrong
text.
• force_accuracy: Forces the player's accuracy
to be 100% before display performance stats.
keylab.setup({
lines = 10,
correct_fg = "#B8BB26",
wrong_bg = "#FB4934"
})
keylab.start() *keylab.start()*
Starts a keylab coding session where typing speed will be
measured. Performance will be displayed once you complete
copying the script.
keylab.start()
keylab.close_game() *keylab.close_game()*
Stops a keylab coding session and closes all open buffers
and windows for the session.
keylab.close_game()
====================================================================================
COMMANDS *keylab-commands*
:KeylabReload *:KeylabReload*
Loses all the cached data from the keylab.nvim plugin.
(Plugin doesn't take any parameters)
:KeylabReload
:KeylabStart *:KeylabStart*
Starts a keylab coding session where typing speed will be
measured. Performance will be displayed once you complete
copying the script.
This command directly runs |keylab.start()|
:KeylabStart
:KeylabStop *:KeylabStop*
Stops an already running keylab coding session. If a
keylab session is not currently open, this command will
not affect anything.
This command directly runs |keylab.close_game()|
:KeylabStop
:KeylabClearPerf *:KeylabClearPerf*
Clears the stored performance database. All tracked
statistics will be lost and unretrievable.
Note:
Once the command is used it can not be returned.
So please use it very carefully.
:KeylabClearPerf
====================================================================================
vim:tw=78:ts=8:ft=help:norl: