Create and sell game packs - Revision history

Whirled vox: Text replacement - """ to """

2018-09-03T17:49:57Z

Text replacement - """ to """

← Older revision		Revision as of 17:49, 3 September 2018
Line 20:		Line 20:
	In order to use gamepacks while testing on your PC do the following:		In order to use gamepacks while testing on your PC do the following:

	* In the whirled directory there is a ~~"~~dist~~"~~ directory, you must place your packs in there.		* In the whirled directory there is a "dist" directory, you must place your packs in there.
	* Edit your game's config.xml file (create the file in game's directory if it doesn't already exist) to point to your level packs. It should look something like this:		* Edit your game's config.xml file (create the file in game's directory if it doesn't already exist) to point to your level packs. It should look something like this:

Line 27:		Line 27:
	<packs>		<packs>
	<!-- Music -->		<!-- Music -->
	<level ident=~~"~~mus_night~~"~~ name=~~"~~mus_night~~"~~ mediaURL=~~"~~http://127.0.0.1:8080/levelpacks/music/popcraft_music_night.mp3~~"~~/>		<level ident="mus_night" name="mus_night" mediaURL="http://127.0.0.1:8080/levelpacks/music/popcraft_music_night.mp3"/>
	<level ident=~~"~~mus_day~~"~~ name=~~"~~mus_day~~"~~ mediaURL=~~"~~http://127.0.0.1:8080/levelpacks/music/popcraft_music_day.mp3~~"~~/>		<level ident="mus_day" name="mus_day" mediaURL="http://127.0.0.1:8080/levelpacks/music/popcraft_music_day.mp3"/>
	</packs>		</packs>
	</game>		</game>
Line 40:		Line 40:
	#Choose '''Games &rarr; My Games''' to see the Games you own.		#Choose '''Games &rarr; My Games''' to see the Games you own.
	#Click the Edit link under the game you want to make a game pack for.		#Click the Edit link under the game you want to make a game pack for.
	#Select either the ~~"~~Item Packs~~"~~ or ~~"~~Level Packs~~"~~ tab.		#Select either the "Item Packs" or "Level Packs" tab.
	#Click on the ~~"~~Create~~"~~ button to get the game pack creation interface. [[Image:Stuff-Create_item_pack.png\|none\|thumb\|400px\|Item pack interface. The level pack creation interface looks similar, but says level instead of item and has the premium checkbox optional.]]		#Click on the "Create" button to get the game pack creation interface. [[Image:Stuff-Create_item_pack.png\|none\|thumb\|400px\|Item pack interface. The level pack creation interface looks similar, but says level instead of item and has the premium checkbox optional.]]
	##Click on the '''Name''' field and enter a name for your item or level pack. This is the name that is displayed under the item or level pack if it is sold in the shop. It will also be used on the Item or Level Pack tab when you edit your game.		##Click on the '''Name''' field and enter a name for your item or level pack. This is the name that is displayed under the item or level pack if it is sold in the shop. It will also be used on the Item or Level Pack tab when you edit your game.
	##Click on the '''Identifier''' field and enter an identifier for your item or level pack. This string is used to identify this item or level pack in your game code. For the example code shown above, the level pack source identifiers are mus_night and mus_day.		##Click on the '''Identifier''' field and enter an identifier for your item or level pack. This string is used to identify this item or level pack in your game code. For the example code shown above, the level pack source identifiers are mus_night and mus_day.
