HeartbeatSaver - Revision history

F at 21:39, 15 October 2013

2013-10-15T21:39:24Z

← Older revision		Revision as of 21:39, 15 October 2013
Line 1:		Line 1:
	[[HeartbeatSaver]] is a utility, bundled with fCraft 0.633+, that serves as a standalone heartbeat server. It runs separately from fCraft process and reads information from a file (<code>heartbeatdata.txt</code>). This allows your server to keep its uptime on Minecraft.net even when your fCraft server process needs to be restarted/shutdown.		[[HeartbeatSaver]] is a utility, bundled with fCraft {{Changelog\|0.633}}+, that serves as a standalone heartbeat server. It runs separately from fCraft process and reads information from a file (<code>heartbeatdata.txt</code>). This allows your server to keep its uptime on Minecraft.net even when your fCraft server process needs to be restarted/shutdown.

	When you disable fCraft's built-in heartbeat (from the Advanced tab of ConfigGUI, or by setting [[List of config keys#Advanced\|HeartbeatEnabled config key]] to "false"), fCraft will start writing <code>heartbeatdata.txt</code> to disk, in fCraft's working directory.		When you disable fCraft's built-in heartbeat (from the Advanced tab of ConfigGUI, or by setting [[List of config keys#Advanced\|HeartbeatEnabled config key]] to "false"), fCraft will start writing <code>heartbeatdata.txt</code> to disk, in fCraft's working directory.

F at 21:00, 26 August 2013

2013-08-26T21:00:16Z

← Older revision		Revision as of 21:00, 26 August 2013
Line 1:		Line 1:
	[[HeartbeatSaver]] is a utility, bundled with fCraft 0.633+, that serves as a standalone heartbeat server. It runs separately from fCraft process and reads information from a file (~~HeartbeatData~~.txt). This allows your server to keep its uptime on Minecraft.net even when your fCraft server process needs to be restarted/shutdown.		[[HeartbeatSaver]] is a utility, bundled with fCraft 0.633+, that serves as a standalone heartbeat server. It runs separately from fCraft process and reads information from a file (<code>heartbeatdata.txt</code>). This allows your server to keep its uptime on Minecraft.net even when your fCraft server process needs to be restarted/shutdown.

	When you disable fCraft's built-in heartbeat (from the Advanced tab of ConfigGUI, or by setting [[List of config keys#Advanced\|HeartbeatEnabled config key]] to "false"), fCraft will start writing <code>heartbeatdata.txt</code> to disk, in fCraft's working directory.		When you disable fCraft's built-in heartbeat (from the Advanced tab of ConfigGUI, or by setting [[List of config keys#Advanced\|HeartbeatEnabled config key]] to "false"), fCraft will start writing <code>heartbeatdata.txt</code> to disk, in fCraft's working directory.

F at 19:26, 25 August 2013

2013-08-25T19:26:18Z

← Older revision		Revision as of 19:26, 25 August 2013
Line 9:		Line 9:
	==Usage==		==Usage==
	:'''<code>HeartbeatSaver</code>'''		:'''<code>HeartbeatSaver</code>'''
	::Assumes that heartbeatdata.txt is in the working directory		::Assumes that <code>heartbeatdata.txt</code> is in the working directory

	:'''<code>HeartbeatSaver "Path/To/heartbeatdata.txt"</code>'''		:'''<code>HeartbeatSaver "Path/To/heartbeatdata.txt"</code>'''
Line 15:		Line 15:

	==heartbeatdata.txt format==		==heartbeatdata.txt format==
	Usually you don't need to mess with heartbeatdata.txt yourself. fCraft server will generate this for you every minute or so.		Usually you don't need to mess with <code>heartbeatdata.txt</code> yourself. fCraft server will generate this for you every minute or so.
	Line 01: Salt		Line 01: Salt
	Line 02: InternalIP		Line 02: InternalIP

F: /* heartbeatdata.txt format */

2013-08-25T19:25:47Z

heartbeatdata.txt format

← Older revision		Revision as of 19:25, 25 August 2013
Line 23:		Line 23:
	Line 06: Server name		Line 06: Server name
	Line 07: IsPublic flag ("true" or "false")		Line 07: IsPublic flag ("true" or "false")
	Line 08: ~~WoMDirectDescription~~		Line 08: HeartbeatUrl
	~~Line 09: WoMDirectFlags~~
	~~Line 10: HeartbeatToWoMDirect~~
	For example:		For example:
	MuXCwxhDCNz9BIz6aBDlNYXWWhypWwvA		MuXCwxhDCNz9BIz6aBDlNYXWWhypWwvA
Line 34:		Line 33:
	Custom Minecraft Server (fCraft)		Custom Minecraft Server (fCraft)
	False		False
			https://minecraft.net/heartbeat.jsp
	~~[fCraft]~~
	~~True~~

	==HeartbeatSaver.exe exit codes==		==HeartbeatSaver.exe exit codes==

F at 21:03, 26 September 2012

2012-09-26T21:03:02Z

