Sudoku1 - Definition Files

Format of Files in Sudoku1 .sud .txt .ani .macro .magic IRGBlk.dat GridList.dat

Grid Cell Definition

The cells are numbered from left to right, then top to bottom. See the example for the size 9x9.
    C0 C1 C2   C3 C4 C5   C6 C7 C8
L0 0 1 2    3 4 5    6 7 8
L1   9 10 11    12 13 14 15 16 17
L2 18 19 20   21 22 23 24 25 26
           B0       B1        B2
L3 27 28 29   30 31 32   33 34 35
L4 36 37 38   39 40 41   42 43 44
L5 45 46 47   48 49 50   51 52 53
           B3         B4         B5
L6 54 55 56   57 58 59   60 61 62
L7 63 64 65   66 67 68   69 70 71
L8 72 73 74   75 76 77   78 79 80
           B6         B7         B8

Sudoku1 File: *.sud

The reference files of Sudoku1 , with the extension "sud" are specific and can be read or written only by the software itself. The files in version 1 will be proofread by this application.

Text Fichier: *.txt

Sudoku text files can be defined in order to import or export a grid, including values for the visible cells, the values for all cells in the reference grid, and the definitions of variations.

Two types of text file are available:
- file of type Mini Sudoku available on Web, with first line being "Sudoku1 Mode MiniS", then data (1 to 9, 0 being empty data), are in serie in the next line. In case the file includes a lot of grids (1 per line), Sudoku1 will extract every grid in the Sudoku1 standard texte format, and will display the last one. A macro is created in order to update Sudoku1 Catalog with all grids generated. You can launch it using command "Add Objects".

- standart Sudoku1 text file as described hereafter,
The structure of the standart Sudoku1 text file is as follows, with one line per information:
0) Première ligne comprenant "Sudoku1 Mode Texte"
1) number of case per row and column of the grid (4,6,8,9,12,15)
2) for the grid 1, all values of cells:
         - Cells in the order of columns and rows
         - If the box is empty, put before value "R" to indicate that it is only in the grid reference
   3) variant in the grid 1 following the format below
   4) if the second grid exists, S Command (second grid) followed by 2) and 3)
   5) comments can be dragged anywhere, preceded by ';'
   6) if several information is contained in a line, separate them with '; "

The format for each line is:

