]> git.r.bdr.sh - rbdr/mobius/blame_incremental - README.md
patch: bump version to v0.0.5
[rbdr/mobius] / README.md
... / ...
CommitLineData
1# Mobius
2
3Cross-platform command line [Hotline](https://en.wikipedia.org/wiki/Hotline_Communications) server and client
4
5[![CircleCI](https://circleci.com/gh/jhalter/mobius/tree/master.svg?style=svg&circle-token=7123999e4511cf3eb93d76de98b614a803207bea)](https://circleci.com/gh/jhalter/mobius/tree/master)
6
7# Installation
8
9### Mac OS X
10
11#### Client
12
13 brew install jhalter/mobius-hotline-client/mobius-hotline-client
14
15#### Server
16
17 brew install jhalter/mobius-hotline-client/mobius-hotline-client
18
19### Linux
20
21Download a compiled release for your architecture from the Releases page
22
23### Windows
24
25 TODO
26
27# Build
28
29To build from source, run
30`make build`
31
32# Features
33
34* Hotline 1.2.3
35
36## Usage
37
38### Precompiled binaries
39To get started quickly, download the precompiled binaries for your platform:
40
41* [Linux]()
42* [Mac OS X]()
43
44## Compatibility
45
46The server has been tested with:
47 * Hotline Client version 1.2.3
48 * Hotline Client version 1.8.2
49 * Hotline Client version 1.9.2
50 * Nostalgia
51
52### Build from source
53
54 make build
55
56
57# TODO
58
59* Implement 1.5+ protocol account editing
60* Implement folder transfer resume
61* Implement file transfer queuing
62* Map additional file extensions to file type and creator codes
63* Implement file comment read/write
64* Implement user banning
65* Implement Maximum Simultaneous Downloads
66* Maximum simultaneous downloads/client
67* Maximum simultaneous connections/IP
68* Implement server broadcast
69* Implement statistics:
70 * Currently Connected
71 * Downloads in progress
72 * Uploads in progress
73 * Waiting Downloads
74 * Connection Peak
75 * Connection Counter
76 * Download Counter
77 * Upload Counter
78 * Since
79
80
81# TODO - Someday Maybe
82
83* Implement Pitbull protocol extensions