aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 799a903048871ee1a7df1a3bb8b8c56f76f8a6d9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# Mobius

Cross-platform command line [Hotline](https://en.wikipedia.org/wiki/Hotline_Communications) server and client

[![CircleCI](https://circleci.com/gh/jhalter/mobius/tree/master.svg?style=svg&circle-token=7123999e4511cf3eb93d76de98b614a803207bea)](https://circleci.com/gh/jhalter/mobius/tree/master)

# Installation

### Mac OS X

#### Client

    brew install jhalter/mobius-hotline-client/mobius-hotline-client

#### Server

    brew install jhalter/mobius-hotline-client/mobius-hotline-client

### Linux

Download a compiled release for your architecture from the Releases page

### Windows

    TODO

# Build

To build from source, run
`make build`

# Features

* Hotline 1.2.3

## Usage

### Precompiled binaries
To get started quickly, download the precompiled binaries for your platform:

* [Linux]()
* [Mac OS X]()

## Compatibility

The server has been tested with:
 * Hotline Client version 1.2.3
 * Hotline Client version 1.8.2   
 * Hotline Client version 1.9.2
 * Nostalgia

### Build from source

	make build


# TODO

* Implement 1.5+ protocol account editing
* Implement folder transfer resume
* Implement file transfer queuing
* Map additional file extensions to file type and creator codes
* Implement file comment read/write
* Implement user banning
* Implement Maximum Simultaneous Downloads
* Maximum simultaneous downloads/client
* Maximum simultaneous connections/IP
* Implement server broadcast
* Implement statistics:
    * Currently Connected
    * Downloads in progress
    * Uploads in progress
    * Waiting Downloads
    * Connection Peak
    * Connection Counter
    * Download Counter
    * Upload Counter
    * Since


# TODO - Someday Maybe

* Implement Pitbull protocol extensions