Architecture - Revision history

F at 19:28, 18 July 2013

2013-07-18T19:28:09Z

← Older revision		Revision as of 19:28, 18 July 2013
Line 1:		Line 1:
	fCraft setup consists of two shared modules (fCraft.dll and fCraftGUI.dll), a visual configuration tool (ConfigGUI.exe), and a choice of front-ends (ServerGUI.exe and ServerCLI.exe).		fCraft setup consists of two shared modules (fCraft.dll and fCraftGUI.dll), a visual configuration tool (ConfigGUI.exe), and a choice of front-ends (ServerGUI.exe and ServerCLI.exe).
	=~~Overview~~=		=Assembly Dependencies=
	[[File:FCraft_Dependency_Graph.png\|frameless\|800px]]		[[File:FCraft_Dependency_Graph.png\|frameless\|800px]]

F at 19:27, 18 July 2013

2013-07-18T19:27:35Z

← Older revision		Revision as of 19:27, 18 July 2013
Line 1:		Line 1:
	fCraft setup consists of two shared modules (fCraft.dll and fCraftGUI.dll), a visual configuration tool (ConfigGUI.exe), and a choice of front-ends (ServerGUI.exe and ServerCLI.exe).		fCraft setup consists of two shared modules (fCraft.dll and fCraftGUI.dll), a visual configuration tool (ConfigGUI.exe), and a choice of front-ends (ServerGUI.exe and ServerCLI.exe).
			=Overview=
			[[File:FCraft_Dependency_Graph.png\|frameless\|800px]]

	=Project Directory Structure=		=Project Directory Structure=
	*'''AutoRankEditor''' - experimental
	*'''bin'''		*'''bin'''
	**'''Debug''' - binaries built in Debug, Debug_Events, Debug_IRC, and Debug_Scheduler configurations.		**'''Debug''' - binaries built in Debug, Debug_Events, Debug_IRC, and Debug_Scheduler configurations.

F: /* Headless operation */

2013-05-31T03:17:09Z

Headless operation

← Older revision		Revision as of 03:17, 31 May 2013
Line 27:		Line 27:

	==Headless operation==		==Headless operation==
	:Headless servers needn't keep ServerGUI, ConfigGUI nor fCraftGUI, they cannot be ran and are not required by the CLI variants. The [[MapRenderer]] <i>does</i> need fCraftGUI, even though it doesn't create such an interface.		:Headless servers needn't keep ServerGUI, ConfigGUI nor fCraftGUI, they cannot be ran and are not required by the CLI variants. The [[MapRenderer]] <i>does</i> need fCraftGUI.dll, even though it doesn't create such an interface.
	:A server update does re-install the deleted binaries, but those can be removed though a command in the post-update script.		:A server update does re-install the deleted binaries, but those can be removed though a command in the post-update script.

Hellenion: /* Headless operation */ Maprenderer is no longer upcoming

2012-11-13T17:01:04Z

Headless operation: Maprenderer is no longer upcoming

← Older revision		Revision as of 17:01, 13 November 2012
Line 27:		Line 27:

	==Headless operation==		==Headless operation==
	:Headless servers needn't keep ServerGUI, ConfigGUI nor fCraftGUI, they cannot be ran and are not required by the CLI variants. The ~~upcoming~~ [[MapRenderer]] <i>does</i> need fCraftGUI, even though it doesn't create such an interface.		:Headless servers needn't keep ServerGUI, ConfigGUI nor fCraftGUI, they cannot be ran and are not required by the CLI variants. The [[MapRenderer]] <i>does</i> need fCraftGUI, even though it doesn't create such an interface.
	:A server update does re-install the deleted binaries, but those can be removed though a command in the post-update script.		:A server update does re-install the deleted binaries, but those can be removed though a command in the post-update script.

Hellenion: /* Project Directory Structure */ Added a section about removal of the GUI modules.

2012-08-26T09:42:11Z

Project Directory Structure: Added a section about removal of the GUI modules.

