Difference between revisions of "Amulesig.dat file"

Revision as of 00:10, 23 January 2006

File

Name: amulesig.dat

Location: ~/.aMule/

Description

This file is generated by aMule to inform external applications about it's status.

aMule's signature file is much more powerful than eMule's and has as much lines as fields. Amongst it's extended features (compared to eMule's signature) are:

• ED2K connecting status report
• Kademlia status report
• nickname
• session and total downloaded and uploaded bytes
• aMule version
• aMule uptime
• number of shared files

Of course, it includes all of eMule's signature file data too:

• whether it is online or not
• which server it's connected to
• upload and download rate
• clients in queue

Format

It's structure is:

• The first line will contain a 0 (zero) if aMule is disconnected from the ED2K network, a 2 if it's connecting (only since aMule 2.0.0-rc4), or a 1 (number 1) if it's online.
• The second third and forth line contain the name, IP and port of the server aMule is connected to (in this order) or a zero (0) if it's offline. Since aMule 2.0.0-rc4 it will also contain a 0 when aMule's status is connecting or cleanly closed.
• The fifth line will contain an capital H or a capital L depending if aMule is connected with a high or low ID. If aMule is disconnected, this field will contain a 0. Again, since aMule 2.0.0-rc4 it will also contain a 0 when aMule's status is connecting or cleanly closed.
• The sixth line will a contain a 0 if aMule is not connected to the Kademlia network, a 1 if it is connected to the Kademlia network with a firewalled status or a 2 if it is successfully connected to the Kademlia network. This field was introduced with aMule 2.1.0.
• The seventh and eighth lines contain the speed in which aMule is downloading and uploading respectively. Since aMule 2.0.0-rc4 both lines contain 0.0 when aMule is cleanly closed. Exactly one decimal is shown (neither mor nor less).
• The nineth and tenth lines contain the number of clients on the upload queue and the amount of shared files respectively. Since aMule 2.0.0-rc4 both lines are set to zero (0) too when aMule is cleanly closed.
• The eleventh line contains the nickname of the user.
• The twelfth and thirteenth lines contain the total amount of bytes downloaded and uploaded respectively.
• The fourteenth line contains the aMule version.
• The fifteenth and sixteenth line contains the amount of bytes downloaded and uploaded in the current session respectively. Since aMule 2.0.0-rc4, both will be 0 if aMule is connecting or was cleanly closed.
• The seventeenth (and last) line contains the amount of time aMule has been running. Since aMule 2.0.0-rc6 this time is expressed in seconds. aMule version before 2.0.0-rc6 expressed the time in the most suitable integer followed by a space and secs, mins or hours depending on the value (or the same time abbreviations in your configured language). Also, since aMule 2.0.0-rc6, if aMule is connecting or was cleanly closed this field will contain a 0 (in aMule versions 2.0.0-rc4 and 2.0.0-rc5, when aMule had been cleanly closed, this line would contain 00 followed by the abbreviation secs (or that same abbreviation in your configured language).

The last line must be followed by a new line character ('\n').

Example

The following is the contents of a valid amulesig.dat file:

1
eD2k Server
23.48.235.15
4661
H
2
157.2
21.5
521
34
Happy aMule user
23496736693
3296032695
CVS
143534593
23387432
3865