Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SoundInstances page #174

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

SoundInstances page #174

wants to merge 11 commits into from

Conversation

JR1811
Copy link
Contributor

@JR1811 JR1811 commented Aug 27, 2024

From Issue #70

Content

This page is split into several parts.

  1. again, preparing sound files for SoundInstances
  2. using basic SoundInstances
  3. Advanced SoundInstance usage example

The page first explains how to create and use simple SoundInstances and then shows an example of how to make a sound system, which can modulate e.g. its volume and pitch based on the current sound phase and connected BlockEntity values.

Problems & Questions

The current page has not been cleaned up and spellchecked yet. The main reason I'm PRing this now is to ask for opinions.
I was about to delete the 3rd section (starting from the Advanced SoundInstances header) because of the scope of this topic. But it shows how abstract systems can be created. I'm pretty sure this "huge" in-depth example does not belong in the Fabric Docs, but I wanted to hear other opinions before I scrap all of that again.

The Choices before I move into the clean-up phase:

  • keep the current example in (with clean-up etc. afterwards)
  • massively shrink down / rework the example by losing most of the abstractions and inheritance
  • take the whole example out, only the basic SoundInstance usage is needed

This page uses but does not cover BlockEntities and custom S2C networking. Those should be handled on separate pages.

@JR1811 JR1811 requested a review from a team as a code owner August 27, 2024 12:24
Copy link

netlify bot commented Aug 27, 2024

Deploy Preview for nimble-elf-d9d491 ready!

Name Link
🔨 Latest commit 7373dfc
🔍 Latest deploy log https://app.netlify.com/sites/nimble-elf-d9d491/deploys/66cdce73c32f530008d90f6f
😎 Deploy Preview https://deploy-preview-174--nimble-elf-d9d491.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@IMB11 IMB11 added new-content A new page or set of pages stage:cleanup This should be cleaned up labels Aug 27, 2024
@Tewxx
Copy link

Tewxx commented Sep 16, 2024

I this is is well written and should be added

@its-miroma its-miroma added stage:verification This should be verified and removed stage:cleanup This should be cleaned up labels Oct 14, 2024
@its-miroma its-miroma linked an issue Oct 17, 2024 that may be closed by this pull request
@JR1811
Copy link
Contributor Author

JR1811 commented Dec 19, 2024

Just wondering. Has anyone checked this yet?
If it's in a usable state, ill clean it up / continue working on it.

Otherwise, we can just get rid of this page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-content A new page or set of pages stage:verification This should be verified
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Developer Guides: SoundInstances
4 participants