SimpleAVRG/Part 1 - Revision history

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

2018-08-31T18:44:07Z

Text replacement - ">" to ">"

← Older revision		Revision as of 18:44, 31 August 2018
Line 15:		Line 15:
	Ant does its thing, resulting in a new directory with a minimal AVRG project:		Ant does its thing, resulting in a new directory with a minimal AVRG project:

	<pre~~>~~		<pre>
	- simpleavrg/		- simpleavrg/
	- Server.as The server side actionscript.		- Server.as The server side actionscript.
Line 21:		Line 21:
	- build.bat A build file for Windows users.		- build.bat A build file for Windows users.
	- build.xml A build file for anyone with Ant.		- build.xml A build file for anyone with Ant.
	</pre~~>~~		</pre>

	The build files are beyond the scope of this introduction to AVRGs, but you can read the Ant manual here if you're curious: http://ant.apache.org/manual/index.html		The build files are beyond the scope of this introduction to AVRGs, but you can read the Ant manual here if you're curious: http://ant.apache.org/manual/index.html
Line 28:		Line 28:
	At this point, your server side code looks like this:		At this point, your server side code looks like this:

	<actionscript~~>~~		<actionscript>
	//		//
	// $Id$		// $Id$
Line 58:		Line 58:

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

	==== SimpleAVRG.as ====		==== SimpleAVRG.as ====
	And here is your client code:		And here is your client code:

	<actionscript~~>~~		<actionscript>
	//		//
	// $Id$		// $Id$
Line 99:		Line 99:
	}		}
	}		}
	</actionscript~~>~~		</actionscript>

	== First Build ==		== First Build ==
Line 127:		Line 127:
	Fill in the tabs with the appropriate values:		Fill in the tabs with the appropriate values:

	<pre~~>~~		<pre>
	Info Tab		Info Tab
	Name: Simple AVRG		Name: Simple AVRG
Line 139:		Line 139:
	Splash Screen: Upload an appropriate image.		Splash Screen: Upload an appropriate image.
	Server Agent Code: Select your "SimpleAVRG.abc" file.		Server Agent Code: Select your "SimpleAVRG.abc" file.
	</pre~~>~~		</pre>

	You will need to create a launcher for your game as well:		You will need to create a launcher for your game as well:

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

2018-08-30T21:09:31Z

Text replacement - "<" to "<"

← Older revision		Revision as of 21:09, 30 August 2018
Line 15:		Line 15:
	Ant does its thing, resulting in a new directory with a minimal AVRG project:		Ant does its thing, resulting in a new directory with a minimal AVRG project:

	~~<~~pre>		<pre>
	- simpleavrg/		- simpleavrg/
	- Server.as The server side actionscript.		- Server.as The server side actionscript.
Line 21:		Line 21:
	- build.bat A build file for Windows users.		- build.bat A build file for Windows users.
	- build.xml A build file for anyone with Ant.		- build.xml A build file for anyone with Ant.
	~~<~~/pre>		</pre>

	The build files are beyond the scope of this introduction to AVRGs, but you can read the Ant manual here if you're curious: http://ant.apache.org/manual/index.html		The build files are beyond the scope of this introduction to AVRGs, but you can read the Ant manual here if you're curious: http://ant.apache.org/manual/index.html
Line 28:		Line 28:
	At this point, your server side code looks like this:		At this point, your server side code looks like this:

	~~<~~actionscript>		<actionscript>
	//		//
	// $Id$		// $Id$
Line 58:		Line 58:

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

	==== SimpleAVRG.as ====		==== SimpleAVRG.as ====
	And here is your client code:		And here is your client code:

	~~<~~actionscript>		<actionscript>
	//		//
	// $Id$		// $Id$
Line 99:		Line 99:
	}		}
	}		}
	~~<~~/actionscript>		</actionscript>

	== First Build ==		== First Build ==
Line 127:		Line 127:
	Fill in the tabs with the appropriate values:		Fill in the tabs with the appropriate values:

	~~<~~pre>		<pre>
	Info Tab		Info Tab
	Name: Simple AVRG		Name: Simple AVRG
Line 139:		Line 139:
	Splash Screen: Upload an appropriate image.		Splash Screen: Upload an appropriate image.
	Server Agent Code: Select your "SimpleAVRG.abc" file.		Server Agent Code: Select your "SimpleAVRG.abc" file.
	~~<~~/pre>		</pre>

	You will need to create a launcher for your game as well:		You will need to create a launcher for your game as well:

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

2018-08-30T21:07:19Z

Text replacement - """ to """