← Older revision		Revision as of 09:42, 26 August 2012
Line 25:		Line 25:
	*'''UpdateInstaller''' - fCraft.UpdateInstaller namespace; Self-extracting updater.		*'''UpdateInstaller''' - fCraft.UpdateInstaller namespace; Self-extracting updater.
	*'''UpdateBuilder''' - fCraft.UpdateBuilder namespace; Zips files to include in the UpdateInstaller. Used only during the build process.		*'''UpdateBuilder''' - fCraft.UpdateBuilder namespace; Zips files to include in the UpdateInstaller. Used only during the build process.

			==Headless operation==
			:Headless servers needn't keep ServerGUI, ConfigGUI nor fCraftGUI, they cannot be ran and are not required by the CLI variants. The upcoming [[MapRenderer]] <i>does</i> need fCraftGUI, even though it doesn't create such an interface.
			:A server update does re-install the deleted binaries, but those can be removed though a command in the post-update script.

	=Key Classes=		=Key Classes=

F at 02:04, 12 January 2012

2012-01-12T02:04:14Z

← Older revision		Revision as of 02:04, 12 January 2012
Line 96:		Line 96:
	*[[API: Login]]		*[[API: Login]]
	*[[API: Shutdown]]		*[[API: Shutdown]]
			[[Category:Dev]]

F at 02:03, 12 January 2012

2012-01-12T02:03:20Z

← Older revision		Revision as of 02:03, 12 January 2012
Line 90:		Line 90:
	:''fCraft/World/World.cs'', 'fCraft/World/World.Events.cs''		:''fCraft/World/World.cs'', 'fCraft/World/World.Events.cs''
	:Represents an entry on the world list. May or may not have a map file loaded. Manages players, access/build security, various metadata, flushing, locking, saving and backups.		:Represents an entry on the world list. May or may not have a map file loaded. Manages players, access/build security, various metadata, flushing, locking, saving and backups.


			=Event Sequences=
			*[[API: Startup]]
			*[[API: Login]]
			*[[API: Shutdown]]

F at 02:49, 11 November 2011

2011-11-11T02:49:02Z

