source: branch_service/Readme.txt @ 642

Revision 642, 7.9 KB checked in by Eoin, 11 years ago (diff)
Line 
1Halite: A Free Open-Source BitTorrent client
2
3Version: 0.3.1.6 dev 638 released 29th November 2008
4
5WWW:   http://www.binarynotions.com/halite-bittorrent-client
6Forum: http://www.binarynotions.com/forum.php
7
8Developer: Eóin O'Callaghan
9
10Halite (named after the mineral) is a BitTorrent client based on Arvid
11Norberg's excellent libtorrent library from Rasterbar Software. The
12program also relies on the Boost libraries.
13
14Features:
15
16While still at an early state of development Halite is a functional
17BitTorrent client. So far its list of features is pretty standard but
18that is because I want to ensure it does the basic stuff well.
19
20That said, it supports:
21
22  + File selection and/or file priority specifications.
23  + 'Managed torrent' queue system.
24  + Disk cache support.
25  + Trackerless torrents (using the Mainline kademlia DHT protocol).
26  + IP filtering with eMule style ipfilter.dat import.
27  + Protocol Encryption support.
28  + Translations of the UI into a number of languages through the help
29    of volunteers. (if you wish to help with a translation then please do)
30  + Minimise to tray with transfer rate summary.
31  + Full Unicode support through UTF-8 and native Windows wide-char
32    strings.
33  + Login support where tracker requires it.
34  + Ability to edit trackers specified in the torrent.
35  + Transfer rate and connection limits both global and per-torrent.
36  + Torrent file creation.
37  + Port randomisation and forwarding (UnPlug and Play or NAT-PMP)
38  + Compatible with UAC.
39
40Requirements: Windows 2000, XP, Server 2003, Vista or Server 2008.
41
42Important note for people upgrading!
43
44When installing through the MSI file download, Halite will make a
45registry entry pointing it to use the local Application Data directory
46for all configuration files. User should manually copy any existing
47files from an older Halite version to that directory. The recommended
48files and folder to copy are:
49
50Halite.xml
51BitTorrent.xml
52IPFilter.bin
53DHTState.bin
54resume/*
55torrents/*
56
57These changes were necessary to make Halite fully compatible with User
58Account Control. To revert to 'portable mode' whereby all config
59information will be saved alongside the executable simply delete that
60registry key (HKEY_CURRENT_USER\Software\Halite\path). If you only
61ever used the standalone download release this will not be necessary.
62
63Big Known Issues
64
65  + 'Queue View' mode is not supported on Windows 2000.
66  + Sorting in 'Queue View' mode is currently not functional under XP.
67  + CPU usage spikes if the file tab is left open for a torrent with a
68    large number of separate files.
69
70Changes:
71
72 + from v 0.3.1 to 0.3.1.6:
73   1) Based on libtorrent 0.14 which brings with it:
74      - Disk cache support
75      - 'Managed torrent' queue system
76      - Improved seeding and choking behavior
77      - Resource usage optimizations
78      - Many more fixes and improvements
79   (code.rasterbar.com/libtorrent/browser/tags/libtorrent-0_14/ChangeLog)
80
81   2) Optional port randomizations (both main and DHT).
82   3) Numerous internal settings are now exposed by the GUI.
83   4) Plays nice by Vista/Server 2008 UAC rules. See note above.
84   2) Rewritten XML fileformat (again) with greatly improved robustness.
85
86 + from v 0.3.0.7 to 0.3.1:
87   1) Bug fixes.
88
89 + from v 0.3.0.5 to 0.3.0.7:
90   1) Adds ability to create torrent files.
91   2) A lot of small improvements and bug fixes.
92
93 - from v 0.3.0.2 to 0.3.0.5:
94   1) Right-click context menu option to 'Open download folder'.
95   2) Right-click context menu option to force a file recheck.
96   3) Option to move seeding torrent to another folder.
97   4) Fixed a bug with tracker logins.
98
99 + from v 0.3 to 0.3.0.2:
100   Mainly a bugfix release.
101   1) Fixed a bug with Tray Icon remaining after window was restored.
102   2) Torrent Connection and Transfer setting mapped to incorrect
103      editbox.
104   3) Subtle bug where some settings didn't register straight away.
105
106 + from v 0.2.9 to 0.3:
107   1) File selection and/or priority settings.
108   2) Protocol Encryption.
109   3) New tabbed interface makes better use of screen real estate.
110   4) Updated to recent versions of Boost (1.34.1) and libtorrent.
111   5) Numerous bug fixes.
112   
113 + from v 0.2.8 to 0.2.9:
114   1) Full Unicode support!
115   2) Rewitten XML fileformat with greatly improved robustness.
116   3) New tabbed interface makes better use of screen real estate.
117   4) Ability to edit Trackers and set login details.
118   5) Comprehensive logging for diagnosing problems.
119   6) Windows 2000 and Server 2003 supported fully.
120   7) Switched to MSVC 2005 compiler (8.0) for improved reliability
121      though at the cost of slightly bigger executables.
122   
123+ from v 0.2.7 to 0.2.8:
124   1) IP filtering support eMule style ipfilter.dat files.
125   2) DHT support, thought it is turned off by default.
126   3) Can select alternate save directory for torrents..
127   4) New icon!
128
129 + from v 0.2.6 to 0.2.7:
130   1) By default Halite will only allow one instance to be launched
131   2) Halite can be set as the default program for '.torrent' files.
132   3) ETA indicator for torrents. 4) Minor GUI tweaks.
133
134 + from v 0.2.5 to 0.2.6:
135   1) Fixed a silly bug (i.e. I should have caught it sooner) whereby
136      exiting Halite from the tray would screw up the window layout
137      next time running it.
138   2) Added auto-selection to Torrents list to make it more intuitive.
139
140 + from v 0.2 to 0.2.5:
141   1) The GUI is slightly altered so that it looks consistent and neat
142      for a number of visual styles which I was able to test it on.
143   2) The ability to drag and drop torrent files into the app has been
144      added.
145   3) It will minimise to the tray instead of task bar and hovering
146      mouse for the tray icon displays the current up and down rate.
147   4) Where previously the various limits boxes didn't validate
148      properly now they do and any invalid input is interpreted as no
149      limit and a nice infinity symbol is displayed.
150   5) Individual torrent info is saved and loaded when the program is
151      closed and reopened allowing torrent limits to be remembered.
152   6) If the program has to wait after the user clicking close for any
153      active connections to shutdown down 'cleanly' an optional small
154      dialog is displayed to alert the user that the program is still
155      running.
156
157Subversion: svn://svn.geekisp.com/halite
158
159In addition you can check out the Trac site (trac.geekisp.com/halite)
160but I haven't really done much with it ... yet.
161
162Thanks:
163
164It can be hard to remember to thank everyone but that is no excuse for
165leaving someone out. If I have done so let me know.
166
167  + Arvid Norberg- As the author of libtorrent he has made the single
168    biggest contribution to this project.
169    http://www.rasterbar.com/products/libtorrent/index.html
170
171  + Christopher Kohloff- The man behind Boost.ASIO a crucial element
172    of libtorrent and my own libhttp library.
173    http://asio.sourceforge.net/
174
175  + nudone (Nick Pearson)- The excellent artist who designed the icon
176    for Halite.
177        wtfcody.com / nudsville.com
178
179  + Tw@in 28 for all the help moderating the forum.
180
181  + Austin; very kindly made the Iss install script for Halite.
182
183  + Everyone who has been in touch with me through email or the forum
184    and have shared their ideas and feature requests for the client.
185    They have given the project direction and purpose.
186
187  + And of course all the translators:                   
188
189    - devGod – Nederlandse vertaling.
190    - MaikelChan - maikelchan88@gmail.com - Traducción en Español de España.
191    - Prome – prome.lwaku.info – Avtor slovenskega prevoda.                 
192    - Tw@in 28 – twain_28@hotmail.com - Traduttore Italiano.
193    - u!^DEV  - germanpg.hacker.to - deutsche Übersetzung.
194    - webdr - www.langturk.com - Türkçe çeviri.
195    - Čagalj - cagalj@mail.ru - Preveo sve na srpski (latinicu i ćirilicu).
196    - AlexKrycek - alexkrycek0@gmail.com - μετάφραση στα ελληνικά.
Note: See TracBrowser for help on using the repository browser.