Unity plugin documentation - Revision history

Admin: Updated the links

2020-04-21T14:55:21Z

Updated the links

← Older revision		Revision as of 14:55, 21 April 2020
Line 3:		Line 3:
	<br />		<br />

	==installing the plugin ==		==installing the plugin==

	#Download the plugin unity asset '''~~TODO: download link~~.'''		#Download the [http://guraas.com/builds/GLogUnity.unitypackage plugin unity asset]: '''.'''
	#Import the plugin into unity (Assets -> Import Package -> Custom Package...).		#Import the plugin into unity (Assets -> Import Package -> Custom Package...).
	#Your project should now have the following additional assets: <br />[[File:Imported_plugin.png\|alt=\|border]]		#Your project should now have the following additional assets: <br />[[File:Imported_plugin.png\|alt=\|border]]
	#Select the GLogConfig asset and set the Game Unique Id to the Id assigned to the game on the GURaaS portal. <br />[[File:GLogConfig.png\|alt=\|frameless]] [[File:Game_Id_on_the_portal.png\|alt=\|border\|frameless\|810x810px]]		#Select the GLogConfig asset and set the Game Unique Id to the Id assigned to the game on the [https://portal.guraas.com GURaaS portal]. <br />[[File:GLogConfig.png\|alt=\|frameless]] [[File:Game_Id_on_the_portal.png\|alt=\|border\|frameless\|810x810px]]
	#The plugin is now set up and ready to use!		#The plugin is now set up and ready to use!

Admin at 13:04, 17 April 2020

2020-04-17T13:04:38Z

← Older revision		Revision as of 13:04, 17 April 2020
Line 3:		Line 3:
	<br />		<br />

	==installing the plugin==		==installing the plugin ==
	~~<br />~~

	#Download the plugin unity asset '''TODO: download link.'''		#Download the plugin unity asset '''TODO: download link.'''

Admin at 13:03, 17 April 2020

2020-04-17T13:03:01Z

← Older revision		Revision as of 13:03, 17 April 2020
Line 6:		Line 6:
	<br />		<br />

	#Download the plugin unity asset TODO: download link.		#Download the plugin unity asset '''TODO: download link.'''
	#Import the plugin into unity (Assets -> Import Package -> Custom Package...).		#Import the plugin into unity (Assets -> Import Package -> Custom Package...).
	#Your project should now have the following additional assets: <br />[[File:Imported_plugin.png\|alt=\|border]]		#Your project should now have the following additional assets: <br />[[File:Imported_plugin.png\|alt=\|border]]

Admin at 13:02, 17 April 2020

2020-04-17T13:02:42Z

← Older revision		Revision as of 13:02, 17 April 2020
Line 40:		Line 40:
	*A verbose level that indicates the log's type and determines what channels will handle it.		*A verbose level that indicates the log's type and determines what channels will handle it.
	*Up to 3 string tags that can be used to identify or filter the log.		*Up to 3 string tags that can be used to identify or filter the log.
	*1 string of data (which can ~~ofcourse~~ be a representation of multiple objects)		*1 string of data (which can of course be a representation of multiple objects)

	Below are a number of different ways to log data:		Below are a number of different ways to log data:

Admin at 13:00, 17 April 2020

2020-04-17T13:00:25Z

← Older revision		Revision as of 13:00, 17 April 2020
Line 71:		Line 71:
	*File channel: outputs received logs to the file location specified.		*File channel: outputs received logs to the file location specified.
	*Console channel: outputs received logs to the Unity console.		*Console channel: outputs received logs to the Unity console.
	*GURaaS channel (or remote channel): sends received logs to the GURaaS server. [[File:GURaaS channel.png\|border\|frameless]]		*GURaaS channel (or remote channel): sends received logs to the GURaaS server. <br />[[File:GURaaS channel.png\|border\|frameless]]

	A game can have multiple channels, but only channels that are referenced in the GLogConfig will be used.		A game can have multiple channels, but only channels that are referenced in the GLogConfig will be used.

Admin at 12:59, 17 April 2020

2020-04-17T12:59:58Z

← Older revision		Revision as of 12:59, 17 April 2020
Line 38:		Line 38:
	A log has the following properties:		A log has the following properties:

	* A verbose level that indicates the log's type and determines what channels will handle it.		*A verbose level that indicates the log's type and determines what channels will handle it.
	* Up to 3 string tags that can be used to identify or filter the log.		*Up to 3 string tags that can be used to identify or filter the log.
	* 1 string of data (which can ofcourse be a representation of multiple objects)		*1 string of data (which can ofcourse be a representation of multiple objects)

	Below are a number of different ways to log data:		Below are a number of different ways to log data:
