Skip to content

Commit 3103e07

Browse files
describe user preference fields
1 parent b78176d commit 3103e07

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

doc/specs/schemas/UserPreferences.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,14 +113,19 @@ properties:
113113
type: integer
114114
autoQueen:
115115
type: integer
116+
description: 1 = Never, 2 = When premoving, 3 = Always
116117
autoThreefold:
117118
type: integer
119+
description: 0 = Never, 2 = When time remaining < 30 seconds, 3 = Always
118120
takeback:
119121
type: integer
122+
description: 1 = Never, 2 = In casual games only, 3 = Always
120123
moretime:
121124
type: integer
125+
description: 1 = Never, 2 = In casual games only, 3 = Always
122126
clockTenths:
123127
type: integer
128+
description: 0 = Never, 1 = When remaining time less than 10 seconds, 2 = Always
124129
clockBar:
125130
type: boolean
126131
clockSound:
@@ -129,8 +134,10 @@ properties:
129134
type: boolean
130135
animation:
131136
type: integer
137+
description: 0 = None, 1 = Fast, 2 = Normal, 3 = Slow
132138
pieceNotation:
133139
type: integer
140+
description: 0 = Chess piece symbol, 1 = KQRBN Letter
134141
captured:
135142
type: boolean
136143
follow:
@@ -141,6 +148,7 @@ properties:
141148
type: boolean
142149
coords:
143150
type: integer
151+
description: 0 = No, 1 = Inside the board, 2 = Outside the board, 3 = All squares
144152
replay:
145153
type: integer
146154
challenge:
@@ -151,22 +159,28 @@ properties:
151159
type: integer
152160
confirmResign:
153161
type: integer
162+
description: 1 = Confirm resignation and draw offers, 0 = Do not confirm
154163
insightShare:
155164
type: integer
156165
keyboardMove:
157166
type: integer
167+
description: 1 = input moves with the keyboard
158168
voiceMove:
159169
type: boolean
160170
zen:
161171
type: integer
172+
description: 0 = No, 1 = yes, 2 = in-game only
162173
ratings:
163174
type: integer
175+
description: 0 = Hide ratings, 1 = Show ratings, 2 = Show ratings except in-game
164176
moveEvent:
165177
type: integer
166178
rookCastle:
167179
type: integer
180+
description: 0 = Move king two squares, 1 = Move king onto rook
168181
flairs:
169182
type: boolean
183+
description: Show player flairs
170184
sayGG:
171185
type: integer
172186
enum:

0 commit comments

Comments
 (0)