Merge branch '0.5'

mum-rs · Oct 3, 2022 · 658d990 · 658d990
2 parents 68ba4c7 + 1d98d82
commit 658d990
Show file tree

Hide file tree

Showing 12 changed files with 800 additions and 536 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,128 +1,100 @@
-Changelog
-=========
-
-This changelog is inspired by https://keepachangelog.com/en/1.1.0/[Keep a
-Changelog]. We follow https://semver.org/spec/v2.0.0.html[semver], but since
-we're in 0.x it's a lawless land anyway.
-
-Points under "unreleased" currently exist on main and will be part of the next
-release.
-
 Unreleased
 ----------
 
-Added
-~~~~~
-
-Changed
-~~~~~~~
-
-Fixed
-~~~~~
-
-Other
-~~~~~
-
- * Instead of four crates we now have only two. mumd and mumctl were merged
-   into mum as binary targets.
- * You can now disable the noise gate by setting `audio.disable_noise_gate =
-   true` in the configuration file.
-
-0.4.0 - 2021-06-19
+0.5.0 - 2022-10-03
 ------------------
 
-Added
-~~~~~
+Major changes:
 
- * Added a noise gate.
- * Added tunneling audio through TCP if UDP connection goes down.
- * --version now includes the current commit hash.
- * Server passwords. Thanks @rbran!
- * Added support for sending and receiving text messages.
- * See a list of occured events with +mumctl events+.
- * Invalid server certificates are now rejected by default and need to be
-   explicitly allowed either when connecting or permanently per server or
-   globally.
- * .ogg sound effects.
+- Instead of four crates we now have only two. mumd and mumctl were merged into
+  mum as binary targets. The installation instructions have been updated to
+  match this.
+- Disable the noise gate by setting `disable_noise_gate = true` under `[audio]`
+  in the configuration file.
+- The "mumctl config" and "mumctl server config" commands use toml_edit instead
+  of normal toml serialization. This makes it so comments and unknown values
+  aren't removed.
 
-Changed
-~~~~~~~
+Other:
 
- * Changed how you mute yourself/others. See man pages for details on the new options.
- * The current channel status is now printed when connecting to a server.
+- Notifications are sent on their own thread so they don't freeze the entire
+  application while waiting for a timeout if a notification daemon isn't
+  present.
+- Rust 2021.
+- Clap 4. The help output formatting has changed a bit but the content remains
+  the same.
 
-Fixed
-~~~~~
 
- * Client no longer sends empty audio packets.
- * Informative error message instead of panic when a running mumd-process can't
-   be found.
- * Lots of other minor informative error messages instead of panics.
- * Status requests are sent in parallel.
- * Pings are now less spammy in the log output.
- * Sound output is stereo by default.
-
-Other
-~~~~~
+0.4.0 - 2021-06-19
+------------------
 
- * Updated to tokio 1.0.
- * Cleaned up dependencies
+Major changes:
+
+- Added a noise gate.
+- Added support for server passwords. Thanks @rbran!
+- Added support for sending and receiving text messages.
+- See a list of occured events (connections, messages, mute/deafen, ...) with
+  "mumctl events".
+- Invalid server certificates are rejected by default and need to be
+  explicitly allowed either when connecting or permanently per server or
+  globally.
+- .ogg sound effects.
+
+Other:
+
+- Added tunneling audio through TCP if UDP connection goes down.
+- --version now includes the current commit hash.
+- Changed how you mute yourself/others. See manpages for details on the new options.
+- The current channel status is now printed when connecting to a server.
+- Client no longer sends empty audio packets.
+- Informative error message instead of panic when a running mumd-process can't
+  be found.
+- Lots of other minor informative error messages instead of panics.
+- Status requests are sent in parallel.
+- Pings are less spammy in the log output.
+- Sound output is stereo by default.
+- Updated to tokio 1.0.
+- Cleaned up dependencies
 
 0.3.1 - 2021-04-08
 ------------------
 
-Fixed
-~~~~~
-
- * Compilation no longer fails with "module export is private".
+- Compilation no longer fails with "module export is private".
 
 0.3.0 - 2020-12-25
 ------------------
 
-Added
-~~~~~
-
- * Published to crates.io. You can now install with +cargo install {mumctl,mumd}+!
- * Support for macOS.
- * Notifications via libnotify (behind a feature-gate).
- * List configured servers, if they're online and how many users are
-   connected with +mumctl status+.
- * Configure your own outgoing volume and others' ingoing volume with +mumctl config+.
- * Mute/deafen yourself with +mumctl {mute,deafen}+.
- * Locally mute others with +mumctl user <user> mute+.
- * Sound effects.
- * Short about-texts when using +--help+.
- * Man pages.
+Major changes:
 
-Changed
-~~~~~~~
+- Published to crates.io. You can now install with "cargo install {mumctl,mumd}"!
+- Support for macOS.
+- Notifications via libnotify (behind a feature-gate).
+- List configured servers, if they're online, and how many users are
+  connected with "mumctl status".
+- Configure your own outgoing volume and others' ingoing volume with "mumctl config".
+- Mute/deafen yourself with "mumctl {mute,deafen}".
+- Locally mute others with "mumctl user <user> mute".
+- Sound effects.
+- Connecting and disconnecting from servers is now done with "mumctl
+  {connect,disconnect}" instead of under the "server" subcommand.
 
- * Connecting and disconnecting from servers is now done with +mumctl
-   {connect,disconnect}+ instead of under the +server+ subcommand.
+Other:
 
-Fixed
-~~~~~
-
- * Starting an instance of mumd while another is already running now requires
-   the old instance to be shut down so instances aren't left running and
-   unreachable.
-
-Other
-~~~~~
-
- * Moved to dasp, a pure Rust digital audio signal processing library.
+- Manpages.
+- Short about-texts when using "--help".
+- Starting an instance of mumd while another is already running now requires the
+  old instance to be shut down so instances aren't left running and unreachable.
+- Moved to dasp, a pure Rust digital audio signal processing library.
 
 0.2.0 - 2020-10-26
 ------------------
 
-Added
-~~~~~
-
- * Connect to and disconnect from servers with +mumctl server {connect,disconnect}+.
- * Save and reconfigure servers with +mumctl server {add,remove,rename,config}+.
- * List channels and connect to them with +mumctl channel {list,join}+.
- * Store configuration in a file.
- * Generate CLI completions for zsh, bash and fish with +mumctl completions --{zsh,bash,fish}+.
+- Connect to and disconnect from servers with "mumctl server
+  {connect,disconnect}".
+- Save and reconfigure servers with "mumctl server {add,remove,rename,config}".
+- List channels and connect to them with "mumctl channel {list,join}".
+- Store configuration in a file.
+- Generate CLI completions for zsh, bash and fish with "mumctl completions --{zsh,bash,fish}".
 
 Links
 -----