Key	Varient	Format	comment
;	-	-	Comment in textgrid file
-	Dot+1	-a;b	a-b=1 or –1
#	Magic Pref file	#File
$	Numeral	$a;C	Cell includes a numeral with ascii code C
%	Trio definition	%ABCD…P	Value 1 is in trio A, 2->B…. With 4 Trio possibles from 1 to 4
*	Killer Prod	KP;a;b;c;d...	Killer for cells a,b,c,d... P (product) can be -1 if Reference exist
/	Dotx2	/a;b	a/b=2 or ½
<	Less	<a;b	a<b
=	Comment english	=Comment
>	Greater	>a;b	a>b
&	Kimo	&V	Kimo (Killer like) with Sum modulo V
+	Pan Digital	+b1;b2;b3;bL;P;o1;o2;R	Relation exist between cell of blocks b1,b2,b3 and bL at position P with Operands o1 and o2 and relation R so that: b1 o1 b2 o2 b3 R bL with ox: + ,- ,* ,/, % or No operand with R: =, >, < with P:5 all block data, 6 some block data
?	Dan Sudoku	?N;a;b;c…	Dan region with cells a,b,c… contains only N different data.
°	Killer with different values	°	All data in one killer area are different
!	Comment french	!Comment
§	Arrow	§a;b;c;d…	Cell S is the Sum of all cells a,b,c…
µ	Magic Sentence cells	µa;b;c;d….	Cells forming a sentence to be highlighted
£	Magic Sentence table	£ABC…P	Associated letter for each value.
¨	DontTouch	¨
^	Non consecutive	^T	All values in grid are non consecutive in line/col. If T=D including diagonal
)	Wheels	)C;a;b;c;d;R	Wheels of value a;b;c;d is centered on cell C and is rotated from (R-1)x90°. If unknown set R to 0.
(	PuzzleRotation	(	Authorize rotation in Puzzle
ç	Equality	ça;b;c…	Cells a,b,c… contains the same value.
0	Creasing Sum lines	0;T;a;b;c…	Value in cells a,b,c… are in order following T : A ascending, D descending, R alternativly up or down, C consecutif, S Sum line (one value =sum of others)
1	Navigator	1c;T	Cell c has navigator of type T: 1-diagNE, 2-diagSE, 3-diagSW, 4-diagNW, 5- flickNW, 6- flickNE, 7- flickEN, 8- flickES, 9- flickSW, 10- flickSE, 11- flickWN, 12- flickWS
2	TwinsRel	2a;b;c...	2 tables including cross reference cells a,b,c.. between the 2 grids
3	Trio	3a;V	Cell a is of type Trio number V
4	TwinsRel	4a;b	One cross reference cell between the 2 grids, call a in the first grid, b in the second
5	Chess	5;a;T;C	Cell a has chess type T and color C, with T: knight, king, queen, bishop C: color Black(defense) or White (no attack)
6	Double and Triple	6p1;p2;p3..;p15;MaxScore	Point table for allocation in case: x2 p1, x3 p2, x4 p3, …. And also MaxScore to be found
7	Magic Square	7;N;a ;b ;c…	Square including N cells a,b,c… is a magic square
8	Transfer Cells	8;a;b;c…	Transfer Highlighted cells a,b,c…
9	Batnav OddEven	9T;L1;L2...;C1;C2...	Number of boat cells in lines and columns. If 'A-1', then data must be computed from reference grid Following T(O,E,X) Batnav with all values odd/ even/XXX
A	Batnav	AL1;L2...;C1;C2...	Number of boat cells in lines and columns. If 'A-1', then data must be computed from reference grid
B	Irregular	Bx;a;b;c;d...	irregular blockBlock x includes a,b...
C	Outside/oddview / Transfer	CT;D;P;V	Cell in direction D 0(North), 1(East), 2(South), 3(West) and position P is of type T with value V. Up to 4 data can be added to same cell.Following type: T=O Oddview T=S Outside T=T Transfer
D	Distance	DLx;S;va;vb	Ditance pour la Ligne (ou Colonne) x entre valeurs va et vb S (distance) can be -1 if Reference existe
E	Even	Ea	Data of cell a is even
F	Frame/Skyscraper /Last Number	FT;D;P;V	Cell in direction D 0(North), 1(East), 2(South), 3(West) and position P is of type T with value V. Following Type: T=S Frame Sum T=P Frame Product T=Y Skyscrapper T=U Last Number Up T=D Last Number Down
G	Diagonal	GN	N diagonals includes also different numbers; no N or N=3: 2 diags; N=1 diag NW/SE; N=2 diag NE/SW,
H	Numeral String	Ha;NumeralString	The numeral code of Number a is NumeralString.
I	TwinsEqual	I	Second Grid has all value equal to the ones of first grid
J	Tiled	Ja;b;c;d	Four cells of puzzle identifying grid edge
K	Killer sum	KS;a;b;c;d...	Killer for cells a,b,c,d... S (sum) can be -1 if Reference exist
L	Little Killer	LS;a;b	little killer for cells between a and b in diagonal S (sum) can be -1 if Reference exist
M	Pencil Mark/ DigitalClock/ Domino/ Romain	MT;C;V	T=Type, C=cell, V=data P: Data pencil (1 over 16) C: Digital Clock (1 over 7) D: Domino (1 over 9) R: Romain (1 to 16)
N	Difficulty	Nd	D=1 to 4
O	Odd	Oa	Value of cell a is odd
P	Puzzle	Pa;va;b;vb;...	definition of Puzzle piece in cells a,b,c... with value va,vb...
Q	Quad	QT;a;b;c;d	Contiguous cells a,b,c,d forms a quad of type Min (<) or Max (>)
R	TwinsDiff	R	Second Grid has all value different from first grid
S	Second Grid	S…..	Second Grid followed by values and varients
T	TwinsSubs	Tx1;x2;x3;x4....	Second Grid has associated values: 1-->x1, 2-->x2...
U	OddPair	UT;a;b	Sum of cells a and b is odd or even following type Odd (O), Even (E) or XXX (X)
V	XV	Va;b	a+b=5
W	TwinsZone	Wa;b	Block a of grid 1 is associated to bloc b of Grid 2
X	XV	Xa;b	a+b=10
Y	Extra Region	YN	Extra region with N more region, N=1 or 2 If no N, n=2
Z	OddXXX	Za	Value of cell can be odd or even following X

Animation File: *.ani

The animation files define the 16 Gif or Jpg images to be taken into account as well as the number of repetition of the image when animation.
The character "!" at the beginning of the line is a comment line.
Followed by 16 lines, with a figure for the number of repetitions, space, and the name of the image

Macro File: *.macro

Le fichier Macro comprend:
- une succession de commande immédiate(1 par ligne) ,
- ou dans un mode Fichier, un ensemble de nom de fichiers, précédé par FILES et suivi du groupe de commande à exécuter.
Une commande comprend le mot de commande, suivi par ces parametres et ou un commentaire. Mettre un ';' entre chaque élément de la ligne.
Une ligne commencant par ';' est un commentaire.

Macro File: macro *.
The Macro file includes:
- A series of immediate command (1 per line),
- Or in a file mode, a set of file names, preceded by FILES and followed by group of command to be executed, and finalised by ENDFILES or a new FILES serie.
A command includes the command word, followed by its parameters or comment. Put a ';' between each element of the line. Command and parameters word in Uppercase.
A line starting with ";" is a comment.

Find hereafter the list of command :

Command	Parameter	Comment
LOAD	;(file) or ('-'directory)	load file .sud, or in directory with same name that in FILES
SAVE	;(file) or ('-'directory);R	save file .sud, or in directory with same name that in FILES If R is indicated, score is initialised to 20
LOADT	;(file)	load file.txt
SAVET	;(file)	save file.txt
COPY	;(file) ou ('-'directory)	copy file from "Custom" to Directory
MAGIC	;(file)	load file magic .magic
NEW	;SIZE	Empty grid of size SIZE
PRINT		print
GENERE	;SIZE;DIFF;VAR1; UNIQ; VAR2; VARDEPTH	generate a grid with size SIZE, difficulty(1) DIFF, Variant VAR1(2a) + VAR2(2b), Varient depth VARDEPTH and solution unique UNIQ
RESET		back to starting grid
INIT		define grid as starting grid
SEARCH	;MAX;Y/N	search all solutions until MAX et display them Y/N
DISPREF		display reference grid (UNDO to clean)
REFGRID	;Type	Type=Empty -->generate the reference grid based on search (1st found) Type=I --> copy curent grid in reference grid
DISPN	;NUMBER	display search grid NUMBER (-2=clear search grid - same effect as Input Key)
DISPS	;NUMBER	Display next search grid in relatif +NUMBER (- also)
PROP1		Propose 1 value
SOLVE		Solve the grid
KAL		Start kaleidoscope
DISPC	;N	Display Possibles cells level N
DISPPOSS	;CELL	Display all Possibles in the given cell
DISPL	;Y/N	Display Possibles line and column Yes or No
DISPP	;Y/N	Display Probables Yes or No
DISPT	;Y/N	Display Found Yes or No
DISPV	;Y/N	Display with filtering using Varient
DISPR	;Y/N	Display in Color Mode and Image Bar
DISPW	;Y/N	Display Warning Yes or No
METHOD	;TYPE	define solve methods(3)
CARS	;TYP;OFFSET	define characters size of type(4) TYP with offset OFFSET
UNDO	;N	undo the N last actions. If N=0, undo all
REDO	;N	redo the N last actions. If N=0, redo all
PREFDISP	;VAL	define display type for Text(5) VAL
PREFCELL	;VAL	defin display type for cell(6) VAL
PREFGEOM	;PARA;GEOM	modify geometry parameter(7) with value VAL
PREFBGIM	file name	define background image (*.jpg)
PREFANIM	file name	define animated images (*.ani)
PREFBGIMR	Y/N	set randomly load of the background image
AREA	;TYPE;Y/N	display or not area(8) TYPE
PREF	;TYPE;Y/N	modify preferences(9) TYPE Y/N
RESETPREF		At macro end, reset initial preferences
PAUSE	;TIME(;SET)	wait TIME secondes, and if Time=-1: wait click/key If SET=Y, at each command add a Pause information when Macro execution. If SET=N, nothing is added (default).
COMMENT	;sentence	display sentence in comment area
SETDIFF	;DIFF	set the Grid difficulty level from 1(easy) to 4 (terrible), 0(result of SolveAll)
SETCELL	;CELL;VALUE	enter value VAL in cell CELL; If Cell=-2, All cells; If Cell=-3 current
SETPOSS	;CELL;POSS;TYPE	Set value POSS in CELL; TYPE=1:Add, 0:Remove, 2:Exchange If Poss=0, All values together; If Cell=-2, All cells; If Cell=-3 current selection
SETPROB	;CELL;PROB;TYPE	Set value PROB in CELL; TYPE=1:Add, 0:Remove,2:Exchange If Prob=0, All values together; If Cell=-2, All cells; If Cell=-3 current selection
SETBOAT	;CELL;BOAT	enter value BOAT (0:?, 1:Yes, 2:No) in cell CELL (-2:all cells; -3:Current Selection)
NOMESS	;Y/N	Display (No) or inhibit (Yes) all message in comment area except COMMENT
CLEARCOM		clear comment are
CLICK	;TYPE;SELMULT	indicate a click on zone(10) TYPE while SELMULT key (11) pressed
STAT		Print Statistics on the current Grid
MUSFILE	FILE	Start the music defined by file FILE (*.mp3)
VOLUME	;TYPE;VOLUME	Set volume VOLUME to music (type=MUSIC) or sounds (type=SOUND)
ADDFUNC	;TYPE;NAME	New function added to Sudoku1: Type=R -->Add Irregular definition from file NAME Type=G -->Add Grid to catalog from file NAME Type=C -->Clean Catalog status Type=D -->Comput Max Double&Triple
PART	;Y/N	If Yes do the following code, else goto next PART instruction
RESTART		restart at macro beginning
FILES		Set to start a multiple file command or a repeat command
DEBUG		If DEBUG is inserted in your Macro, all instuctions will be display in the comment area before being executed.
ENDFILES	;NREPEAT	All commands between FILES and ENFILES are executed for all files included. If NREPEAT is 0 or more, they are repeated as needed (in this case there could be no file names).
EXIT		stop macro

Options:
(file): If the file is not indicated, then it takes the current file name
(1) difficulty = EASY MEDIUM DIFFICULT TERRIBLE
(2a) variant Part a = 1(irregular)+ 2(Lkille)+ 4(Killer)+ 8(<>)+ 16(Odd)+ 32(XV)+ 64(Distance)+ 128(Dot)+ 256(Puzzle)+ 512(diagonal) + 1024(Twin Rel)+ 2048(Twin subs)+ 4096(Nav Flight) + 8192(Trio)+ 16384(ExtraRegion)+ 32768(Outside) + 65536 (Frame Sum)+ 131072(Frame Prod)+ 262144(KillerProd)+ 524288(Tiled)+ 1048576(Domino)+ 2097152(PencilMark) + 4194304(Numeral)+ 8388608(OddPair)+ 16777216(OddView)+ 33554432(Quad) + 67108864(TwinEqual)+ 134217728(Twin Zone)+ 268435456(Twin Diff) + 536870912(Digital)+ 1073741824(Non Consec)+ 2147483648(Romain)
(2b) variant Part b = 1(SkyScapper)+ 2(MagicSent)+ 4(Kimo)+ 8(Arrow)+ 16(Creasing)+ 32(Dan)+ 64(Equality)+ 128(Wheel)+ 256(Pandigital)+ 512(Navigator) + 1024(LastNumer)+ 2048(Chess)+ 4096(Triple) + 8192(MagicSquare)+ 16384(Transfer)+ 32768(Dont touch)
(3) method=1(LCB)+ 2(random)+ 4(prob)+ 8(var)+ 16(single)+ 0x20(group...)+ 0x1000(burma...)+ 0x80000(color)+ 0x100000(forcing)
For Group and Burma, from level 1 to 7
(4) text = ALL CELL PROB LINECOL MAT COMMENT
(5) display = NUMBER LETTER MIXED CARTOON
(6) display = SINGLE MULTI MAT PROB
(7) geometry = DX DY DXX DYY DIX DIY DPY BDC BDB CDY BDX(%) TRANSPARENCY(0-255) RNDDELAY (0-11; -1=none)
(8) Area = COMMENT BAR LINECOL METHOD PREFERENCE MAGIC MUSIC
(9) preference = AUTO PREFLOAD POSLOAD ABSOLUTE BLOCKLIM BLOCKCOL BLOCKBAR CELLSQUARE ANIM ACTION DRAG PARASIT IFFALSE ROTATE BOATUNIQ AUTONOBOAT IDEM MATALL MATFOND MATAUTO HIDEVAR MUSDIR MUSLOOP MUSSILENT KEEPRATIO
(10) Area Click = Image bar 1-16; Color bar 17-32; Undo:-1,Shuffle:0; Comment:-2; None:-3; Cell:100-356
(11) selection key = One cell 0; Shift 1; Ctrl 2

Magic File: *.magic

This format defines the parameters of preference, one per line, followed by a possible character.

Hereinafter format generated by 'Save' macro.

50 ;PrefLongCase
39 ;PrefHautCase
0 ;PrefInterCaseX
0 ;PrefInterCaseY
2 ;PrefInterBlockX
2 ;PrefInterBlockY
10 ;PrefHautPoss
2 ;PrefBordCell
4 ;PrefBordBlk
0 ;PrefAbsolute
0 ;PrefIsAuto
1 ;PrefIsDisplayPossLine
1 ;PrefComment
1 ;PrefBarArea
1 ;PrefBarAreaIdem
1 ;PrefMatAll
1 ;PrefMatFond
0 ;PrefMatAuto
32 ;PrefCommentdY
0.076720 ;PrefBardX
0 ;PrefDeltaFontComment
1 ;PrefDeltaFontCell
0 ;PrefDeltaFontLineCol
0 ;PrefDeltaFontProb
0 ;PrefDeltaFontMat
0 ;PrefBlockLimit
1 ;PrefBlockColors
1 ;PrefBlockBars
0 ;PrefCellSquare
1 ;PrefProbType
84 ;Pref3Transparency
11 ;Pref3DelayImage
0 ;PrefBgImRand
0 ;PrefGridSize
0 ;PrefGridDisp
1 ;PrefGridDiff
0 ;PrefGridVar
1 ;PrefAnimGif
1 ;PrefResetIfFalse
1 ;PrefAnimAction
0 ;PrefDrag
0 ;PrefAnimParasit
0 ;PrefPuzzleRotation
0 ;PrefPieceUniq
1 ;PrefAutoNoBoat
animals.ani
background\goutte1.jpg
0 ;PrefKeepRatio
13 ;16 values fo Mix Order of Animated images
12 ;
9 ;
10 ;
7 ;
8 ;
14 ;
11 ;
3 ;
5 ;
2 ;
6 ;
1 ;
15 ;
4 ;
0 ;
00000000 ;ColorInit-0BGR
00bb0000 ;ColorInput-0BGR
00008000 ;ColorPoss-0BGR
009202fb ;ColorFind-0BGR
000060c0 ;ColorSearch-0BGR
000000ff ;ColorBad-0BGR
00b8c7d3 ;ColorCaseBG-0BGR
00c68f80 ;ColorSingleBG-0BGR
00222277 ;ColorBadBG-0BGR
0099b0ca ;ColorCommentBG-0BGR
007ac7fa ;ColorEcranBG-0BGR
0056aaff ;ColorSeparationBG-0BGR
001f3d7b ;ColorHighlightBG-0BGR
00000000 ;ColorBorder-0BGR

Irregular File: IRGBlk.dat

This file describes all the available Irregular grids. Be careful not to erase it by mistake.

For each grid, at the beginning, start with a 'G;N' -> N is the number of blocks in a box

Then for N blocks, 'B;x1;x2;x3;...' --> x1, x2... being position of N cells of block

The position of each cell is given here.

You can add a definition of irregular grid, in Debug mode, from the current grid, by typing the command Shift-W.
At grid generation, Sudoku1 will seek randomly one of the irregulars definition.

Herewith an example:

G;4;
B;0;1;4;5;
B;2;3;6;7;
B;8;9;12;13;
B;10;11;14;15;

File Grid Catalog: Gridlist.dat

This file defines the list of Sudoku1 grids available in the catalog.

By default, grids must be in directory "TextGrid" using format Sudoku1 ".txt".

Define a category starting with '>'.
Put comment lines by starting with ! for french comment and = for english comment
Add simply files name with or withour extension.

WARNING: make a copy of this file before modifications.