← Older revision		Revision as of 21:07, 30 August 2018
Line 7:		Line 7:
	== New Project ==		== New Project ==

	In your Whirled SDK directory, run ~~"~~ant newproject~~"~~ and select ~~"~~AVRG~~"~~. Name it ~~"~~SimpleAVRG~~"~~.		In your Whirled SDK directory, run "ant newproject" and select "AVRG". Name it "SimpleAVRG".

	(On Windows, you have the option of using newproject.bat instead. In fact, anywhere that I say to run Ant, there is an equivalent .bat file.)		(On Windows, you have the option of using newproject.bat instead. In fact, anywhere that I say to run Ant, there is an equivalent .bat file.)
Line 51:		Line 51:
	{		{
	_control = new AVRServerGameControl(this);		_control = new AVRServerGameControl(this);
	trace(~~"~~SimpleAVRG server agent reporting for duty!~~"~~);		trace("SimpleAVRG server agent reporting for duty!");
	}		}

Line 105:		Line 105:
	So far, your game can set itself up and tear itself down, but not much else.		So far, your game can set itself up and tear itself down, but not much else.

	Go ahead and build it anyway to confirm that your environment is set up correctly. Run ~~"~~ant~~"~~ in the project directory.		Go ahead and build it anyway to confirm that your environment is set up correctly. Run "ant" in the project directory.

	If you don't get ~~"~~BUILD SUCCESSFUL~~"~~, figure out what has gone wrong and fix it.		If you don't get "BUILD SUCCESSFUL", figure out what has gone wrong and fix it.

	Note: For Windows users, using build.bat will show an error about ~~"~~test-avrg~~"~~ but it will still generate the needed .swf and .abc files. If you don't want to see that error, you should install Apache Ant by following the instructions [http://wiki.apache.org/ant/AntOnWindows here] and use ant in the command line prompt in your simpleavrg directory.		Note: For Windows users, using build.bat will show an error about "test-avrg" but it will still generate the needed .swf and .abc files. If you don't want to see that error, you should install Apache Ant by following the instructions [http://wiki.apache.org/ant/AntOnWindows here] and use ant in the command line prompt in your simpleavrg directory.

	[[Image:SimpleAvrgFirstBuild.png\|550px\|thumb\|none\|A screenshot of a successful build.]]		[[Image:SimpleAvrgFirstBuild.png\|550px\|thumb\|none\|A screenshot of a successful build.]]
Line 119:		Line 119:
	#In Whirled, proceed to Games &rarr; My Games. Click the '''Create''' button to get the game uploading interface.[[Image:Games-Create_Game.png\|none\|425px\|thumb\|The game uploading interface.]]		#In Whirled, proceed to Games &rarr; My Games. Click the '''Create''' button to get the game uploading interface.[[Image:Games-Create_Game.png\|none\|425px\|thumb\|The game uploading interface.]]
	##Select In-Whirled Game.		##Select In-Whirled Game.
	##Under Game Name, type ~~"~~Simple AVRG.~~"~~		##Under Game Name, type "Simple AVRG."
	##Under Thumbnail Media, click ''Browse...'', and select your image file. This thumbnail is used to represent the game in My Games.		##Under Thumbnail Media, click ''Browse...'', and select your image file. This thumbnail is used to represent the game in My Games.
	##Under Client Code, click ''Browse...'', and select your '''SimpleAVRG.swf''' file in the file system browser that appears. When the file has finished uploading, you should see a SWF id show up (e.g. 031c99dbf403923daad884fb562bd7f0d83d555x.swf) in the Client Code section.		##Under Client Code, click ''Browse...'', and select your '''SimpleAVRG.swf''' file in the file system browser that appears. When the file has finished uploading, you should see a SWF id show up (e.g. 031c99dbf403923daad884fb562bd7f0d83d555x.swf) in the Client Code section.
Line 138:		Line 138:
	Code Tab		Code Tab
	Splash Screen: Upload an appropriate image.		Splash Screen: Upload an appropriate image.
	Server Agent Code: Select your ~~"~~SimpleAVRG.abc~~"~~ file.		Server Agent Code: Select your "SimpleAVRG.abc" file.
	</pre>		</pre>

	You will need to create a launcher for your game as well:		You will need to create a launcher for your game as well:

	#Select the ~~"~~Launchers~~"~~ tab.		#Select the "Launchers" tab.
	#Click on the ~~"~~Create~~"~~ button to get the launcher creation interface. [[Image:Stuff-Create_launcher.png\|none\|thumb\|400px\|Launcher interface.]]		#Click on the "Create" button to get the launcher creation interface. [[Image:Stuff-Create_launcher.png\|none\|thumb\|400px\|Launcher interface.]]
	##Click on the '''Name''' field and enter a name for your launcher. Something like Simple AVRG will be fine.		##Click on the '''Name''' field and enter a name for your launcher. Something like Simple AVRG will be fine.
	##Click '''Upload a new file''' in Furniture Media and find the image or SWF file for your launcher. This is what will be seen in the room when a player adds it there.		##Click '''Upload a new file''' in Furniture Media and find the image or SWF file for your launcher. This is what will be seen in the room when a player adds it there.
Line 155:		Line 155:
	Add the Simple AVRG launcher to a room and run it.		Add the Simple AVRG launcher to a room and run it.

	[[Image:SimpleAvrgFirstRun.png\|550px\|thumb\|none\|A screenshot of AVRG skeleton in ~~"~~action.~~"~~]]		[[Image:SimpleAvrgFirstRun.png\|550px\|thumb\|none\|A screenshot of AVRG skeleton in "action."]]

	As you can see, not much happens.		As you can see, not much happens.

	While your game is still running, click its icon on the icon bar and choose ~~"~~Instructions~~"~~ from the menu.		While your game is still running, click its icon on the icon bar and choose "Instructions" from the menu.

	[[Image:SimpleAvrgIconBar.png\|550px\|thumb\|none\|A screenshot of the icon bar with the AVRG's icon active.]]		[[Image:SimpleAvrgIconBar.png\|550px\|thumb\|none\|A screenshot of the icon bar with the AVRG's icon active.]]

	In the page this opens, select the ~~"~~Logs~~"~~ tab. This tab gives you access to your game's server side logs. These will contain the output from your server side trace statements, among other things. Refresh until a log link appears, if one is not already present. Sometimes it takes a few minutes for a log to become available.		In the page this opens, select the "Logs" tab. This tab gives you access to your game's server side logs. These will contain the output from your server side trace statements, among other things. Refresh until a log link appears, if one is not already present. Sometimes it takes a few minutes for a log to become available.

	[[Image:SimpleAvrgFirstLogList.png\|550px\|thumb\|none\|A screenshot of the skeleton AVRG's server log list.]]		[[Image:SimpleAvrgFirstLogList.png\|550px\|thumb\|none\|A screenshot of the skeleton AVRG's server log list.]]

Dragawn: Created page with "This is the first part of the Simple AVRG Tutorial. It details the basic AVRG Skeleton This tutorial assumes that you have already set up your Setting_up_yo..."

2018-08-26T15:08:55Z

Created page with "This is the first part of the Simple AVRG Tutorial. It details the basic AVRG Skeleton This tutorial assumes that you have already set up your Setting_up_yo..."

New page

This is the first part of the [[SimpleAVRG|Simple AVRG Tutorial]]. It details the basic AVRG Skeleton

This tutorial assumes that you have already set up your [[Setting_up_your_programming_environment|Whirled development environment]].

See also: [[AVR game]]s

== New Project ==

In your Whirled SDK directory, run "ant newproject" and select "AVRG". Name it "SimpleAVRG".

(On Windows, you have the option of using newproject.bat instead. In fact, anywhere that I say to run Ant, there is an equivalent .bat file.)

[[Image:SimpleAvrgNewProject.png|550px|thumb|none|A new AVRG project]]

Ant does its thing, resulting in a new directory with a minimal AVRG project:

<pre>
- simpleavrg/
- Server.as The server side actionscript.
- SimpleAVRG.as The client side actionscript.
- build.bat A build file for Windows users.
- build.xml A build file for anyone with Ant.
</pre>

The build files are beyond the scope of this introduction to AVRGs, but you can read the Ant manual here if you're curious: http://ant.apache.org/manual/index.html

==== Server.as ====
At this point, your server side code looks like this:

<actionscript>
//
// $Id$
//
// The server agent for SimpleAVRG - an AVR game for Whirled

package {

import com.whirled.ServerObject;
import com.whirled.avrg.AVRServerGameControl;

/**
* The server agent for SimpleAVRG. Automatically created by the
* whirled server whenever a new game is started.
*/
public class Server extends ServerObject
{
/**
* Constructs a new server agent.
*/
public function Server ()
{
_control = new AVRServerGameControl(this);
trace("SimpleAVRG server agent reporting for duty!");
}

protected var _control :AVRServerGameControl;
}

}
</actionscript>

==== SimpleAVRG.as ====
And here is your client code:

<actionscript>
//
// $Id$
//
// SimpleAVRG - an AVR game for Whirled

package {

import flash.display.Sprite;

import flash.events.Event;

import com.whirled.avrg.AVRGameControl;

public class SimpleAVRG extends Sprite
{
public function SimpleAVRG ()
{
_control = new AVRGameControl(this);

// listen for an unload event
_control.addEventListener(Event.UNLOAD, handleUnload);
}

/**
* This is called when your game is unloaded.
*/
protected function handleUnload (event :Event) :void
{
// stop any sounds, clean up any resources that need it. This specifically includes
// unregistering listeners to any events - especially Event.ENTER_FRAME
}

protected var _control :AVRGameControl;
}
}
</actionscript>

== First Build ==

So far, your game can set itself up and tear itself down, but not much else.

Go ahead and build it anyway to confirm that your environment is set up correctly. Run "ant" in the project directory.

If you don't get "BUILD SUCCESSFUL", figure out what has gone wrong and fix it.

Note: For Windows users, using build.bat will show an error about "test-avrg" but it will still generate the needed .swf and .abc files. If you don't want to see that error, you should install Apache Ant by following the instructions [http://wiki.apache.org/ant/AntOnWindows here] and use ant in the command line prompt in your simpleavrg directory.

[[Image:SimpleAvrgFirstBuild.png|550px|thumb|none|A screenshot of a successful build.]]

== Upload: First Build, Part 2 ==

The game doesn't do much, but let's upload it to see the little it does.

#In Whirled, proceed to Games &rarr; My Games. Click the '''Create''' button to get the game uploading interface.[[Image:Games-Create_Game.png|none|425px|thumb|The game uploading interface.]]
##Select In-Whirled Game.
##Under Game Name, type "Simple AVRG."
##Under Thumbnail Media, click ''Browse...'', and select your image file. This thumbnail is used to represent the game in My Games.
##Under Client Code, click ''Browse...'', and select your '''SimpleAVRG.swf''' file in the file system browser that appears. When the file has finished uploading, you should see a SWF id show up (e.g. 031c99dbf403923daad884fb562bd7f0d83d555x.swf) in the Client Code section.
##Confirm that you own the copyrights to the item or have authorization to upload it.
##Click on the ''Save'' button and your browser will switch to the Edit Game interface where you can configure your game.

Fill in the tabs with the appropriate values:

<pre>
Info Tab
Name: Simple AVRG
Genre: MMO / Whirled (why not be ambitious?)
Description: Enter a description of the game you plan to build.
Group: Choose the Group to associate with the game (or none).
Shop Tag: Enter any tags that will apply to your game.
Screenshot: For now, this will have to stay blank.

Code Tab
Splash Screen: Upload an appropriate image.
Server Agent Code: Select your "SimpleAVRG.abc" file.
</pre>

You will need to create a launcher for your game as well:

#Select the "Launchers" tab.
#Click on the "Create" button to get the launcher creation interface. [[Image:Stuff-Create_launcher.png|none|thumb|400px|Launcher interface.]]
##Click on the '''Name''' field and enter a name for your launcher. Something like Simple AVRG will be fine.
##Click '''Upload a new file''' in Furniture Media and find the image or SWF file for your launcher. This is what will be seen in the room when a player adds it there.
##Click '''Upload a new file''' in Thumbnail Media and find the bitmap (png, jpg or gif; max. 80x60) file for your launcher's icon. This will be shown in the shop and in the Stuff tab of players who have the launcher.
##Click on the '''Description''' field and enter a description of your launcher. 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 put your launcher in your inventory for use.

== First Run ==
Add the Simple AVRG launcher to a room and run it.

[[Image:SimpleAvrgFirstRun.png|550px|thumb|none|A screenshot of AVRG skeleton in "action."]]

As you can see, not much happens.

While your game is still running, click its icon on the icon bar and choose "Instructions" from the menu.

[[Image:SimpleAvrgIconBar.png|550px|thumb|none|A screenshot of the icon bar with the AVRG's icon active.]]

In the page this opens, select the "Logs" tab. This tab gives you access to your game's server side logs. These will contain the output from your server side trace statements, among other things. Refresh until a log link appears, if one is not already present. Sometimes it takes a few minutes for a log to become available.

[[Image:SimpleAvrgFirstLogList.png|550px|thumb|none|A screenshot of the skeleton AVRG's server log list.]]

Follow a log link to see that log's contents:

[[Image:SimpleAvrgFirstLog.png|550px|thumb|none|A screenshot of the skeleton AVRG's server log.]]

As you can see, the trace statement from the Server class (as defined in Server.as) has run and the output has made it into the game's server side log.

== What Have You Done? ==

You have built and uploaded a simple AVRG and confirmed that it runs on Whirled. The next step will be making it do a bit more.

* [[SimpleAVRG/Part 2|Proceed to the next step]]
[[Category:Subpages]]