doc/index.texi

   1 \input texinfo
   2 @settitle VoRS
   3
   4 @copying
   5 Copyright @copyright{} 2024 @email{stargrave@@stargrave.org, Sergey Matveev}
   6 @end copying
   7
   8 @node Top
   9 @top VoRS
  10
  11 VoRS -- Vo(IP) Really Simple.
  12 Very simple and usable multi-user VoIP solution.
  13 Some kind of alternative to @url{https://www.mumble.info/, Mumble}.
  14
  15 @float
  16 @image{screenshots/example,,,Server and two clients,.webp}
  17 @caption{Server (above) and two clients (left and right) in a terminal multiplexer}
  18 @end float
  19
  20 But why? SIP-based solutions are pretty complicated to setup, because
  21 they are not for simple tasks like sudden voice chats between a few
  22 people. WebRTC-based solutions are insane bloated incredible monsters
  23 by complexity and size, hardly possible to debug and having frequent
  24 compatibility problems. They work mainly only if you use the same kind
  25 of software and codecs, for example Chromium, that requires dozens of
  26 gigabytes of disk space and much RAM, CPU time to build it. Is not it
  27 pure insanity for that relatively simple task?
  28
  29 Mumble has wonderful simplicity and workability, but even its server
  30 side is still written on Qt, that requires hundreds of megabytes of
  31 additional libraries to build it up. And users tend to complain about
  32 its newer client versions quality and convenience.
  33
  34 So let's write as simple VoIP talking client as it is possible, without
  35 compromising convenience and simplicity for user! I just want a simple
  36 command, which I can specify server's address and just immediately talk
  37 with someone.
  38
  39 @itemize
  40
  41 @item No GUI requirement. Why would someone need it for voice
  42 application? But fancy real-time refreshing TUI would be desirable.
  43 Mumble tends to output no information, sometimes hiding the fact of a
  44 problem and that everything stopped working.
  45
  46 @item No NAT-traversal possibility. It is 2024 year already, stop trying
  47 to use and revive legacy obsolete IPv4. Or use some overlay network on
  48 top of it, VPN, whatever.
  49
  50 @item Mono-cypher, mono-codec protocol. @url{https://opus-codec.org/, Opus}
  51 audio codec is perfect for VoIP tasks. ChaCha20-Poly1305 is more than
  52 appropriate and satisfiable as fast and secure encryption solution.
  53
  54 @end itemize
  55
  56 @include install.texi
  57 @include usage.texi
  58 @include vad.texi
  59 @include proto.texi
  60
  61 @bye