Print

Please login or register.
1 Hour 1 Day 1 Week 1 Month Forever
Login with username, password and session length

[prixt]

SOUNDSENSE-RS

A SoundSense clone, written in Rust

Releases - Repository

Spoiler: Windows Screenshot (click to show/hide)

Spoiler: Mac Screenshot (click to show/hide)

Spoiler: Linux Screenshot (click to show/hide)

Hello! I am writing a SoundSense alternative in Rust.

Why?

• To see if I could.
• To create a standalone application that doesn't require bloat.

Ultimately, you should only need one binary executable, the soundpack folder, and DF.

Current Features

• Plays sound reactive to what is happening in DF.
• Sound volumes can be adjusted realtime, based on channel.
• Custom ignore list, allowing the user to customize which log patterns to ignore.
• Minimalistic GUI.

Command line parameters

• -l / --gamelog [GAMELOG_FILE]: preload the gamelog (default: ".\gamelog.txt")
• -p / --soundpack [PACK_DIR]: preload the soundpack (default: ".\soundpack")
• -i / --ignore [IGNORE_FILE]: preload the ignore list (default: ".\ignore.txt")
• --no-config: Don't read config files on start. Will use the given paths, or soundsense-rs defaults.

Example:

Code: [Select]

soundsense-rs.exe -l "C:\path\to\gamelog.txt" -p "D:\path\to\soundpack\folder"This will make soundsense-rs check if there is a file named "ignore.txt" in the working directory, and will use that file to make the ignore list.

Dependencies
Linux: libasound2, libgtk-3, libgdk-3, libwebkit2gtk-4.0, libjavascriptcregtk-4.0

Known Issues

• Not all parameters in the soundpacks are implemented. (ex. threshold)

Bug reports and feature requests are welcome!

[jecowa]

Looks cool. It would be great to not need Java or mono.

[jecowa]

Do you have an icon for this application? Here's what I'm using right now:

Spoiler: Screenshot in-use: (click to show/hide)

[Abadrausar]

I have liked this utility because it is multi-platform and very lightweight in memory usage, liberating a whole lot of system memory for being usable in Dwarf Fortress where it is badly needed.

Application	Platform Language	Version	Download size in MB			Runtime required in MB
			Linux	OSX	Windows
SoundSense	java runtime	r2016-1	1	1	1	65-80
SoundCense	c# CLR	1.4.4	5.27	5.27	5.27	100
SoundSense-RS	Rust native or WebAssembler	1.3.2	2.81	1.91	2.7	0

Any possibility of converting this into a WebAssembly application which is supported by the Rust build system apparently.

Milo Christiansen did that with his Rubble modding system for DF, as a way to streamline the deployment and the debugging of the UI of his application over the many OS supported by DFHACK (Windows, Linux, OSX).

Then; only one application wasm package would be usable in all the 3 OS.

[Button]

How does this handle combat sounds coming in too fast to complete? When I tried SoundCense (the version that was packed with the LNP at the time), combat sounds were almost unusable, because they'd all be queued up and each sound was a lot longer than the actual combat event in question. I'd end up having to pause the game a bunch to let the combat sound channel resolve.

SoundSense is better in that it seems to play the most recent combat sound, rather than queuing them up; which means that if you're hearing a combat sound, combat is currently ongoing.

What approach does SoundSense-RS take?

[jecowa]

How does this handle combat sounds coming in too fast to complete? When I tried SoundCense (the version that was packed with the LNP at the time), combat sounds were almost unusable, because they'd all be queued up and each sound was a lot longer than the actual combat event in question. I'd end up having to pause the game a bunch to let the combat sound channel resolve.

SoundSense is better in that it seems to play the most recent combat sound, rather than queuing them up; which means that if you're hearing a combat sound, combat is currently ongoing.

What approach does SoundSense-RS take?

If there's too much stuff going on at once, it just doesn't play anything. It goes silent. It does not queue things up. Around five units fighting at-once in the arena seems like too much for it.

[prixt]

It seems the main draw for my version of SoundSense is its low memory usage... Interesting.
I was looking into swapping the GUI crate this uses, but changing to something that doesn't use webview pretty much doubles the binaries memory.
What features do you think I should prioritize?
Also, jecowa reported the GUI not displaying on their OSX; do other people have problems with it too?

[prixt]

Any possibility of converting this into a WebAssembly application which is supported by the Rust build system apparently.

Milo Christiansen did that with his Rubble modding system for DF, as a way to streamline the deployment and the debugging of the UI of his application over the many OS supported by DFHACK (Windows, Linux, OSX).

Then; only one application wasm package would be usable in all the 3 OS.

SoundSense-RS uses a lot of dependent crates, and in order to target WASM, all of the crates must be able to target WASM. So I don't think this will be practically possible.

[jecowa]

Hey, prixt. I just wanted to let you know I'm including SoundSense-RS in the Lazy Mac Pack.

I tested it on a Debian/Ubuntu-based Linux machine. I got the same problem with the GUI as on Mac, except the Linux version also gave me an error message: Failed to load module "appmenu-gtk-module".

I like that it doesn't use disk space and doesn't need third-party software to run. It looks like the current memory usage is ~25 MB and the disk usage is 2.5 MB. If these doubled, I don't think it would be a big deal. I don't mind not having volume controls, but it would be kind of nice.

[prixt]

Hey, prixt. I just wanted to let you know I'm including SoundSense-RS in the Lazy Mac Pack.

I tested it on a Debian/Ubuntu-based Linux machine. I got the same problem with the GUI as on Mac, except the Linux version also gave me an error message: Failed to load module "appmenu-gtk-module".

I like that it doesn't use disk space and doesn't need third-party software to run. It looks like the current memory usage is ~25 MB and the disk usage is 2.5 MB. If these doubled, I don't think it would be a big deal. I don't mind not having volume controls, but it would be kind of nice.

Thank you for the inclusion!

[jecowa]

Mac GUI:

[prixt]

Mac GUI: ...

Cool! Can I use it on the repos README?

[jecowa]

Yes, it's fine with me.

How does it determine if something is Weather or Music?

[prixt]

How does it determine if something is Weather or Music?

Each sound entry can have a channel parameter(music, weather, swords, etc.). If it doesn't have any, its put into the misc channel.

[jecowa]

Currently the "Swords" channel is unused outside of the sample.xml in the Default Pack. And I think that's just an example pack that's meant to be deleted.

Currently none of the stuff in the Battle Pack from the "Official Pack" uses a channel, so I moved everything from the Battle Pack on the "Swords" channel. I'm not very experienced with SoundSense, so if you have any suggestions, I'm interested.

Nice thing about sound packs on GitHub is that you can get updates without downloading the whole thing every time. https://github.com/jecowa/soundsensepack/releases