Skip to content
Dr. Rubisco edited this page Mar 25, 2022 · 12 revisions

If you have a question you think belongs here, DO NOT HESITATE to submit an issue! All suggestions are appreciated!

This is the start of the Resounding FAQ Page. More will follow.

If you need an answer that is not on this page, you might want to ask for it in the #help-and-support channel of the official Discord.

General

What is Resounding?

Answer

I find your failure to README concerning.

When can I expect the full release of Resounding? (1.0.0)

Answer

There is currently no ETA for the release, nor is there a deadline. However, you can follow the development and ask specific questions on the official Discord here.

For more info, see the Roadmap

In the meantime, is it okay to use Alpha/Testing versions?

Answer

See the section on alphas here.

Is Resounding for Forge or Fabric?

Answer

Resounding is, and always will be, a Fabric mod. There are other mods that achieve similar effects for Forge. Contact Dr. Rubisco on discord if you are interested in porting the mod yourself.

Will Resounding be available on CurseForge?

Answer

When beta and higher versions are released, they will be published on both Modrinth and CurseForge, but all alpha versions will remain exclusive to Modrinth.

Is Resounding a Client or Server mod?

Answer

Resounding MUST be installed on the client to work. Installing on the server is recommended for the best experience, but can be skipped if necessary.

What is the difference between Resounding and Sound Physics?

Answer

Resounding is a complete rewrite of Sound Physics, with the goal of being more accurate, more performant, more stable, and having more features than Sound Physics. When I started developing for Sound Physics, I quickly realized that the way it was implemented was fundamentally flawed, and the entire codebase needed to be rewritten before I could move on to more ambitious features. This realization is what led to the creation of Resounding.

Until the initial (1.0.0) release, Resounding will not officially have all of the same features as Sound Physics. However, this release will include new implementations of all of the core features of Sound Physics, with better performance and accuracy, as well as a few new features that made sense to add along the way.

After the initial release, I plan to add more features originally planned for Sound Physics, such as:

  • Doppler Shift
  • Simple Voice Chat integration
  • Status effect integration
  • And more!

For more info, see the Roadmap

What about Sound Physics Remastered? Isn't that the same thing?

Answer

No. Sound Physics Remastered is an outdated, obsolete, and unofficial fork of Sound Physics that was designed to serve two purposes: It provides Forge 1.17 support, and support for Simple Voice Chat.

Despite the name, Sound Physics Remastered is NOT a rewritten version of Sound Physics, and in fact it became obsolete well before Sound Physics main. It is no longer actively developed besides small bugfixes and version updates.

You should not use Sound Physics Remastered unless you need Forge version, and even then keep in mind that you are not getting any of the latest features.

Does Resounding have good performance on low-end hardware?

Answer

Yes, even better than you might think! See below on parallel wave tracing for an explanation.

What is parallel wave tracing? What makes it good?

Answer

This comes in two parts: "parallel" and "wave tracing".

Basically, when I say "wave tracing" I'm talking about full audio ray tracing, including air absorption, reflection, dispersion, occlusion, etc. it's very analagous to path tracing in shaders. Now you may think that would be awful for performance, especially since the audio system Minecraft uses doesn't support it by default, so I can't use tools like the GPU to speed up the process. And in a way you'd be right.

The reason I can get such good performance out of this without good hardware is twofold: First, you really don't need very many rays to get an accurate-sounding effect. With low settings, I can get convincing reverb with only 64 rays per sound. That's the equivalent of running a high-end shader on the CPU, but with a screen resolution of only 8 by 8 pixels (as opposed to most people's 1920 by 1080) and a framerate cap of 20 FPS. Definitely doable! The difference is that with shaders you need so many rays before it starts to become playable and realistic. But with sound, It's suprising how much immersion I can squeeze out of just a handful of rays!

The second factor that makes the performance so great is the "parallel" part. Parallel Processing (in this case Multithreading) can be tricky to pull off without causing issues. But when done correctly, it allows your CPU to multitask. This means that, depending on your specific processor, you could be tracing a dozen rays or more at the same time! This definitely helps performance, especially for people that have a decent CPU and want to crank up the settings.

Compatibility

Does Resounding work with the sounds in my resource pack?

Answer

Yes.

Does Resounding work with mod X?

Answer

Probably, but compatibility is not guaranteed for all mods. A list of guaranteed compatible mods will be added to the wiki soon™. If you find a compatibility issue, please report it in the issues tab.

Versioning

Note: For the most part, Resounding follows the guidelines of Semantic Versioning. If you have a question that is not answered here, try there. The sections below only cover pre-release versioning. For more info about how versions are released, see the Roadmap

What are Resounding alpha versions?

Answer

This can mean slightly different things for each project, so read carefully. Resounding 1.0.0 alphas (designated 1.0.0-alpha.X) are unstable development versions of the mod. Keep in mind the following about alpha versions:

  • Critical bugs are expected
  • The code will change and update frequently
  • The alpha version is not feature-complete (i.e. it is missing many core features of the release version)
  • User-friendliness is not a concern at this stage, so things like the config may be hard to use or even incomplete.
  • Compatibility with another mod is not guaranteed, regardless of the mod in question.
  • Help and support is not guaranteed.

However, the stability of the alpha versions will gradually improve as they approach a beta, so you might want to judge for yourself when it is stable enough to use for regular gameplay. Also, see the section on Milestone Alphas here for a more stable alternative.

And what about beta versions?

Answer

For the most part, beta versions are just more stable and user-friendly alpha versions. The other major difference is that beta versions are feature complete, so they should have at least basic implementations of every feature planned for that release.

So what are Milestone Alphas?

Answer

A Milestone Alpha, or Beta Candidate, is an alpha version that has all of the qualities of a beta version, but is not feature complete. These are the only alpha versions that I release to CurseForge and Modrinth, since they are so much more stable than other alpha versions. Milestone Alphas can be expected after I finish implementing one major feature of a version, before moving on to the next major feature.

These versions mark a stable "checkpoint" in development, where I can focus on things like user-friendliness and bugs to round out the changes I have just made before I move on. TBH I have never heard of anyone else doing this, but I'm sure something similar has been done before.

To maintain consistent, SemVer-compliant versioning, Milestone Alphas will sequentially take the place of an alpha version, but will use a "bc" version designator (for Beta Candidate) to put them between Alphas and Betas alphabetically.

Versioning example

Example

For example, you might chronologically see a Resounding version scheme such as this:

  • 1.0.0-alpha.1
  • 1.0.0-alpha.2
  • 1.0.0-bc.3
  • 1.0.0-alpha.4
  • 1.0.0-alpha.5
  • 1.0.0-bc.6
  • 1.0.0-alpha.7
  • 1.0.0-beta.1
  • 1.0.0-beta.2
  • 1.0.0-rc.1
  • 1.0.0

Note: for those familiar with snapshots and pre-releases, you can think of alphas/bcs as snapshots, and betas/rcs as pre-releases.

Note: release candidates (designated "rc") are only released a second time if changes must be made to the first one before release.

Note: bc and rc versions are only released for major versions (i.e. X.0.0)

For more info about how versions are released, see the Roadmap

Can I use a build from GitHub Actions?

Answer

Short answer? No. These builds are designed not to work for normal use, and require a secret developer key to use. Not to mention, they are highly unstable and unpredictable. Also, no help and support will be provided for Actions builds, so if your game crashes and you loose all your stuff, consider yourself warned. They should only be used to aid in developing this mod or another. Contact Dr. Rubisco on discord if you are interested in applying for a developer key.