###############################################################################
#####          How to create a game description file for Wiimmfi          #####
###############################################################################
#
# This file is encoded in UTF-8.
#
# Go through this file and replace at least all <<xxx>> words. Easiest way is
# to search "<<". You can also search+replace using the following list:
#
# 1x  <<USER>>   : Your user name for the game history.  e.g. "Wiimm"
# 5x  <<TITLE>>  : Game title.                           e.g. "Mario Kart Wii"
# 1x  <<SHORT>>  : Short game title with 20 chars max.   e.g. "MKWii"
# 1x  <<TYPE>>   : Game type: NDS | Wii | DSiWare | WiiWare | Mix
# 1x  <<NAME>>   : The internal name of the game.        e.g. "mariokartwii"
# 1x  <<SECRET>> : The secret for encrypted data.        e.g. "9r3Rmy"
# 6x  <<ID3>>    : First 3 charaters of game ID.         e.g. "RMC"
#
# Replacing all <<values>> is mandatory. For >90% of the games you don't need
# to edit other parameters. One usual exeption is 'FC_MODE' for NDS, DSiWare
# and WiiWare games. So watch out if your friend code is correct displayed at
# Wiimmfi.
#
# Ignore the comments with tags like [!dbm] or [!id]. They are search points
# for later optimization by Wiimm of all definition files.
#
# Read file http://download.wiimm.de/wiimmfi/game-definitions/+INFO.txt for a
# description of all parameters.
#
# Visit http://download.wiimm.de/mkw-ana/lists/ for known names and secrets.
#
###############################################################################

#--- to-do list for Wiimm
# [?] [?GENERIC] [?OPENHOST] [?VERIFY_GID] [?IDLIST] [?DB_MEMBER]

#--- history
HISTORY 2018-xx-xx Game enabled. Game definition by flicky.
#HISTORY 2018-xx-xx First DB_MEMBER analysis.
#HISTORY 2018-xx-xx Final DB_MEMBER analysis.
#HISTORY 2018-xx-xx OPENHOST doesn't work (@ERROR@xxx@error xxx@; by xxx).

#--- main data
GAMETYPE	NDS
TITLE		Pang: Magical Michael
SHORT		Pang
INFO
URL
NAME		pangmagmichds
GAMEID
REF_ID
SECRET		ccXnxb
ENCODE		3
ACCESS		1

#--- friend code options
FC_MODE		1	# 0:unknown, 1:Wii, 2:NDS / for other values see '+INFO.txt'
FC_ASSIGN	1	# 0:disabled, 1:enabled (user can assign old FC)
FC_CONVERT	2	# 0:off, >0:enabled if >1 games, 2:print 'test' hint

#--- options (0=off, 1=on, 2=on+special)
GENERIC		1	# generic db members
MKW_STAT	0	# special MKW support
SECOND_MII	0	# accept a second Mii name @nas/pr
DB_FRIENDS	2	# store and manage friend lists via DB
AUTO_PRWORDS	1	# calc the 'prwords' reply (validate names)
REPLY_KA	0	# reply each incoming KA with a server side KA
STANDBY		0	# GPCM notifies MASTER, if standby modus changed
GPCM_STATUS	0	# GPCM sends special status messages to the game
BLACK_LIST	2	# enable black list support for OPENHOST (2=testing)
WHITE_LIST	2	# enable white list support for OPENHOST (2=testing)
OWN_ROOM	0	# enable own room detection and allow kicking
ENTER_ROOM	0	# enable 'enter room' feature
NEW_P_LIMITS	0	# enable profile creation limits
VERIFY_GID	-1	# enable a Game-ID check (-1: not decided and disabled)
ACTIVATED	0	# console must be activated to use this game
MEMORY_TABLE	0	# Use a »memory storage engine« for the database table
DUMP_MASTER_03	1	# dump MASTER-03 records for DB member analysis
DUMP_MS_QUERY	1	# dump MS queries for general analysis

#--- game specific DLS1 server; leave it empty for the default server
DLS1

#--- Reply of 'nas/pr'. The value will be base64-encoded by the server.
#    Define one line for each 'name=value' pair.
#PR_REPLY	prwords=0

#------------------------------------------------------------------------------
# MODE LEVEL:
#	OFF:	disabled
#	TEST:	test mode
#	PART:	partially working
#	ISSUE:	works good with some small issues
#	NOSTAT:	only global statistics/leaderboards do not work
#	FULL:	works full
#------------------------------------------------------------------------------
# up to 4 lines for each game variant:
# 'GAME'   MODE	ID4	game title	(mandatory)
# 'G-INFO'	ID4	game status	(optional)
# 'G-URL'	ID4	game URL	(optional)
# 'G-IDLIST'	ID4	id_list...	(optional)  [!id]
#==============================================================================
# Don't remove regions here!!
GAME	TEST	<<ID3>>J	<<TITLE>> (Japan)
GAME	TEST	BR5P	Pang: Magical Michael (PAL)
GAME	TEST	<<ID3>>E	<<TITLE>> (USA)
GAME	TEST	<<ID3>>K	<<TITLE>> (Korea)
#------------------------------------------------------------------------------
G-IDLIST	BR5P	BR5
#==============================================================================

# [!dbm] no records analysed.
# [!dbm] only xx records analysed.

DB_MEMBER	numplayers	tinyint unsigned	# ..
DB_MEMBER	maxplayers	tinyint unsigned	# |

# Standard DWC-members. Some games use them only partially. [!dbm]
DB_MEMBER	dwc_pid		int unsigned not NULL	# <PID>
DB_MEMBER	dwc_mtype	tinyint unsigned	# 
DB_MEMBER	dwc_mresv	int unsigned		# 
DB_MEMBER	dwc_mver	tinyint unsigned	# 
DB_MEMBER	dwc_eval	tinyint unsigned	# 
DB_MEMBER	dwc_groupid	int unsigned		# 
DB_MEMBER	dwc_hoststate	tinyint unsigned	# 
DB_MEMBER	dwc_suspend	tinyint unsigned	# 

# Frequently found members.
# [!dbm] to less records analysed to use smaller types.
#DB_MEMBER	str_key		varchar(20)		# 
#DB_MEMBER	int_key		varchar(20)		# 

# sequence number: incremented by Wiimm on every DB_MEMBER update
DB_VERSION	100