← Older revision		Revision as of 02:49, 11 November 2011
Line 25:		Line 25:
	*'''UpdateInstaller''' - fCraft.UpdateInstaller namespace; Self-extracting updater.		*'''UpdateInstaller''' - fCraft.UpdateInstaller namespace; Self-extracting updater.
	*'''UpdateBuilder''' - fCraft.UpdateBuilder namespace; Zips files to include in the UpdateInstaller. Used only during the build process.		*'''UpdateBuilder''' - fCraft.UpdateBuilder namespace; Zips files to include in the UpdateInstaller. Used only during the build process.

			=Key Classes=
			*'''fCraft.Command'''
			:''fCraft/Commands/Command.cs''
			:A text scanner that aids parsing chat commands and their arguments.

			*'''fCraft.CommandDescriptor'''
			:''fCraft/Commands/CommandDescriptor.cs'''
			:Describes a chat command. Defines properties, permission requirements, and usage information. Specifies a handler method. Used to add regular commands.

			*'''fCraft.Drawing.DrawOperation'''
			:''fCraft/Drawing/DrawOperation.cs''
			:Abstract class representing a drawing operation. Used to add draw commands.

			*'''fCraft.Chat'''
			:''fCraft/Player/Chat.cs''
			: Helper class for handling and broadcasting player-generated chat.

			*'''fCraft.Permission'''
			:''fCraft/Player/Permission.cs''
			:Enumeration of all permission types/categories. Every rank definition contains a combination of these.

			*'''fCraft.Player'''
			:''fCraft/Network/Player.Networking.cs'', ''fCraft/Player/Player.cs'', ''fCraft/Player/Player.Events.cs''
			:Object representing volatile state ("session") of a connected player. For persistent state of a known player account, see PlayerInfo. Use "Info" property of the Player class to access the associated PlayerInfo record.

			*'''fCraft.PlayerDB'''
			:''fCraft/Player/PlayerDB.cs''
			:Persistent database of player information. Can be used to look up online or offline players and to gather statistics.

			*'''fCraft.PlayerInfo'''
			:''fCraft/Player/PlayerInfo.Actions.cs'', ''fCraft/Player/PlayerInfo.cs'', ''fCraft/Player/PlayerInfo.Events.cs''
			:Object representing persistent state ("record") of a player, online or offline. There is exactly one PlayerInfo object for each known Minecraft account. All data is stored in the PlayerDB.

			*'''fCraft.Rank'''
			:''fCraft/Player/Rank.cs''
			:A rank that can be assigned to a player. Each player can only hold one rank at a time. Each rank has a name, a set of permissions, and a set of restrictions on those permissions.

			*'''fCraft.ConfigKey'''
			:''fCraft/System/ConfigKey.cs''
			:Enumeration of available configuration keys. ''Config.cs'' contains extension methods for getting/setting keys, resetting key values, and getting key metadata.

			*'''fCraft.Logger'''
			:''fCraft/System/Logger.cs''
			:Central logging class. Logs to file, relays messages to the frontend, submits crash reports.

			*'''fCraft.Scheduler'''
			:''fCraft/System/Scheduler.cs''
			:A general-purpose task scheduler. Can be used to run tasks at certain times, once or periodically. Usable to offloading intensive tasks to the background.

			*'''fCraft.Server'''
			:''fCraft/System/Server.cs''
			:Core of an fCraft server. Manages startup/shutdown, online player sessions, and global events and scheduled tasks.

			*'''fCraft.Block'''
			:''fCraft/World/Block.cs''
			:Enumeration of all standard Minecraft Classic block types.

			*'''fCraft.Map'''
			:''fCraft/World/Map.cs''
			:Represents a loaded map file. Provides methods to get/set blocks, metadata, and zones.

			*'''fCraft.World'''
			:''fCraft/World/World.cs'', 'fCraft/World/World.Events.cs''
			:Represents an entry on the world list. May or may not have a map file loaded. Manages players, access/build security, various metadata, flushing, locking, saving and backups.

F at 02:27, 11 November 2011

2011-11-11T02:27:32Z

F: Created page with "fCraft setup consists of two shared modules (fCraft.dll and fCraftGUI.dll), a visual configuration tool (ConfigGUI.exe), and a choice of front-ends (ServerGUI.exe and ServerCLI.e..."

2011-11-11T02:26:11Z

Created page with "fCraft setup consists of two shared modules (fCraft.dll and fCraftGUI.dll), a visual configuration tool (ConfigGUI.exe), and a choice of front-ends (ServerGUI.exe and ServerCLI.e..."

New page

fCraft setup consists of two shared modules (fCraft.dll and fCraftGUI.dll), a visual configuration tool (ConfigGUI.exe), and a choice of front-ends (ServerGUI.exe and ServerCLI.exe).

=Project Directory Structure=
*'''AutoRankEditor''' - experimental
*'''bin'''
**'''Debug''' - binaries built in Debug, Debug_Events, Debug_IRC, and Debug_Scheduler configurations.
**'''Release''' - binaries built in Release configuration.
*'''ConfigCLI''' - experimental command-line config editor
*'''ConfigGUI''' - graphical config editor
*'''fCraft''' - shared components
**'''AutoRank''' - fCraft.AutoRank namespace; AutoRankManager, conditions, and criteria.
**'''Commands''' - fCraft namespace; Command descriptors and handlers, Command/CommandDescriptor/CommandManager classes, CommandCategory enum.
**'''Drawing''' - fCraft.Drawing namespace; DrawOperation base class and Brush-related interfaces; BrushManager; copy/paste- and undo-related classes; Axis enum.
***'''Brushes''' - fCraft.Drawing namespace; All brush implementations.
***'''DrawOps''' - fCraft.Drawing namespace; All DrawOperation implementations.
**'''MapConversion''' - fCraft.MapConversion namespace; MapUtility, class, MapFormat enum, IMapConverter implementations (importers and exporters), NBT and .INI utilities.
**'''Network''' - fCraft namespace; Heartbeat, IP bans, IRC, low-level network utilities, networking component of the Player class.
**'''Player''' - fCraft namespace; permissions and ranks, player constants, PlayerDB and PlayerInfo, Player class, Chat.
**'''System''' - fCraft namespace; Config, Server central class, Logger, Scheduler.
**'''Utils''' - fCraft, JetBrains.Annotations, System.IO.Compression namespaces; various utility classes, extension methods, Vector classes, code annotations.
**'''World''' - fCraft namespace; Block enum, BlockDB classes, map generation, World and WorldManager classes, Zones.
*'''fCraftGUI''' - fCraft.GUI namespace; graphical components shared by ServerGUI and ConfigGUI.
*'''ServerCLI''' - fCraft.ServerCLI namespace; Command-line server front end.
*'''ServerGUI''' - fCraft.ServerGUI namespace; Graphical server front end.
*'''UpdateInstaller''' - fCraft.UpdateInstaller namespace; Self-extracting updater.
*'''UpdateBuilder''' - fCraft.UpdateBuilder namespace; Zips files to include in the UpdateInstaller. Used only during the build process.

← Older revision		Revision as of 02:27, 11 November 2011
Line 10:		Line 10:
	*'''fCraft''' - shared components		*'''fCraft''' - shared components
	**'''AutoRank''' - fCraft.AutoRank namespace; AutoRankManager, conditions, and criteria.		**'''AutoRank''' - fCraft.AutoRank namespace; AutoRankManager, conditions, and criteria.
	**'''Commands''' - fCraft ~~namespace~~; Command descriptors and handlers, Command/CommandDescriptor/CommandManager classes, CommandCategory enum.		**'''Commands''' - fCraft, fCraft.Events namespaces; Command descriptors and handlers, Command/CommandDescriptor/CommandManager classes, CommandCategory enum.
	**'''Drawing''' - fCraft.Drawing ~~namespace~~; DrawOperation base class and Brush-related interfaces; BrushManager; copy/paste- and undo-related classes; Axis enum.		**'''Drawing''' - fCraft.Drawing, fCraft.Events namespaces; DrawOperation base class and Brush-related interfaces; BrushManager; copy/paste- and undo-related classes; Axis enum.
	***'''Brushes''' - fCraft.Drawing namespace; All brush implementations.		***'''Brushes''' - fCraft.Drawing namespace; All brush implementations.
	***'''DrawOps''' - fCraft.Drawing namespace; All DrawOperation implementations.		***'''DrawOps''' - fCraft.Drawing namespace; All DrawOperation implementations.
	**'''MapConversion''' - fCraft.MapConversion namespace; MapUtility, class, MapFormat enum, IMapConverter implementations (importers and exporters), NBT and .INI utilities.		**'''MapConversion''' - fCraft.MapConversion namespace; MapUtility, class, MapFormat enum, IMapConverter implementations (importers and exporters), NBT and .INI utilities.
	**'''Network''' - fCraft ~~namespace~~; Heartbeat, IP bans, IRC, low-level network utilities, networking component of the Player class.		**'''Network''' - fCraft, fCraft.Events namespaces; Heartbeat, IP bans, IRC, low-level network utilities, networking component of the Player class.
	**'''Player''' - fCraft ~~namespace~~; ~~permissions~~ and ranks, player constants, PlayerDB and PlayerInfo, Player class, Chat.		**'''Player''' - fCraft, fCraft.Events namespaces; Permissions and ranks, player-related constants, PlayerDB and PlayerInfo, Player class, Chat.
	**'''System''' - fCraft ~~namespace~~; Config, Server central class, Logger, Scheduler.		**'''System''' - fCraft, fCraft.Events namespaces; Config, Server central class, Logger, Scheduler.
	**'''Utils''' - fCraft, JetBrains.Annotations, System.IO.Compression namespaces; various utility classes, extension methods, Vector classes, code annotations.		**'''Utils''' - fCraft, JetBrains.Annotations, System.IO.Compression namespaces; various utility classes, extension methods, Vector classes, code annotations.
	**'''World''' - fCraft namespace; Block enum, BlockDB classes, map generation~~, World and WorldManager classes~~, Zones.		**'''World''' - fCraft namespace; World and WorldManager classes, Block enum, BlockDB classes, map generation, Zones.
	*'''fCraftGUI''' - fCraft.GUI namespace; graphical components shared by ServerGUI and ConfigGUI.		*'''fCraftGUI''' - fCraft.GUI namespace; graphical components shared by ServerGUI and ConfigGUI.
	*'''ServerCLI''' - fCraft.ServerCLI namespace; Command-line server front end.		*'''ServerCLI''' - fCraft.ServerCLI namespace; Command-line server front end.