← Older revision		Revision as of 21:03, 26 September 2012
Line 8:		Line 8:

	==Usage==		==Usage==
			:'''<code>HeartbeatSaver</code>'''
			::Assumes that heartbeatdata.txt is in the working directory

	:'''<code>HeartbeatSaver "Path/To/heartbeatdata.txt"</code>'''		:'''<code>HeartbeatSaver "Path/To/heartbeatdata.txt"</code>'''
			::Specifies path to the text file with heartbeat data (including the filename) explicitly.

	==heartbeatdata.txt format==		==heartbeatdata.txt format==

F at 20:41, 23 September 2012

2012-09-23T20:41:35Z

← Older revision		Revision as of 20:41, 23 September 2012
Line 50:		Line 50:
	\|2		\|2
	\|HeartbeatDataReadingError		\|HeartbeatDataReadingError
	\|Could not read heartbeat data at startup. Make sure that a valid path is given, and that the file is in correct format. If reading fails at any point AFTER the initial data is loaded, an error is printed in stderr, but HeartbeatSaver ~~does not exit~~.		\|Could not read heartbeat data at startup. Make sure that a valid path is given, and that the file is in correct format. If reading fails at any point AFTER the initial data is loaded, an error is printed in stderr, but HeartbeatSaver keeps running and trying.
	\|}		\|}

	[[Category:Tools]]		[[Category:Tools]]

F at 20:41, 23 September 2012

2012-09-23T20:41:20Z

← Older revision		Revision as of 20:41, 23 September 2012
Line 35:		Line 35:

	==HeartbeatSaver.exe exit codes==		==HeartbeatSaver.exe exit codes==
	:0 - Success (HeartbeatSaver never exits, so you should never normally encounter this code).		{\|class="wikitable"
	:1 - ~~Usage~~ error. ~~Make sure that a valid file is given.~~		!Code
	:2 - Could not read heartbeat data at startup. Make sure that a valid path is given, and that the file is in correct format.		!Meaning
			!Notes
			\|-
			\|0
			\|Success
			\|HeartbeatSaver never exits, so you should never normally encounter this code
			\|-
			\|1
			\|UsageError
			\|Required command-line arguments were missing, or an error occurred while trying to parse options.
			\|-
			\|2
			\|HeartbeatDataReadingError
			\|Could not read heartbeat data at startup. Make sure that a valid path is given, and that the file is in correct format. If reading fails at any point AFTER the initial data is loaded, an error is printed in stderr, but HeartbeatSaver does not exit.
			\|}

	[[Category:Tools]]		[[Category:Tools]]

F at 20:23, 23 September 2012

2012-09-23T20:23:51Z

← Older revision		Revision as of 20:23, 23 September 2012
Line 4:		Line 4:

	'''HeartbeatSaver only works as long as its external IP address is exactly same as your server's.''' That means it'll always work when ran from the same machine that fCraft is on, and it will ''usually'' work from another machine on the same LAN. Heartbeat saver does not depend on any other fCraft files/libraries, and does not need to be in the same directory as the rest of your fCraft installation.		'''HeartbeatSaver only works as long as its external IP address is exactly same as your server's.''' That means it'll always work when ran from the same machine that fCraft is on, and it will ''usually'' work from another machine on the same LAN. Heartbeat saver does not depend on any other fCraft files/libraries, and does not need to be in the same directory as the rest of your fCraft installation.

			fCraft's automatic updater (UpdateInstaller) does not include HeartbeatSaver. If an update to HeartbeatSaver is ever released, it will need to be installed manually.

	==Usage==		==Usage==

F at 20:20, 23 September 2012

2012-09-23T20:20:57Z

← Older revision		Revision as of 20:20, 23 September 2012
Line 3:		Line 3:
	When you disable fCraft's built-in heartbeat (from the Advanced tab of ConfigGUI, or by setting [[List of config keys#Advanced\|HeartbeatEnabled config key]] to "false"), fCraft will start writing <code>heartbeatdata.txt</code> to disk, in fCraft's working directory.		When you disable fCraft's built-in heartbeat (from the Advanced tab of ConfigGUI, or by setting [[List of config keys#Advanced\|HeartbeatEnabled config key]] to "false"), fCraft will start writing <code>heartbeatdata.txt</code> to disk, in fCraft's working directory.

	'''HeartbeatSaver only works as long as its external IP address is exactly same as your server's.''' That means it'll always work when ran from the same machine that fCraft is on, and it will ''usually'' work from another machine on the same LAN.		'''HeartbeatSaver only works as long as its external IP address is exactly same as your server's.''' That means it'll always work when ran from the same machine that fCraft is on, and it will ''usually'' work from another machine on the same LAN. Heartbeat saver does not depend on any other fCraft files/libraries, and does not need to be in the same directory as the rest of your fCraft installation.

	==Usage==		==Usage==

F at 20:19, 23 September 2012

2012-09-23T20:19:42Z

← Older revision		Revision as of 20:19, 23 September 2012
Line 9:		Line 9:

	==heartbeatdata.txt format==		==heartbeatdata.txt format==
	Usually you don't need to mess with heartbeatdata.txt yourself. fCraft will generate this for you.		Usually you don't need to mess with heartbeatdata.txt yourself. fCraft server will generate this for you every minute or so.
	Line 01: Salt		Line 01: Salt
	Line 02: InternalIP		Line 02: InternalIP