------------------------------------------------------------------------------
HSPSW ver3.6 REFERENCE MANUAL                       HSP : Hot Soup Processor  
groggDLLt@X         copyright 2005-2020 (c) onion software  
------------------------------------------------------------------------------

E͂߂

	DLĹAHot Soup Processor ver3ȍ~ƂƂɎgp邱ƂŁA
	STEAMWORKS SDKSteamAg@\𗘗p\ɂ܂B
	HSPSWgp邱ƂɂAȉ̋@\T|[g܂B

		STEAMт̎擾EEĐݒ
		STEAMXe[^Xl̎擾Eݒ


Eg̊Tv

	HSPSWgpꍇ́AXNvg̐擪ɕKu#include "hspsw.as"v
	ƂsǉĂBȏŁAHSP̋@\gÃt@X
	Ă閽߂gp邱Ƃł悤ɂȂ܂B

	HSPSW.DLĹAKSTEAMCXg[ĂŎgpĂB
	sɂ́AHSPSW.DLLƓtH_ɁAȉ̃t@Czu
	Kv܂B

		steam_api.dll			STEAMWORKS API DLL
		sdkencryptedappticket.dll	STEAMWORKS SDK tDLL

	̃t@ĆASTEAMWORKS SDK̃t@CɊ܂܂Ă܂B
	steamworks̃y[W( https://partner.steamgames.com/ )_E[h
	邱ƂłSDKpbP[W(steamworks_sdk_???.zip)t@C
	Rs[ĎgpĂB
	DLĹAA[JCüȉ̃tH_Ɋ܂܂Ă܂B

	/sdk/public/steam/lib/win32/sdkencryptedappticket.dll
	/sdk/redistributable_bin/steam_api.dll


EȌ

	̃vOĆASTEAMWORKS SDK̋@\Ăяo܂B
	ŏɁASTEAMySTEAMWORKS SDKɂẴhLgQƂA
	dg݂ɂėĂĂB

	g̃AvŎgpۂɂ́AAvIDƎсEXe[^X
	炩STEAMŐݒ肵ĂKv܂B

	̃vOCTvł́ASTEAM̃TvQ[uSpacewarv
	(APPID 480)gpăeXgsĂ܂B
	AvID́Austeam_appid.txtvt@CŎw肳Ă܂B
	g̃AvŃeXgꍇ́AeLXgGfB^ŁA
	usteam_appid.txtv̓eCĂB
	usteam_appid.txtv́AKHSPSW.DLLƓtH_ɔzu
	ĂB


Eуe[u

	STEAM̎тꍇ́Aȉ̎菇KvɂȂ܂B

	1. SteamworksAvǗ̎т̐ݒy[WŎтݒ肷
	2. HSPSW.DLLvOCŎуe[u쐬
	3. уe[u̍ŐVNGXg
	4. т̎擾Es

	HSPSW.DLLvOCō쐬R[h́A2`4ɂȂ܂B

	1̎тf[^́AȉɂȂ܂

	API Name : Ăяop(p)AAchievementIDƂĂ΂܂B
	Display Name : \т̖O(UTF-8)
	Description : \т̐(UTF-8)

	炩߁ASteamworksAvǗ̃y[WŐݒsĂB
	łdvȂ̂́AAPI NameŁuACH_WIN_ONE_GAMEvȂǂ̕
	Ǘ܂BKтƂɈقȂ镶w肷Kv܂B

	уe[úAHSPSW.DLLŎт̏~ς邽߂
	GAłBт̏擾sۂɂ炩ߍ쐬Ă
	Kv܂B

	уe[úA쐬Ǝ蓮쐬̂Qʂ̕@ō쐬ł܂B
	쐬́AQ[ɐݒ肳ꂽт̃Xgׂēo^܂B
	́Asteamset_achievement߂ɂčsƂ\łB
	ʏ́Aуe[u쐬ĂĖ肠܂B
	蓮쐬ꍇ́Asteamset_max߂Ńe[u̍ő吔w肵
	ɁAsteamreg_achievement߂APIKEYo^Ă܂B

	уe[u쐬łAsteamreq_status߂ɂŐV̏
	擾ĂBsteamreq_status߂́APɃT[o[Ɏ擾
	NGXgsȂ̂ŁAۂɃf[^󂯎܂ő҂Kv
	܂B

	t[ƂɁAsteamupdate߂ĂяoāASTEAM API
	ԊĎƍXVsĂĂB
	NGXǵAsteamupdate߂Ŏ擾flaglAʐM
	Xe[^X(STEAM_GETSTAT)ɂȂĂ܂B
	ꂪÃXe[^X(STEAM_READY)ɂȂ΁A
	уe[uyуXe[^XXVꂽƂ܂B

	уe[u擾Aȉ̑삪\łB

	steamget_achievement߂ɂт̏Ԃ擾ł܂B
	steamget_achievementstr߂ɂAт̕f[^擾ł܂B

	steamunlock_achievement , steamunlock_achievementkey߂
	Aт邱Ƃł܂B
	steamclear_achievement , steamclear_achievementkey߂ɂ
	тNA(Oɖ߂)邱Ƃł܂B
	т̃NÁAeXgiKł̂ݗp\łB
	ۂ̃Avł̓T|[gȂ̂łӂB

	т̉́AKAvP[VŎKv܂B
	܂Aщsꍇ́AɃT[o[ւ̒ʐMs܂B
	steamupdate߂Ŏ擾flaglAʐM̃Xe[^X(STEAM_GETSTAT)
	̃Xe[^X(STEAM_READY)ɂȂ邱ƂmF悤ɂĂB


EXe[^Xl(STEAMQ[f[^)

	STEAM̃Q[f[^ǂݏꍇ́Aȉ̎菇KvɂȂ܂B

	1. SteamworksAvǗ̐ݒy[WŃQ[f[^ݒ肷
	2. ŐVNGXg
	3. Xe[^Xl̎擾Eݒs

	Xe[^XĺASteamworksAvǗ̐ݒy[WŐݒ肳Q[f[^̂ƂłB
	l(intl)A܂͎(floatl)T[o[ɕێĂAAvP[V
	l̍XVsƂ\łB
	Q[f[^͎тƌтĂāAQ[f[^lƂɎт
	т̒BxAQ[f[^ƂɎZoȂǂŎg܂B
	̒`́AׂăAvǗ̐ݒy[Wōs܂B

	Xe[^XĺAуe[uƃZbgŊǗĂ܂B
	steamreq_status߂ɂAT[o[ŐṼf[^擾ۂ
	Xe[^XlXV܂B

	Xe[^Xl̎擾́Asteamget_statusAsteamget_statusf߂
	gp܂B(floatl̏ꍇ́Aufv̕t߂gp܂)

	Xe[^Xl̐ݒ́Asteamset_statusAsteamset_statusf߂
	gp܂B(floatl̏ꍇ́Aufv̕t߂gp܂)
	Xe[^Xlݒ肵ꍇ́AɃT[o[ւ̒ʐMs܂B
	steamupdate߂Ŏ擾flaglAʐM̃Xe[^X(STEAM_GETSTAT)
	̃Xe[^X(STEAM_READY)ɂȂ邱ƂmF悤ɂĂB
	܂Ƃ߂ăXe[^Xlݒ肷ꍇ́A1񂲂ƂɒʐM҂Kv
	܂B

		:
			steamset_status "NumGames",99
			steamset_statusf "MaxFeetTraveled",1.1
			repeat
				steamupdate flag
				if flag=STEAM_READY : break
				if flag=STEAM_ERROR : break
			loop


ELO(SteamLO)

	LO(SteamLO)͏̃o[WŒ񋟂\łB


E߈ꗗ

	steaminit                                       STEAM APȈ
	steambye                                        STEAM APȈI
	steamupdate                                     STEAM API̍XV
	steamset_max                                    уe[ȕ
	steamreq_status                                 Xe[^X擾NGXg

	steamset_achievement                            уe[uݒ
	steamreg_achievement                            уe[uݒ
	steamget_achievement                            уe[ul擾
	steamget_achievementstr                         уe[u擾
	steamunlock_achievement                         т̉
	steamunlock_achievementkey                      т̉
	steamclear_achievement                          т̃NA
	steamclear_achievementkey                       т̃NA

	steamset_status                                 Xe[^Xl̐ݒ
	steamset_statusf                                Xe[^Xl̐ݒ
	steamget_status                                 Xe[^Xl̎擾
	steamget_statusf                                Xe[^Xl̎擾


E߂̏ڍ

	steaminit                                       STEAM APȈ

		STEAM APȈs܂B
		ŏɂP񂾂sĂB
		sɌʂVXeϐstatɊi[܂B
		0ȂΐIAȊO̓G[ƂĂ܂B
		lbg[N̐ڑłȂꍇASTEAMNĂȂ
		ꍇ̓G[ɂȂ܂B


	steambye                                        STEAM APȈI

		STEAM APȈIs܂B
		vOIɎIɌĂяôŁA
		ʏ͎sKv͂܂B


	steamupdate var                                 STEAM API̍XV

		var : flaglϐ

		STEAM API̍XVs܂B
		ŁASTEAM̏擾AʐM̏s܂B
		莞ԂƂɌĂяoKv܂B
		ʏ́AC̕`t[[vȂǂɓĂgpB
		sflaglw肳ꂽϐɊi[܂B
		flagl̓éAȉ̒ʂłB

		x             | l    
		------------------------------------------------------
		STEAM_NONE         |  0    ̏
		STEAM_ERROR        |  1    G[
		STEAM_READY        |  2    ҋ@
		STEAM_GETSTAT      |  3    NGXgM

		NGXgʐMȂǂsĂŒ́AflaglSTEAM_GETSTAT
		ȂĂ܂BKASTEAM_READYɖ߂邱ƂmFĂB
		炩̃G[ꍇ́ASTEAM_ERRORƂȂ܂B
		̏ꍇ́AēxNGXgsȂǓK؂ȕA
		ĂB


	steamset_achievement                            уe[uݒ

		уe[uݒ肵܂B
		уe[úA炩ߕKvȎт̏~ς邽߂
		GAłB
		̖߂ɂAQ[ɐݒ肳ꂽт̃XgI
		уe[uɓo^܂B
		蓮Ŏуe[uݒ肷ꍇ́Asteamset_maxy
		steamreg_achievement߂gpĂB

		sɎݒ肳ꂽт̐VXeϐstatɊi[܂B
		VXeϐstat0̏ꍇ́Aݒ肳ȂƂ܂B


	steamset_max p1                                 уe[ȕ

		p1 (0)       : уe[uŊǗт̐

		уe[u蓮ݒ肷邽߂ɏs܂B
		p1Ŏуe[uŊǗт̐w肵܂B
		ȍ~́Asteamreg_achievementŔCӂ̎уe[uݒ肷
		Ƃł܂B


	steamreg_achievement index,"APINAME"            уe[uݒ

		index (0) : ݒ肷т̃CfbNX(0`)
		"APINAME" : ݒ肷тAPI Name

		уe[u蓮Őݒ肵܂B
		index0n܂тindexlw肵܂B
		"APINAME"ŁA炩ߐݒ肳ĂAPI Namew肵܂B
		sɌʂVXeϐstatɊi[܂B
		0ȂΐIAȊO̓G[ƂĂ܂B


	steamreq_status                                 Xe[^X擾NGXg
		STEAMT[o[сEXe[^Xl̍ŐV擾
		NGXgs܂B
		̖ߎśAT[o[ւ̒ʐMs܂B
		steamupdate߂Ŏ擾flaglAʐM(STEAM_GETSTAT)
		(STEAM_READY)ɂȂ邱ƂmF悤ɂĂB

		:
			steamreq_status
			repeat
				steamupdate flag
				if flag=STEAM_READY : break
				if flag=STEAM_ERROR : break
			loop


	steamget_achievement var, index                 уe[ul擾

		var   : ʂϐ
		index (0) : 擾т̃CfbNX(0`)

		уe[uɐݒ肳ꂽщ̏擾܂B
		varŎw肳ꂽϐɐ^Ōʂ܂B
		щ̏́Aȉ̒lɂȂ܂B

			-1 : щĂ
			0  : щĂȂ

		sɌʂVXeϐstatɊi[܂B
		0ȂΐIAȊO̓G[ƂĂ܂B


	steamget_achievementstr var, index,type        уe[u擾

		var   : ʂϐ
		index (0) : 擾т̃CfbNX(0`)
		type (0)  : 擾l̃^Cv

		уe[uɐݒ肳ꂽ擾܂B
		varŎw肳ꂽϐɕ^Ōʂ܂B
		擾l̃^CvĺAȉ̒lɂȂ܂B

			0  : API Name
			1  : Display Name : \т̖O(UTF-8)
			2  : Description : \т̐(UTF-8)

		sɌʂVXeϐstatɊi[܂B
		0ȂΐIAȊO̓G[ƂĂ܂B


	steamunlock_achievement index                   т̉

		index (0) : уe[ũCfbNX(0`)

		w肳ꂽт܂B
		̖ߎśAT[o[ւ̒ʐMs܂̂ŁA
		XVs邱ƂmFĂB


	steamunlock_achievementkey "API Name"           т̉

		"API Name" : тAPI Name

		w肳ꂽт܂B
		̖ߎśAT[o[ւ̒ʐMs܂̂ŁA
		XVs邱ƂmFĂB


	steamclear_achievement index                    т̃NA

		index (0) : уe[ũCfbNX(0`)

		w肳ꂽтZbg(ȌԂɖ߂)܂B
		т̃NÁAeXgiKł̂ݗp\łB
		ۂ̃Avł̓T|[gȂ̂łӂB
		̖ߎśAT[o[ւ̒ʐMs܂̂ŁA
		XVs邱ƂmFĂB


	steamclear_achievementkey "API Name"            т̃NA

		"API Name" : тAPI Name

		w肳ꂽтZbg(ȌԂɖ߂)܂B
		т̃NÁAeXgiKł̂ݗp\łB
		ۂ̃Avł̓T|[gȂ̂łӂB
		̖ߎśAT[o[ւ̒ʐMs܂̂ŁA
		XVs邱ƂmFĂB


	steamset_status "API Name", p1                  Xe[^Xl̐ݒ

		"API Name" : Xe[^XlAPI Name
		p1(0)      : ݒ肷Xe[^Xl

		w肳ꂽXe[^Xl𐮐Őݒ肵܂B
		sɌʂVXeϐstatɊi[܂B
		0ȂΐIAȊO̓G[ƂĂ܂B
		̖ߎśAT[o[ւ̒ʐMs܂̂ŁA
		XVs邱ƂmFĂB


	steamset_statusf "API Name", p1                 Xe[^Xl̐ݒ

		"API Name" : Xe[^XlAPI Name
		p1(0)      : ݒ肷Xe[^Xl()

		w肳ꂽXe[^XlŐݒ肵܂B
		sɌʂVXeϐstatɊi[܂B
		0ȂΐIAȊO̓G[ƂĂ܂B
		̖ߎśAT[o[ւ̒ʐMs܂̂ŁA
		XVs邱ƂmFĂB


	steamget_status var, "API Name"                 Xe[^Xl̎擾

		var   : ʂϐ
		"API Name" : Xe[^XlAPI Name

		w肳ꂽXe[^Xl擾܂B
		ʂ́AvarŎw肳ꂽϐɐ^ő܂B
		sɌʂVXeϐstatɊi[܂B
		0ȂΐIAȊO̓G[ƂĂ܂B


	steamget_statusf var, "API Name"                Xe[^Xl̎擾

		var   : ʂϐ
		"API Name" : Xe[^XlAPI Name

		w肳ꂽXe[^Xl擾܂B
		ʂ́AvarŎw肳ꂽϐɎ^ő܂B
		sɌʂVXeϐstatɊi[܂B
		0ȂΐIAȊO̓G[ƂĂ܂B


EXV

	2018/09/30

		ŏ̃o[WB


Eӓ_

	HSPSW.DLĹAHSP3.EXEƓɎgpvOCt@CłB
	gpHSṔAver3.0ȏgBver2.61₻ȑOHSPɂ
	ΉĂ܂̂łӉB
	EXEt@C쐬ꍇłAHSPSW.DLLEXEt@CƓfBNg
	ɒuȂƓ삵܂B܂ApackfileDLLǉ邱Ƃ͂ł܂B


ECZXјA

	[U[HSPgč쐬IWĩ\tgEFA(st@C)
	́A쐬[U[ɑ܂B
	CZXHSPƓlBSDCZXɂȂ܂B
	LE킸HSPSW.DLLRɔzz邱Ƃł܂B

	[U[쐬IWĩ\tgEFAɑ΂onion software쌠
	咣邱Ƃ͂܂B
	onion software͖{vOɂĐAȂ鑹QɂĂ
	ۏ؂܂BȂ̐ӔC͈̔͂ŎgpĂB
	HSPSW.DLĹAMicrosoft Visual Studio 2017ŃRpC ܂B 


-------------------------------------------------------------------------------
                                                HSP users manual / end of file 
-------------------------------------------------------------------------------