Line 58:		Line 58:
	{{main\|List}}		{{main\|List}}

	Listing the game pack is similar to listing any other item in the shop. However, the main game has to be listed before any game packs can be listed. Go to the Item or Level Packs tab and click on ~~"~~list~~"~~ for the pack you wish to list. This will give you a popup with the listing screen to fill out with the desired options that are outlined [[List#Listing_Options\|here]].		Listing the game pack is similar to listing any other item in the shop. However, the main game has to be listed before any game packs can be listed. Go to the Item or Level Packs tab and click on "list" for the pack you wish to list. This will give you a popup with the listing screen to fill out with the desired options that are outlined [[List#Listing_Options\|here]].

	''NOTE: Even if you are not planning to sell your pack for coins/bars (premium), you still have to list the item in order for other players to have access to it. In that case, you will use the ~~"~~Hidden~~"~~ option under Strategy on the listing screen.''		''NOTE: Even if you are not planning to sell your pack for coins/bars (premium), you still have to list the item in order for other players to have access to it. In that case, you will use the "Hidden" option under Strategy on the listing screen.''

	== Coding the Game Pack into a Game ==		== Coding the Game Pack into a Game ==
Line 136:		Line 136:
	{		{
	// event.contentType will either be ITEM_PACK or LEVEL_PACK		// event.contentType will either be ITEM_PACK or LEVEL_PACK
	// event.contentIdent will be the ~~"~~ident~~"~~ string for the pack they bought		// event.contentIdent will be the "ident" string for the pack they bought
	if (event.contentType == GameContentEvent.ITEM_PACK) {		if (event.contentType == GameContentEvent.ITEM_PACK) {
	gameCtrl.game.systemMessage(~~"~~player ~~"~~ + event.playerId + ~~"~~ bought the item pack with id ~~"~~ + event.contentIdent);		gameCtrl.game.systemMessage("player " + event.playerId + " bought the item pack with id " + event.contentIdent);
	}		}
	</actionscript>		</actionscript>

Whirled vox: Text replacement - "<" to "<"

2018-08-30T21:06:48Z

Text replacement - "<" to "<"

← Older revision		Revision as of 21:06, 30 August 2018
Line 23:		Line 23:
	* Edit your game's config.xml file (create the file in game's directory if it doesn't already exist) to point to your level packs. It should look something like this:		* Edit your game's config.xml file (create the file in game's directory if it doesn't already exist) to point to your level packs. It should look something like this:

	~~<~~game>		<game>
	~~<~~params/>		<params/>
	~~<~~packs>		<packs>
	~~<~~!-- Music -->		<!-- Music -->
	~~<~~level ident="mus_night" name="mus_night" mediaURL="http://127.0.0.1:8080/levelpacks/music/popcraft_music_night.mp3"/>		<level ident="mus_night" name="mus_night" mediaURL="http://127.0.0.1:8080/levelpacks/music/popcraft_music_night.mp3"/>
	~~<~~level ident="mus_day" name="mus_day" mediaURL="http://127.0.0.1:8080/levelpacks/music/popcraft_music_day.mp3"/>		<level ident="mus_day" name="mus_day" mediaURL="http://127.0.0.1:8080/levelpacks/music/popcraft_music_day.mp3"/>
	~~<~~/packs>		</packs>
	~~<~~/game>		</game>

	You can have any directory structure you like as long as the file exists somewhere under dist.		You can have any directory structure you like as long as the file exists somewhere under dist.
Line 66:		Line 66:
	To get a list of all the game packs and items packs available to your game, you can call [http://www.whirled.com/code/asdocs/com/whirled/game/GameSubControl.html#getLevelPacks() getLevelPacks()] and [http://www.whirled.com/code/asdocs/com/whirled/game/GameSubControl.html#getItemPacks() getItemPacks()] on the [[GameSubControl]] object.		To get a list of all the game packs and items packs available to your game, you can call [http://www.whirled.com/code/asdocs/com/whirled/game/GameSubControl.html#getLevelPacks() getLevelPacks()] and [http://www.whirled.com/code/asdocs/com/whirled/game/GameSubControl.html#getItemPacks() getItemPacks()] on the [[GameSubControl]] object.

	~~<~~actionscript>		<actionscript>
	gameCtrl.game.getLevelPacks();		gameCtrl.game.getLevelPacks();
	or		or
	gameCtrl.game.getItemPacks();		gameCtrl.game.getItemPacks();

	~~<~~/actionscript>		</actionscript>

	This call will return an array of objects containing:		This call will return an array of objects containing:

	~~<~~actionscript>		<actionscript>
	ident - string identifier of item pack (This is the same string that you specified during the pack upload)		ident - string identifier of item pack (This is the same string that you specified during the pack upload)
	name - human readable name of item pack		name - human readable name of item pack
	mediaURL - URL for item pack content		mediaURL - URL for item pack content
	premium - boolean indicating that content is premium or not		premium - boolean indicating that content is premium or not
	~~<~~/actionscript>		</actionscript>

	For level packs, there are some convenience code in the contrib section ([http://www.whirled.com/code/contrib/asdocs/com/whirled/contrib/LevelPack.html LevelPacks] & [http://www.whirled.com/code/contrib/asdocs/com/whirled/contrib/LevelPackManager.html LevelPackManager]) that helps you parse and manage the arrays.		For level packs, there are some convenience code in the contrib section ([http://www.whirled.com/code/contrib/asdocs/com/whirled/contrib/LevelPack.html LevelPacks] & [http://www.whirled.com/code/contrib/asdocs/com/whirled/contrib/LevelPackManager.html LevelPackManager]) that helps you parse and manage the arrays.

	~~<~~actionscript>		<actionscript>
	import com.whirled.contrib.LevelPackManager;		import com.whirled.contrib.LevelPackManager;
	....		....
	public static var allLevelPacks :LevelPackManager = new LevelPackManager();		public static var allLevelPacks :LevelPackManager = new LevelPackManager();
	allLevelPacks.init(gameCtrl.game.getLevelPacks());		allLevelPacks.init(gameCtrl.game.getLevelPacks());
	~~<~~/actionscript>		</actionscript>

	There currently is no equivalent convenience code for item packs, but you can easily write something similar and [http://www.whirled.com/#whirleds-d_65 contribute it].		There currently is no equivalent convenience code for item packs, but you can easily write something similar and [http://www.whirled.com/#whirleds-d_65 contribute it].
Line 108:		Line 108:

	'''To open up the LevelPacks Game Shop with all level packs for sale for your game''':		'''To open up the LevelPacks Game Shop with all level packs for sale for your game''':
	~~<~~actionscript>		<actionscript>
	var gameCtrl :GameControl = new GameControl(this);		var gameCtrl :GameControl = new GameControl(this);
	gameCtrl.local.showGameShop(GameControl.LEVEL_PACK_SHOP);		gameCtrl.local.showGameShop(GameControl.LEVEL_PACK_SHOP);
	~~<~~/actionscript>		</actionscript>

	'''To open up the Item pack Game Shop displaying details for an item pack with catalogID of 555''':		'''To open up the Item pack Game Shop displaying details for an item pack with catalogID of 555''':
	~~<~~actionscript>		<actionscript>

	var catalogID :int = 555;		var catalogID :int = 555;
	gameCtrl.local.showGameShop(GameControl.ITEM_PACK_SHOP, catalogID);		gameCtrl.local.showGameShop(GameControl.ITEM_PACK_SHOP, catalogID);
	~~<~~/actionscript>		</actionscript>

	'''You can obtain the catalog ID when you list your item/level pack. For example the catalog ID of the following level pack http://www.whirled.com/#shop-l_11_99 is 99'''.		'''You can obtain the catalog ID when you list your item/level pack. For example the catalog ID of the following level pack http://www.whirled.com/#shop-l_11_99 is 99'''.
Line 128:		Line 128:
	To listen for when someone buys an item pack (that they don't already own) for your game while inside your game, you can register to listen for the PLAYER_CONTENT_ADDED event.		To listen for when someone buys an item pack (that they don't already own) for your game while inside your game, you can register to listen for the PLAYER_CONTENT_ADDED event.

	~~<~~actionscript>		<actionscript>
	gameCtrl.player.addEventListener(GameContentEvent.PLAYER_CONTENT_ADDED, playerContentAdded);		gameCtrl.player.addEventListener(GameContentEvent.PLAYER_CONTENT_ADDED, playerContentAdded);
	~~<~~/actionscript>		</actionscript>

	~~<~~actionscript>		<actionscript>
	protected function playerContentAdded (event :GameContentEvent) :void		protected function playerContentAdded (event :GameContentEvent) :void
	{		{
Line 140:		Line 140:
	gameCtrl.game.systemMessage("player " + event.playerId + " bought the item pack with id " + event.contentIdent);		gameCtrl.game.systemMessage("player " + event.playerId + " bought the item pack with id " + event.contentIdent);
	}		}
	~~<~~/actionscript>		</actionscript>

	You can also get a list of the packs that a player currently owns by calling [http://www.whirled.com/code/asdocs/com/whirled/game/PlayerSubControl.html#getPlayerItemPacks() getPlayerItemPacks(playerId:int)] or [http://www.whirled.com/code/asdocs/com/whirled/game/PlayerSubControl.html#getPlayerLevelPacks() getPlayerLevelPacks(playerId:int)] on the [[PlayerSubControl]].		You can also get a list of the packs that a player currently owns by calling [http://www.whirled.com/code/asdocs/com/whirled/game/PlayerSubControl.html#getPlayerItemPacks() getPlayerItemPacks(playerId:int)] or [http://www.whirled.com/code/asdocs/com/whirled/game/PlayerSubControl.html#getPlayerLevelPacks() getPlayerLevelPacks(playerId:int)] on the [[PlayerSubControl]].

	[[Category:Code tutorials]][[Category:Tutorials]][[Category:Game tutorials]]		[[Category:Code tutorials]][[Category:Tutorials]][[Category:Game tutorials]]

Whirled vox: Text replacement - ">" to ">"

2018-08-30T21:03:45Z

Text replacement - ">" to ">"

← Older revision		Revision as of 21:03, 30 August 2018
Line 23:		Line 23:
	* Edit your game's config.xml file (create the file in game's directory if it doesn't already exist) to point to your level packs. It should look something like this:		* Edit your game's config.xml file (create the file in game's directory if it doesn't already exist) to point to your level packs. It should look something like this:

	<game~~>~~		<game>
	<params/~~>~~		<params/>
	<packs~~>~~		<packs>
	<!-- Music --~~>~~		<!-- Music -->
	<level ident="mus_night" name="mus_night" mediaURL="http://127.0.0.1:8080/levelpacks/music/popcraft_music_night.mp3"/~~>~~		<level ident="mus_night" name="mus_night" mediaURL="http://127.0.0.1:8080/levelpacks/music/popcraft_music_night.mp3"/>
	<level ident="mus_day" name="mus_day" mediaURL="http://127.0.0.1:8080/levelpacks/music/popcraft_music_day.mp3"/~~>~~		<level ident="mus_day" name="mus_day" mediaURL="http://127.0.0.1:8080/levelpacks/music/popcraft_music_day.mp3"/>
	</packs~~>~~		</packs>
	</game~~>~~		</game>

	You can have any directory structure you like as long as the file exists somewhere under dist.		You can have any directory structure you like as long as the file exists somewhere under dist.
Line 66:		Line 66:
	To get a list of all the game packs and items packs available to your game, you can call [http://www.whirled.com/code/asdocs/com/whirled/game/GameSubControl.html#getLevelPacks() getLevelPacks()] and [http://www.whirled.com/code/asdocs/com/whirled/game/GameSubControl.html#getItemPacks() getItemPacks()] on the [[GameSubControl]] object.		To get a list of all the game packs and items packs available to your game, you can call [http://www.whirled.com/code/asdocs/com/whirled/game/GameSubControl.html#getLevelPacks() getLevelPacks()] and [http://www.whirled.com/code/asdocs/com/whirled/game/GameSubControl.html#getItemPacks() getItemPacks()] on the [[GameSubControl]] object.

	<actionscript~~>~~		<actionscript>
	gameCtrl.game.getLevelPacks();		gameCtrl.game.getLevelPacks();
	or		or
	gameCtrl.game.getItemPacks();		gameCtrl.game.getItemPacks();

	</actionscript~~>~~		</actionscript>

	This call will return an array of objects containing:		This call will return an array of objects containing:

	<actionscript~~>~~		<actionscript>
	ident - string identifier of item pack (This is the same string that you specified during the pack upload)		ident - string identifier of item pack (This is the same string that you specified during the pack upload)
	name - human readable name of item pack		name - human readable name of item pack
	mediaURL - URL for item pack content		mediaURL - URL for item pack content
	premium - boolean indicating that content is premium or not		premium - boolean indicating that content is premium or not
	</actionscript~~>~~		</actionscript>

	For level packs, there are some convenience code in the contrib section ([http://www.whirled.com/code/contrib/asdocs/com/whirled/contrib/LevelPack.html LevelPacks] & [http://www.whirled.com/code/contrib/asdocs/com/whirled/contrib/LevelPackManager.html LevelPackManager]) that helps you parse and manage the arrays.		For level packs, there are some convenience code in the contrib section ([http://www.whirled.com/code/contrib/asdocs/com/whirled/contrib/LevelPack.html LevelPacks] & [http://www.whirled.com/code/contrib/asdocs/com/whirled/contrib/LevelPackManager.html LevelPackManager]) that helps you parse and manage the arrays.

	<actionscript~~>~~		<actionscript>
	import com.whirled.contrib.LevelPackManager;		import com.whirled.contrib.LevelPackManager;
	....		....
	public static var allLevelPacks :LevelPackManager = new LevelPackManager();		public static var allLevelPacks :LevelPackManager = new LevelPackManager();
	allLevelPacks.init(gameCtrl.game.getLevelPacks());		allLevelPacks.init(gameCtrl.game.getLevelPacks());
	</actionscript~~>~~		</actionscript>

	There currently is no equivalent convenience code for item packs, but you can easily write something similar and [http://www.whirled.com/#whirleds-d_65 contribute it].		There currently is no equivalent convenience code for item packs, but you can easily write something similar and [http://www.whirled.com/#whirleds-d_65 contribute it].
Line 108:		Line 108:

	'''To open up the LevelPacks Game Shop with all level packs for sale for your game''':		'''To open up the LevelPacks Game Shop with all level packs for sale for your game''':
	<actionscript~~>~~		<actionscript>
	var gameCtrl :GameControl = new GameControl(this);		var gameCtrl :GameControl = new GameControl(this);
	gameCtrl.local.showGameShop(GameControl.LEVEL_PACK_SHOP);		gameCtrl.local.showGameShop(GameControl.LEVEL_PACK_SHOP);
	</actionscript~~>~~		</actionscript>

	'''To open up the Item pack Game Shop displaying details for an item pack with catalogID of 555''':		'''To open up the Item pack Game Shop displaying details for an item pack with catalogID of 555''':
	<actionscript~~>~~		<actionscript>

	var catalogID :int = 555;		var catalogID :int = 555;
	gameCtrl.local.showGameShop(GameControl.ITEM_PACK_SHOP, catalogID);		gameCtrl.local.showGameShop(GameControl.ITEM_PACK_SHOP, catalogID);
	</actionscript~~>~~		</actionscript>

	'''You can obtain the catalog ID when you list your item/level pack. For example the catalog ID of the following level pack http://www.whirled.com/#shop-l_11_99 is 99'''.		'''You can obtain the catalog ID when you list your item/level pack. For example the catalog ID of the following level pack http://www.whirled.com/#shop-l_11_99 is 99'''.
Line 128:		Line 128:
	To listen for when someone buys an item pack (that they don't already own) for your game while inside your game, you can register to listen for the PLAYER_CONTENT_ADDED event.		To listen for when someone buys an item pack (that they don't already own) for your game while inside your game, you can register to listen for the PLAYER_CONTENT_ADDED event.

	<actionscript~~>~~		<actionscript>
	gameCtrl.player.addEventListener(GameContentEvent.PLAYER_CONTENT_ADDED, playerContentAdded);		gameCtrl.player.addEventListener(GameContentEvent.PLAYER_CONTENT_ADDED, playerContentAdded);
	</actionscript~~>~~		</actionscript>

	<actionscript~~>~~		<actionscript>
	protected function playerContentAdded (event :GameContentEvent) :void		protected function playerContentAdded (event :GameContentEvent) :void
	{		{
Line 140:		Line 140:
	gameCtrl.game.systemMessage("player " + event.playerId + " bought the item pack with id " + event.contentIdent);		gameCtrl.game.systemMessage("player " + event.playerId + " bought the item pack with id " + event.contentIdent);
	}		}
	</actionscript~~>~~		</actionscript>

	You can also get a list of the packs that a player currently owns by calling [http://www.whirled.com/code/asdocs/com/whirled/game/PlayerSubControl.html#getPlayerItemPacks() getPlayerItemPacks(playerId:int)] or [http://www.whirled.com/code/asdocs/com/whirled/game/PlayerSubControl.html#getPlayerLevelPacks() getPlayerLevelPacks(playerId:int)] on the [[PlayerSubControl]].		You can also get a list of the packs that a player currently owns by calling [http://www.whirled.com/code/asdocs/com/whirled/game/PlayerSubControl.html#getPlayerItemPacks() getPlayerItemPacks(playerId:int)] or [http://www.whirled.com/code/asdocs/com/whirled/game/PlayerSubControl.html#getPlayerLevelPacks() getPlayerLevelPacks(playerId:int)] on the [[PlayerSubControl]].

	[[Category:Code tutorials]][[Category:Tutorials]][[Category:Game tutorials]]		[[Category:Code tutorials]][[Category:Tutorials]][[Category:Game tutorials]]

Dragawn: Created page with "'''Game Packs''' are a handy way to add more interesting play to a game. In Whirled, there are two types of game packs: item packs and level packs. Item packs are..."

2018-08-25T18:02:50Z

Created page with "'''Game Packs''' are a handy way to add more interesting play to a game. In Whirled, there are two types of game packs: item packs and level packs. Item packs are..."

New page

'''Game Packs''' are a handy way to add more interesting play to a [[game]]. In Whirled, there are two types of game packs: [[item pack]]s and [[level pack]]s. Item packs are used to grant player items in game, such as a magic hat, and level packs usually provide additional levels for the game.

The game packs are also a great way for game creators to monetize their game. The [[Whirled SDK]] contains methods that a game can use to display its [[shop]] during gameplay and also react to the purchase of game items in game. This way, the purchase event is minimally intrusive to the flow of the play.

This tutorial will cover the creation and integration of the game packs into a game, and how to sell these packs.

Note: Once you add an item or game pack to the Item Packs or Game Packs tabs in the game editor, you cannot delete them.

== Creating Your Game Pack ==
Game packs (level/item packs) can be anything from a text file to an actual SWF file containing all the content for that level. You can use the idea of packs to break your game into smaller, more easily downloadable pieces, or you can just use the packs as markers to check if the player is allowed to access certain content in your game.

=== Scenario 1: Breaking up the game into smaller pieces ===
An example of the game that does is [http://dpw.threerings.net/viewvc/underwhirleddrift/ Underwhirled Drift]. It breaks up the game into multiple level packs and only downloads the necessary content when the user reaches the next level.

=== Scenario 2: Using packs as markers ===
I create a game which contains all the content for the game. I upload a game pack which is simply a text file. When the player reaches a new level in the game, the game checks to see if the player has the text file. If they do, then the game allows them to proceed to the next level.

== Local Testing ==

In order to use gamepacks while testing on your PC do the following:

* In the whirled directory there is a "dist" directory, you must place your packs in there.
* Edit your game's config.xml file (create the file in game's directory if it doesn't already exist) to point to your level packs. It should look something like this:

<game>
<params/>
<packs>

<level ident="mus_night" name="mus_night" mediaURL="http://127.0.0.1:8080/levelpacks/music/popcraft_music_night.mp3"/>
<level ident="mus_day" name="mus_day" mediaURL="http://127.0.0.1:8080/levelpacks/music/popcraft_music_day.mp3"/>
</packs>
</game>

You can have any directory structure you like as long as the file exists somewhere under dist.

''When editing XML files be aware that some editors insert invisible characters at the beginning, which will result in parsing errors.''

== Uploading Your Game Pack ==

#Choose '''Games &rarr; My Games''' to see the Games you own.
#Click the Edit link under the game you want to make a game pack for.
#Select either the "Item Packs" or "Level Packs" tab.
#Click on the "Create" button to get the game pack creation interface. [[Image:Stuff-Create_item_pack.png|none|thumb|400px|Item pack interface. The level pack creation interface looks similar, but says level instead of item and has the premium checkbox optional.]]
##Click on the '''Name''' field and enter a name for your item or level pack. This is the name that is displayed under the item or level pack if it is sold in the shop. It will also be used on the Item or Level Pack tab when you edit your game.
##Click on the '''Identifier''' field and enter an identifier for your item or level pack. This string is used to identify this item or level pack in your game code. For the example code shown above, the level pack source identifiers are mus_night and mus_day.
##If you are creating a level pack, you have the option to make it premium. Premium level packs must be purchased by the player, non-premium packs are available to all players. Item packs are required to be premium (must be purchased).
##Click '''Upload a new file''' in Item or Level Pack Media and find the file for your item or level pack. This can be anything from a text file, graphics, SWFs, MP3s.
##Click Upload a new file in Thumbnail and find the image file to represent your item or level pack (png, jpg or gif; max. 80x60, larger images will be scaled down). This is the image that will be seen in the player's stuff page or in the shop. It will also be used on the Item or Level Pack tab when you edit your game.
##Click on the '''Description''' field and enter a description of your item or level pack. This is only required if you plan to sell it in the shop.
##Confirm that you own the copyrights to the item or have authorization to upload it.
#You can then click on '''Save''' to add your item or level pack to the Item or Level Pack tab.

After the upload, you should have something like this:

[[Image:Games-Edit_Game-Level_Packs-uploaded.png|thumb|500px|Uploaded level pack.|none]]

== Listing Your Game Pack ==
{{main|List}}

Listing the game pack is similar to listing any other item in the shop. However, the main game has to be listed before any game packs can be listed. Go to the Item or Level Packs tab and click on "list" for the pack you wish to list. This will give you a popup with the listing screen to fill out with the desired options that are outlined [[List#Listing_Options|here]].

''NOTE: Even if you are not planning to sell your pack for coins/bars (premium), you still have to list the item in order for other players to have access to it. In that case, you will use the "Hidden" option under Strategy on the listing screen.''

== Coding the Game Pack into a Game ==

To get a list of all the game packs and items packs available to your game, you can call [http://www.whirled.com/code/asdocs/com/whirled/game/GameSubControl.html#getLevelPacks() getLevelPacks()] and [http://www.whirled.com/code/asdocs/com/whirled/game/GameSubControl.html#getItemPacks() getItemPacks()] on the [[GameSubControl]] object.

<actionscript>
gameCtrl.game.getLevelPacks();
or
gameCtrl.game.getItemPacks();

</actionscript>

This call will return an array of objects containing:

<actionscript>
ident - string identifier of item pack (This is the same string that you specified during the pack upload)
name - human readable name of item pack
mediaURL - URL for item pack content
premium - boolean indicating that content is premium or not
</actionscript>

For level packs, there are some convenience code in the contrib section ([http://www.whirled.com/code/contrib/asdocs/com/whirled/contrib/LevelPack.html LevelPacks] & [http://www.whirled.com/code/contrib/asdocs/com/whirled/contrib/LevelPackManager.html LevelPackManager]) that helps you parse and manage the arrays.

<actionscript>
import com.whirled.contrib.LevelPackManager;
....
public static var allLevelPacks :LevelPackManager = new LevelPackManager();
allLevelPacks.init(gameCtrl.game.getLevelPacks());
</actionscript>

There currently is no equivalent convenience code for item packs, but you can easily write something similar and [http://www.whirled.com/#whirleds-d_65 contribute it].

In case you need to load packs directly from your server agent (which cannot use sockets) you can call the
[http://www.whirled.com/code/asdocs/com/whirled/game/GameSubControl.html#loadLevelPackData() loadLevelPackData()] and [http://www.whirled.com/code/asdocs/com/whirled/game/GameSubControl.html#loadItemPackData() loadItemPackData()] functions on the GameSubControl object.

== Showing the Shop during Game Play ==
While a user is playing a game, it is possible to figure out what game packs they have and do not have, and then display an upsell.

[[Image:Game-QBeez_Whirled-level_buy.png|thumb|800px|Level pack upsell and detecting an already purchased level pack in QBeez Whirled.|none]]

When the user clicks to buy an item, you can then open up a shop page to the left of the game screen.

[[Image:Game-QBeez Whirled-pink_level_pack.png|thumb|500px |Level pack shop UI.|none]]

'''To open up the LevelPacks Game Shop with all level packs for sale for your game''':
<actionscript>
var gameCtrl :GameControl = new GameControl(this);
gameCtrl.local.showGameShop(GameControl.LEVEL_PACK_SHOP);
</actionscript>

'''To open up the Item pack Game Shop displaying details for an item pack with catalogID of 555''':
<actionscript>

var catalogID :int = 555;
gameCtrl.local.showGameShop(GameControl.ITEM_PACK_SHOP, catalogID);
</actionscript>

'''You can obtain the catalog ID when you list your item/level pack. For example the catalog ID of the following level pack http://www.whirled.com/#shop-l_11_99 is 99'''.

You can also open up other shop pages other than the ones shown here (such as '''avatars or furniture''') by changing the itemType parameter on [http://www.whirled.com/code/asdocs/com/whirled/game/LocalSubControl.html#showGameShop() showGameShop], valid shop constants are defined on the [http://www.whirled.com/code/asdocs/com/whirled/game/GameControl.html#AVATAR_SHOP GameControl]. Learn how to list [[Adding items to the game shop |other items in your game shop]].

== Checking Player Pack Content ==

To listen for when someone buys an item pack (that they don't already own) for your game while inside your game, you can register to listen for the PLAYER_CONTENT_ADDED event.

<actionscript>
gameCtrl.player.addEventListener(GameContentEvent.PLAYER_CONTENT_ADDED, playerContentAdded);
</actionscript>

<actionscript>
protected function playerContentAdded (event :GameContentEvent) :void
{
// event.contentType will either be ITEM_PACK or LEVEL_PACK
// event.contentIdent will be the "ident" string for the pack they bought
if (event.contentType == GameContentEvent.ITEM_PACK) {
gameCtrl.game.systemMessage("player " + event.playerId + " bought the item pack with id " + event.contentIdent);
}
</actionscript>

You can also get a list of the packs that a player currently owns by calling [http://www.whirled.com/code/asdocs/com/whirled/game/PlayerSubControl.html#getPlayerItemPacks() getPlayerItemPacks(playerId:int)] or [http://www.whirled.com/code/asdocs/com/whirled/game/PlayerSubControl.html#getPlayerLevelPacks() getPlayerLevelPacks(playerId:int)] on the [[PlayerSubControl]].

[[Category:Code tutorials]][[Category:Tutorials]][[Category:Game tutorials]]