Query Parameters

Shogi Playground accepts the following query parameters.

• URL
  • http://play.mogproject.com/index.html
  • https://play.mogproject.com/index.html
• Method: GET

Key	Value	Description	Example
u	USEN Formatted String	Game record (including branches) representation in the USEN (Url Safe sfen-Extended Notation) format. Default: Hirate + No moves	u=~0.7ku36e8uc.
sfen	SFEN Formatted String	<DEPRECATED> Game record representation (trunk only) in the SFEN (Shogi Forsyth-Edwards Notation) format. Default: Hirate + No moves	sfen=lnsgkgsnl/1r5b1/ppppppppp/9/9/9/PPPPPPPPP/1B5R1/LNSGKGSNL b - 0 7g7f 3c3d 2g2f
r	Encoded URL String	URL to an external record file. The value must be encoded properly.	r=https%3A%2F%2Fmogproject.com%2Fpath_to_the%2Fawesome.kif
move	x or y.x	Display position. x: Position Number y: Branch Number (Trunk=0) Default: 0.0	move=5 move=1.23
cx or cy.x	String	Game comments. x: Position Number y: Branch Number (Trunk=0) Default: None	c0=Comment%201 c1.23=Comment%202
mlang	en or ja	Message language. en: English ja: Japanese Default: Saved settings (if available) or the browser's default language	mlang=en
rlang	en or ja	Record language. en: Western Notation ja: Japanese Notation Default: Saved settings (if available) or the browser's default language	rlang=ja
p	Piece Graphic ID	Piece graphic. See the list to know IDs. Default: Saved settings (if available) or ja1	p=en1
flip	true, false, or double	Board flip. true: Flipped false: Not Flipped double: Double Board Mode Default: false	flip=true
sz	Positive Integer	Piece size. The width of a piece on board in pixels. This determines the board size. Default: Saved settings (if available) or Automatic	sz=30
layout	s, c, or w	Board layout. s: Standard c: Compact w: Wide Default: Saved settings (if available) or Standard	layout=w
colorbg	Color	Board background color.	colorbg=ffffff
colorcs	Color	Cursor color.	colorcs=e1b265
colorlm	Color	Last move color.	colorlm=e0e0e0
bi	en, ja, or n	Coordinates on the board. en: English ja: Japanese n: Numbers only Default: Saved settings (if available) or the browser's default language	bi=n
bn	String	Black player's name. Default: Black (depending on the message language)	bn=Alice
wn	String	White player's name. Default: White (depending on the message language)	wn=Bob
ve	true or false	Visual effect. true: Enabled false: Disabled Default: Saved settings (if available) or true	ve=false
se	true or false	Sound effect. true: Enabled false: Disabled Default: Saved settings (if available) or false	se=true
action	image or notes	Special action. image: Create image notes: Notes View Mode Default: None	action=image
free	true or false	Free Mode. The turn-to-move never changes in the game play. true: Enabled false: Disabled Default: false	free=true
embed	true or false	Embedded Mode. The sidebars, menu, and Edit and Resign buttons are not shown. true: Enabled false: Disabled Default: false	embed=true
wc	true or false	For Notes View With comment only. Displays the positions with a comment only. true: Enabled false: Disabled Default: false	wc=true
device	1 or 2	<For Developers> Specifies the device type. 1: Mobile Portrait 2: Mobile Landscape Default: Auto Detect	device=1
dev	true or false	<For Developers> Dev Mode. true: Use settings for the Dev environment false: Use settings for the production environment Default: false	dev=true
debug	true or false	<For Developers> Debug Mode. true: Output verbose messages false: Not output debug messages Default: false	debug=true