Line 70:		Line 70:

	*File channel: outputs received logs to the file location specified.		*File channel: outputs received logs to the file location specified.
	*Console channel: outputs received ~~logsto~~ the Unity console.		*Console channel: outputs received logs to the Unity console.
	*GURaaS channel (or remote channel): sends received logs to the GURaaS server.		*GURaaS channel (or remote channel): sends received logs to the GURaaS server. [[File:GURaaS channel.png\|border\|frameless]]

	A game can have multiple channels, but only channels that are referenced in the GLogConfig will be used.		A game can have multiple channels, but only channels that are referenced in the GLogConfig will be used.

Admin at 12:56, 17 April 2020

2020-04-17T12:56:12Z

← Older revision		Revision as of 12:56, 17 April 2020
Line 43:		Line 43:

	Below are a number of different ways to log data:		Below are a number of different ways to log data:
			<syntaxhighlight lang="c#" line="1" start="1">
			GLog.Log(VerboseLevel.DEBUG, "tag1", "tag2", "data");
			GLog.Log(VerboseLevel.INFO, "data");
			GLog.Debug("tag1", "tag2", "tag3", "data");
			GLog.Info("data");
			GLog.Performance("data");
			GLog.Subsystem("data");
			GLog.Warning("data");
			GLog.Info("data");
			GLog.Error("data");
			GLog.Player("data");
			GLog.Event("data");
			</syntaxhighlight>

	<br />		<br />

Admin at 12:55, 17 April 2020

2020-04-17T12:55:22Z

← Older revision		Revision as of 12:55, 17 April 2020
Line 23:		Line 23:
	</syntaxhighlight>		</syntaxhighlight>

	=== Sessions ===		===Sessions===
	The first thing we are doing here is starting a new session. A session is a group of logs that belong together. Determining what defines a session is left up to the developer but the general guideline is to have a session be a single level.		The first thing we are doing here is starting a new session. A session is a group of logs that belong together. Determining what defines a session is left up to the developer but the general guideline is to have a session be a single level.
	Sessions can be manually closed by calling:		Sessions can be manually closed by calling:
Line 35:		Line 35:
	</syntaxhighlight>		</syntaxhighlight>

	=== Logs ===		===Logs===
			A log has the following properties:

			* A verbose level that indicates the log's type and determines what channels will handle it.
			* Up to 3 string tags that can be used to identify or filter the log.
			* 1 string of data (which can ofcourse be a representation of multiple objects)

			Below are a number of different ways to log data:

	<br />		<br />
	==Plugin structure==		==Plugin structure==

Admin at 12:40, 17 April 2020

2020-04-17T12:40:08Z

← Older revision		Revision as of 12:40, 17 April 2020
Line 15:		Line 15:

	==Your first log==		==Your first log==
	Logging ~~somthing~~ in GLog is as easy as this:		Logging something in GLog is as easy as this:
	<syntaxhighlight lang="c#" line="1" start="1">		<syntaxhighlight lang="c#" line="1" start="1">
	using GLogUnity;		using GLogUnity;
Line 22:		Line 22:
	GLog.Log(VerboseLevel.DEBUG, "tag1", "tag2", "data");		GLog.Log(VerboseLevel.DEBUG, "tag1", "tag2", "data");
	</syntaxhighlight>		</syntaxhighlight>

			=== Sessions ===
	The first thing we are doing here is starting a new session. A session is a group of logs that belong together. Determining what defines a session is left up to the developer but the general guideline is to have a session be a single level.		The first thing we are doing here is starting a new session. A session is a group of logs that belong together. Determining what defines a session is left up to the developer but the general guideline is to have a session be a single level.
	Sessions can be manually closed by calling:		Sessions can be manually closed by calling:
Line 33:		Line 35:
	</syntaxhighlight>		</syntaxhighlight>

			=== Logs ===
			<br />
	==Plugin structure==		==Plugin structure==
	The plugin consists of three important components:		The plugin consists of three important components:

Admin at 12:38, 17 April 2020

2020-04-17T12:38:06Z

← Older revision		Revision as of 12:38, 17 April 2020
Line 27:		Line 27:
	GLog.CloseSession();		GLog.CloseSession();
	</syntaxhighlight>		</syntaxhighlight>
	It is important to note that no logging can be done when there is no session active. ~~Sessions will~~ also ~~automatically~~ be ~~closed if the game is closed.~~		Sessions will also automatically be closed if the game is closed, but it is important to note that no logging can be done when there is no session active.
			While a session can be opened without parameters, a player Id or context string can also be passed to make grouping results easier:
			<syntaxhighlight lang="c#" line="1" start="1">
			public static void StartSession(string playerId = null, string context = null)
			</syntaxhighlight>

	==Plugin structure==		==Plugin structure==