Files
truecharts/charts/stable/muse/docs/installation_notes.md
StevenMcElligott 892cff30a7 feat(muse): Update common / move to stable (#8923)
**Description**

Since it's missing from the catalog and the `incubator` version was
working took the opportunity to fix common and move it to stable. Not
exactly the worlds most complicated chart to port so might as well have
one less to do

⚒️ Fixes  #8909

**⚙️ Type of change**

- [x] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [x] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->

**📃 Notes:**
<!-- Please enter any other relevant information here -->

**✔️ Checklist:**

- [x] ⚖️ My code follows the style guidelines of this project
- [ ] 👀 I have performed a self-review of my own code
- [ ] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made corresponding changes to the documentation
- [x] ⚠️ My changes generate no new warnings
- [ ] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [x] ⬆️ I increased versions for any altered app according to semantic
versioning

** App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._
2023-05-15 10:02:41 +02:00

1.5 KiB

Installation Notes

  • Discord Token can be acquired here by creating a 'New Application', then going to 'Bot'.
  • Spotify Client Id and Spotify Client Secret can be acquired here with 'Create a Client ID'.
  • Youtube API Key can be acquired by creating a new project in Google's Developer Console, enabling the YouTube API, and creating an API key under credentials.

Optionally you can enable the advanced settings and set the following:

  • Cache Limit can accept MB or GB string values for example: 512MB or 10GB.
  • Bot Status has list of values for the discord bot:
    • Online
    • Away
    • Do not Disturb
  • Bot Activity Type has list of values for the discord bot:
    • Playing
    • Listening
    • Watching
    • Streaming
  • Set Bot Activity to whatever you want that follows the activity type.
  • If you plan to publicly share your bot with more servers other than your own, its recommended by the upstream project to set Register Commands On Bot to true if its more than 10 guilds. The bot is purpose built to support multiple servers.

:::note

If Bot Activity Type set to Streaming then Bot Activity URL will be shown and is required to be set by adding either a youtube or twitch stream url.

:::

Once installed, check the app logs to get the discord invite link that auto-generated and then invite the bot into your server.

The bot will play music only in voice channels.