]> Sergey Matveev's repositories - vors.git/blob - doc/install.texi
27bfb44926613e8183924b085994d10f4a4ead608e9719e38c7a9a2deda0fab7
[vors.git] / doc / install.texi
1 @node Install
2 @unnumbered Install
3
4 VoRS is written on @url{https://go.dev/, Go} (at least 1.21 version is
5 required), but also uses wrapper on @url{https://opus-codec.org/,
6 libopus} library. Provided tarballs include its source code
7 (@url{https://wiki.hydrogenaud.io/index.php?title=Opus, look} how many
8 improvements Opus got over the years) and a fork of the
9 @url{https://github.com/hraban/opus, gopkg.in/hraban/opus.v2} with the
10 added ability to use @code{Decoder.SetComplexity} call, that is required
11 for @url{https://opus-codec.org/demo/opus-1.5/, ML-related} optimisations.
12
13 Audio recording and playback is done through external utilities, capable
14 of reading/writing raw audio samples from stdin/stdout.
15 @url{https://sourceforge.net/projects/sox/, SoX}'es @command{rec} and
16 @command{play} are used by default. You can use anything you want by
17 overriding them with @option{-rec} and @option{-play} options to
18 @command{vors-client}.
19
20 @example
21 $ [fetch|wget] http://www.vors.stargrave.org/download/vors-@value{VERSION}.tar.zst
22 $ [fetch|wget] http://www.vors.stargrave.org/download/vors-@value{VERSION}.tar.zst.sig
23 [verify signature]
24 $ tar xf vors-@value{VERSION}.tar.zst
25 $ cd vors-@value{VERSION}
26 $ ./build
27 $ mv bin/vors-* $PATH/bin
28 @end example
29
30 @include download.texi
31 @include integrity.texi
32
33 Also there is @url{https://yggdrasil-network.github.io/, Yggdrasil}
34 accessible address: @url{http://y.www.vors.stargrave.org}.