Getting Started

2005-10-28T09:32:23Z

62.99.121.162:

<center>
'''English''' | [[Getting_Started-fr|Français]] | [[Getting_Started-nl|Nederlands]] | [[Getting_Started-es|Español]] | [[Getting_Started-de|Deutsch]] | [[Getting_Started-hu|Magyar]]
</center>

== What is [[aMule]] ==

[[aMule]] is a [[P2P|p2p]], or peer-to-peer, client for the [[FAQ_eD2k-Kademlia|eD2k]] network, commonly known as [[FAQ_eD2k-Kademlia|eDonkey network]] or eD2k network ([[eDonkey2000]]). This guide does not require you to be familiar with these networks (but it does help), however it does require that you have [[aMule]] installed on your computer.
If you haven't installed [[aMule]] yet, please refer to the proper installation guide for your system. Links to these guides can be found on the [[Main_Page|main page]].

--[[User:Xaignar|Xaignar]] 01:12, 10 Jul 2004 (CEST)

== Running [[aMule]] for the first time ==
First, launch [[aMule]]. This can be done by executing the command ''amule'' in a console window or by whatever method might be provided by your distro and/or windows manager in terms of icons, etc.

Once started, if you are using the [http://www.gnu.org/software/cvs CVS] build, [[aMule]] will display a notification telling you that you are running it for the first time. Read this to learn what you are getting yourself into ;)

=== Configuring [[aMule]] ===
Before you begin file sharing, you will need to properly configure [[aMule]]. This includes connection speeds and limits, directories to be used, proxies, port settings and other settings.
You can access [[aMule]] preferences by clicking on the ''Preferences'' icon at the top of the [[aMule]] window.

==== Connection Speed ====
You should know that the eDonkey clients enforce upload. This means that in order to download, you'll have to share files yourself (don't worry if you don't have anything to share). This is enforced in two ways:
* Your download speed depends on how fast you upload. If your upload speed is set to anything below 10kb/s then your maximum download speed will be 3 or 4 times your uploadspeed (read [[FAQ_eD2k-Kademlia#Are_there_any_limitations_on_the_ED2K_network?|this]] to know more about it), so if you limit your upload speed to 5kb/s, you'll only be able to download with 20kb/s.
* Partially downloaded files are shared as well. You automatically start sharing a file after you've received at least one [[FAQ_eD2k-Kademlia#What_is_a_chunk?|chunk]] (a [[FAQ_eD2k-Kademlia#What_is_a_chunk?|chunk]] is a 9.28Mb piece of a file).

Note: If you ever enter the [http://forum.amule.org aMule forum] or [[IRC|IRC channel]] to complain about this or demand that we change the ratio, I will hunt you down and eat your spleen. -- [[User:Xaignar|Xaignar]]

When you first open the Preferences dialog, the page shown will be "General", which contains some general settings, like the [[nickname]] other people will see when they download from or upload to you.
To proceed, click on the tab named "Connection":

http://www.amule.org/dev-up/Limits.png

The only settings relevant to this guide are the settings under "Bandwidth Limits" marked "Upload" and "Download". You don't need to enter a max download speed, but it is recommended that you set the upload speed to around 80% of your actual speed, since it can cause slower downloads otherwise.

Once you have entered the proper values, you can explore the rest of the settings. To save the changes, simply click the "OK" button.

=== Connecting to a Server ===

You should now be looking at the servers dialog:

http://www.amule.org/dev-up/ServerDlg.png

The empty list normally contains the servers you know about, but since this is the first time you're running [[aMule]], you don't have any. To remedy this situation, simply click in the text-field containing the text ''http://www.srv1000.com/azz/server.met'' and press enter.
A dialog will pop up and close again once the download has completed.

You should now have a full list of servers, if not search google for ''server.met'' and place the file in the folder ''.aMule'' on your home dir. The list should look like this:

http://www.amule.org/dev-up/ServerList.png

Next you need to connect to a [[server]]. Normally it's a good idea to select one with as many users as possible, but for now, lets just click the large "Connect" button near the top-left of the window. This will connect you to a random server. Please wait while [[aMule]] contacts servers and tries to establish an connection. Once this happens, proceed on to the next section.

=== [[FAQ_eD2k-Kademlia#What_is_LowID_and_HighID?|High and Low ID]] ===
Because [[P2P|p2p]] networks work by [[Client|clients]] directly connecting to each other, being behind a firewalls, or routers that do not/cannot pass traffic on specific ports, can really cause problems. If you don't know whenever or not you are behind a firewall, simply look at the globe icon in the bottom-right of the window. If its arrows are green, then you have [[FAQ_eD2k-Kademlia#What_is_LowID_and_HighID?|High ID]] and can proceed, but if they are yellow, then you need to take a look at the page on [[Firewall|Firewalls]] and/or [[AMule_problems#aMule_connects_to_server,_but_it_is_always_given_LowID._Why?_and,_can_I_do_something_about_it?|common problems]], since having a [[FAQ_eD2k-Kademlia#What_is_LowID_and_HighID?|Low ID]] greatly reduces [[P2P|p2p]] experiences.

== Basic Usage ==
This will cover some basic usage of [[aMule]].

=== Searching and Downloading ===
OK, this is what [[P2P|p2p]]'ing is about: Downloading files.
For the sake of this guide, I'll presume that you are really keen on downloading the latest [http://www.knoppix.org Knoppix] CD (who isn't?). To download this, first ensure that you are connected to a server and then click on the "Searches" button.

This will bring up the search dialog:

http://www.amule.org/dev-up/SearchDlg.png

Since we only care about CD images, we click on "Extended Options" and select the option "CD-Images" from the "Type" dropdown menu. Also select the "[[Search#Local_search|Local]] [[Search]]" setting, since we don't really need to search anything other than the currently connected [[server]]. Then we enter ''Knoppix'' in the top "Name" field and hit enter or the "Search" button. You should now have a listful of results:

http://www.amule.org/dev-up/SearchResults.png

Lets sort the list by [[FAQ_eD2k-Kademlia#What_is_a_source?|sources]], by clicking twice on the field marked "Sources", this makes it easier to find popular files. The second one looks interesting, so we double-click on it (or click on it and then on the "Download" button). This will queue the file for download.

Results can be displayed in a number of colors, which signify the following:
* Blue represents the number of sources, the more sources the darker the blue.
* Red represents files that you are currently downloading.
* Green is for files you have downloaded or shared before, in other words files you already have.

=== The Download Queue ===
Click on the "Transfers" button to bring forth a list of files you have queued for download:

http://www.amule.org/dev-up/DownloadQueue.png

If you're lucky, the progress bar will turn a nice dark shade of blue, which means that a lot of people have that file (read [[FAQ_aMule#What_do_those_colors_in_the_progress_bar_mean?|this]] to know more about it). Beware of files that have parts marked in red, since it means that no-one has that part of the file and you most likely wont be able to complete the download.

If you double-click on any of the files, you can see the [[FAQ_eD2k-Kademlia#What_is_a_source?|sources]] you have found for that file.

==== Of Rows and Columns ====
These are the columns of the Download Queue:

; ''Filename'' : The name of the file.
; ''Size'' : The size of the file. The eDonkey2000 network supports files up to 4GB in size (read [[FAQ_eD2k-Kademlia#Are_there_any_limitations_on_the_ED2K_network?|more]] about this).
; ''Transferred'' : Shows the amount downloaded.
; ''Completed'' : This column displays how much of the file you have actually completed. Please note that this can differ from the Transferred column because of corruptions or gains made by the compression *Mule [[Client|clients]] use (read [[FAQ_aMule#What_is_the_difference_between_Transfered_and_Completed_in_the_Transfers_window?|more]] about this difference).
; ''Progress'' : This bar displays the current progress of the file, the colours signifying the following (alternative [[FAQ_aMule#What_do_those_colors_in_the_progress_bar_mean?|resource]]):
* Blue: How many sources provide this part, the darker the colour, the more sources provide it.
* Red: There are no known [[FAQ_eD2k-Kademlia#What_is_a_source?|sources]] that provide this part.
* Black: You have already downloaded this part.
* Yellow: You are currently downloading this part.
: The green bar on top of the larger bar gives an indication of the actual progress.
; ''Sources'' : There are 3 fields in this column, though mostly only 2 are shown (alternative [[FAQ_aMule#What_do_all_those_numbers_in_the_sources_column_in_the_transfers_window_mean?|resource]]):
: <Asked [[FAQ_eD2k-Kademlia#What_is_a_source?|Sources]]>[/<All [[FAQ_eD2k-Kademlia#What_is_a_source?|Sources]]>] [+ <[[FAQ_aMule#What_is_A4AF?|A4AF]] [[FAQ_eD2k-Kademlia#What_is_a_source?|Sources]]> ] [(<Transferring [[FAQ_eD2k-Kademlia#What_is_a_source?|sources]]>)]
: 'Asked [[FAQ_eD2k-Kademlia#What_is_a_source?|Sources]]' are those that have been asked for the file.
: 'All [[FAQ_eD2k-Kademlia#What_is_a_source?|Sources]]' are all [[FAQ_eD2k-Kademlia#What_is_a_source?|sources]] of that file, asked and unasked.
: '[[FAQ_aMule#What_is_A4AF?|A4AF (Asked For Another File)]] [[FAQ_eD2k-Kademlia#What_is_a_source?|Sources]]' are [[FAQ_eD2k-Kademlia#What_is_a_source?|sources]] that provide that file, but have been asked for anther one.
: 'Transferring [[FAQ_eD2k-Kademlia#What_is_a_source?|sources]]' are [[FAQ_eD2k-Kademlia#What_is_a_source?|sources]] which are uploading that file to you at this very moment.
; ''Priority'' : The priority of the file. Files are set to auto-priority by default, which means that [[aMule]] will manage it by itself. Priorities affect how [[aMule]] allocates [[FAQ_eD2k-Kademlia#What_is_a_source?|sources]] that are known to provide multiple files and thus means that high-priority files get more [[FAQ_eD2k-Kademlia#What_is_a_source?|sources]]. Read [[FAQ_aMule#What_do_all_those_numbers_in_the_priority_column_in_the_extended_transfers_window_mean?|more]] about this.
; ''Status'' : The current status of the file. Waiting means that you are waiting for [[FAQ_eD2k-Kademlia#What_is_a_source?|sources]] to start uploading to you.
; ''Time Remaining'' : An guess at how fast the file will be completed. Only shows something when you are currently receiving the file.
; ''Last Seen Complete'' : This shows the last time you've seen the entire file provided by the [[FAQ_eD2k-Kademlia#What_is_a_source?|sources]] you've asked.
; ''Last Reception'' : This shows the last time you were downloading parts of this file.

=== The Upload Queue ===
The upload queue can be found just beneath the download queue, and shows who are downloading files from you (you might want to read [[FAQ_aMule#Why_are_there_two_transfer_rates_in_the_uploading_transfer_list?|this]]). In case you are wondering, no, you cannot stop uploads. If you click on the blue icon next to the "Uploads" label, you can see who are queued for downloading from you, rather than the people who are actually downloading from you right now.

=== Icons and What They Signify ===
These are the icons that can be found on the Transfers page.

* '''Source Status'''
** http://www.amule.org/dev-up/Source_1.png - [[Client]] is sending you either a file or a hashset.
** http://www.amule.org/dev-up/Source_2.png - You are either on this [[Client|clients]] queue or currently asking it for a file.
** http://www.amule.org/dev-up/Source_3.png - You are currently connecting to this [[Client|client]].
** http://www.amule.org/dev-up/Source_4.png - [[Client]] has been asked for another file, has no needed parts or is unable to connect because of a [[FAQ_eD2k-Kademlia#What_is_LowID_and_HighID?|Low ID]].
** http://www.amule.org/dev-up/Source_5.png - Status is unknown.

* '''eDonkey Clients'''
** http://www.amule.org/dev-up/Client_aMule.png - [[aMule]]
** http://www.amule.org/dev-up/Client_eDonkey.png - [[eDonkey2000]]
** http://www.amule.org/dev-up/Client_eMule.png - [[eMule]]
** http://www.amule.org/dev-up/Client_Friend.png - [[Client]] is a [[Friend]]
** http://www.amule.org/dev-up/Client_Lphant.png - [[lphant]]
** http://www.amule.org/dev-up/Client_MLDonkey.png - [[mlDonkey]]
** http://www.amule.org/dev-up/Client_Shareaza.png - [[Shareaza]]
** http://www.amule.org/dev-up/Client_Unknown.png - Unknown [[Client]]
** http://www.amule.org/dev-up/Client_xMule.png - [[xMule]]

* '''Modifiers'''
** http://www.amule.org/dev-up/Client_Mod_eMuleProt.png - [[Client]] supports the extended [[eMule]] protocols. Source-sharing and such.
** http://www.amule.org/dev-up/Client_Mod_GoodCredit.png - [[Client]] has a good [[FAQ_eD2k-Kademlia#What_is_all_this_talk_about_credits,_ratings_and_scoring_about?|credit-rating]].
** http://www.amule.org/dev-up/Client_Mod_NormCredit.png - [[Client]] has a normal [[FAQ_eD2k-Kademlia#What_is_all_this_talk_about_credits,_ratings_and_scoring_about?|credit-rating]].
** http://www.amule.org/dev-up/Client_Mod_SecId_Good.png - [[Client]] has been [[Secure_User_Identification|securely identified]].
** http://www.amule.org/dev-up/Client_Mod_SecId_Bad.png - [[Client]] has been identified for some reason as a [[bad guy]].

* '''File [[comment]]s'''
** http://www.amule.org/dev-up/File_Comment.png - This file has either been rated or someone has added a [[comment]].
** http://www.amule.org/dev-up/File_Comment_Bad.png - This file has been rated as [[Fake]] by at least one person.

=== Where Are The Files? ===
Once [[aMule]] starts downloading a file, it will create a number of files to keep track of that specific download. These files can be found in the subdir ''.aMule/Temp'' in your homedir (''~/.aMule/Temp''), but should not be touched in most cases.

If you have incompleted downloads from [[eMule]], you can simply place the temp files in the ''~/.aMule/Temp'' directory if you wish for [[aMule]] to continue downloading them.

However, once a file has been completed, it will be moved away from ''~/.aMule/Temp'' and to ''~/.aMule/Incoming'', where all completed files are placed by default. You can change both of these paths in the preferences should you wish to do so.

Also, please note that the ''.aMule'' directory is a hidden directory, so you might have to enable showing of hidden files in your file-mananger, should you use one such.

=== [[Share|Sharing]] [[File]]s ===
First off, note the [[FAQ_ed2k|eDonkey2000 network]] is not meant to [[share]] small [[file]]s such as audio clips, but instead is optimized for distribution of larger [[file]]s. Also note that its your own responsibility to ensure that you do not violate any local laws regarding material shared.

You can share files in two ways in [[aMule]]:

The first method is to place the [[file]]s in the "Incoming" directory (''~/.aMule/Incoming'' on [http://www.unix.org Unix] like systems). After this has been done, you must either restart [[aMule]] or press the "Reload" button on the SharedFiles page.

http://www.amule.org/reload_button.png

The second method is to explicitly add [[shared directory|shared directories]] in which [[aMule]] will look for [[file]]s to [[share]]. This is done by clicking on the "Preferences" button and selecting the "Directories" page.

http://www.amule.org/images/screenshots/prefs7.png

From there, you can browse to the directory you wish to [[share]] via the directory-tree. Double-clicking on the folder icon will [[share]] the given directory and right-clicking on the folder icon will [[share]] the directory recursively.

== Conclusion ==
Hopefully this brief introduction has given you an idea of how [[aMule]] works. If you feel that something is missing from this guide, please let us know or add it yourself.

AMule Project FAQ - User contributions [en]

Getting Started