Jump to content

HeartbeatSaver: Difference between revisions

From fCraft Wiki
No edit summary
No edit summary
Line 1: Line 1:
[[HeartbeatSaver]] is a utility, bundled with fCraft 0.632+, 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.632+, 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.


When you disable fCraft's built-in heartbeat (set [[List of config keys#Advanced|HeartbeatEnabled config key]] to "false"), fCraft will start writing HeartbeatData.txt to disk.
When you disable fCraft's built-in heartbeat (set [[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.


==Usage==
==Usage==
:'''<code>HeartbeatSaver "Path/To/HeartbeatData.txt"</code>'''
:'''<code>HeartbeatSaver "Path/To/heartbeatdata.txt"</code>'''
 
==heartbeatdata.txt format==
Line 01: Salt
Line 02: InternalIP
Line 03: Port
Line 04: Player count
Line 05: Max players
Line 06: Server name
Line 07: IsPublic flag ("true" or "false")
Line 08: WoMDirectDescription
Line 09: WoMDirectFlags
Line 10: HeartbeatToWoMDirect
For example:
MuXCwxhDCNz9BIz6aBDlNYXWWhypWwvA
0.0.0.0
25565
0
20
Custom Minecraft Server (fCraft)
False
 
[fCraft]
True
 
==HeartbeatSaver.exe exit codes==
:0 - Success (HeartbeatSaver never exits, so you should never normally encounter this code).
:1 - Usage error. Make sure that a valid file is given.
:2 - Could not read heartbeat data at startup. Make sure that a valid path is given, and that the file is in correct format.


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

Revision as of 20:13, 23 September 2012

HeartbeatSaver is a utility, bundled with fCraft 0.632+, 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.

When you disable fCraft's built-in heartbeat (set HeartbeatEnabled config key to "false"), fCraft will start writing heartbeatdata.txt 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.

Usage

HeartbeatSaver "Path/To/heartbeatdata.txt"

heartbeatdata.txt format

Line 01: Salt
Line 02: InternalIP
Line 03: Port
Line 04: Player count
Line 05: Max players
Line 06: Server name
Line 07: IsPublic flag ("true" or "false")
Line 08: WoMDirectDescription
Line 09: WoMDirectFlags
Line 10: HeartbeatToWoMDirect

For example:

MuXCwxhDCNz9BIz6aBDlNYXWWhypWwvA
0.0.0.0
25565
0
20
Custom Minecraft Server (fCraft)
False
 
[fCraft]
True

HeartbeatSaver.exe exit codes

0 - Success (HeartbeatSaver never exits, so you should never normally encounter this code).
1 - Usage error. Make sure that a valid file is given.
2 - Could not read heartbeat data at startup. Make sure that a valid path is given, and that the file is in correct format.