Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/FoxxMD/multi-scrobbler. Scrobble plays from multiple sources to multiple clients docs.multi-scrobbler.app
Something went wrong. Try again.
7.5 kB · 131 lines
MDX
at queueNext
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131import Tabs from '@theme/Tabs';import TabItem from '@theme/TabItem';import CodeBlock from '@theme/CodeBlock';import ExplorerFetch from '@site/src/components/Schema/ExplorerFetch';import EditorFetch from '@site/src/components/Schema/SchemaEditorFetch';import './GenericConfiguration.scss';import FileConfigExample from './FileConfigExample';import {useWindowSize} from '@docusaurus/theme-common';
<Tabs groupId="configType" queryString> <TabItem value="env" label="ENV"> <EnvType> {props.children}
_**Bold/Italic**_ = Required </EnvType> </TabItem> <TabItem value="file" label="File"> <FileType> <div className="schemaWrapper" style={{ display: "flex" }} > <div style={{ padding: '0 1em 0 1em', flexBasis: 'min-content', flexGrow: 2}}> <DetailsAdmo type="note" summary="Config Structure"> This displays the **structure** of the [File Configuration](/configuration?configType=aio#configuration-types) for a <strong children={props.name}/> type <strong children={props.client ? 'Client' : 'Source'}/> with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config. </DetailsAdmo> <ExplorerFetch name={`schemas/${props.name}-${props.client ? 'client' : 'source'}`} /> </div> <div style={{ flexBasis: 'auto', flexGrow: 3 }}> <div className="fileEditor"> <DetailsAdmo type="note" summary="Config Example"> This displays an **example config file** of a <strong children={props.name}/> <span children={props.client ? 'Client' : 'Source'}/> [File Configuration](/configuration?configType=aio#configuration-types) that adheres to the shown **Config Structure**.
* **text** mode lets you edit the JSON directly. * **tree** mode gives you a guided point-and-click editing experience that always keeps the JSON *syntax* valid.
Both modes **validate** that the configuration is correct. Any errors show up as squiggly lines.
<span style={{display: props.ambiguous === true ? 'inherit' : 'none'}}> :::important
Only <strong children={props.client ? 'client' : 'source'}/> <span children={props.name}/> configs will validate correctly in the editor but *both* **source** and **client** <span children={props.name}/> configs are allowed in the real <code>CONFIG/<span children={props.name}/>.json</code>
::: </span>
After you finish editing, switch to **text** and then copy all text to get a completed config. </DetailsAdmo> <DetailsAdmo type="important" summary="configureAs Required" render={props.configureAs === true}> When configuring a <span children={props.name}/> **Source** in a **File** Config you **must** set ``` "configureAs": "source" ```
Without this property, Multi-Scrobbler will assume the config is for a <span children={props.name}/> **Client** config.
This requirement does not apply to **AIO** <span children={props.name}/> configs. </DetailsAdmo > </div> <div className="fileEditorMobile"> <DetailsAdmo type="warning" summary="Config Example Mobile Experience"> This displays an **example config file** of a <strong children={props.name}/> <span children={props.client ? 'Client' : 'Source'}/> [File Configuration](/configuration?configType=aio#configuration-types) that adheres to the shown **Config Structure**.
The example config file editor is meant for a larger screen experience so **only the read-only example is shown.** Please use this site on a tablet/laptop/desktop to enable file editor features. </DetailsAdmo> </div> <FileConfigExample filePathName={`CONFIG/${props.name}.json`} configureAs={props.client ? 'client' : 'source'} data={props.fileContent} schemaName={`${props.name}-${props.client ? 'client' : 'source'}`} readOnlyAtWidth={500} /> </div> </div> </FileType> </TabItem> <TabItem value="aio" label="AIO"> <AIOType> <div className="schemaWrapper" style={{ display: "flex" }} > <div style={{ padding: '0 1em 0 1em', flexBasis: 'min-content', flexGrow: 2}}> <DetailsAdmo type="note" summary="Config Structure"> This displays the **structure** of the [all-in-one (`config.json`) configuration](/configuration?configType=aio#configuration-types) with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config.
Select the <strong children={props.name}/> type from the respective <code children={props.client ? 'clients' : 'sources'}/> node below, then expand it. </DetailsAdmo> <ExplorerFetch name={`schemas/aio`} /> </div> <div style={{ flexBasis: 'auto', flexGrow: 3 }}> <div className="fileEditor"> <DetailsAdmo type="note" summary="Config Example"> This displays an **example config file** of a [all-in-one (`config.json`) configuration](/configuration?configType=aio#configuration-types) that includes a <strong children={props.name}/> <span children={props.client ? 'Client' : 'Source'}/> that adheres to the shown **Config Structure**.
* **text** mode lets you edit the JSON directly. * **tree** mode gives you a guided point-and-click editing experience that always keeps the JSON *syntax* valid.
Both modes **validate** that the configuraion is correct. Any errors show up as squiggly lines.
After you finish editing, switch to **text** and then copy all text to get a completed config. </DetailsAdmo> </div> <div className="fileEditorMobile"> <DetailsAdmo type="warning" summary="Config Example Mobile Experience"> This displays an **example config file** of a [all-in-one (`config.json`) configuration](/configuration?configType=aio#configuration-types) that includes a <strong children={props.name}/> <span children={props.client ? 'Client' : 'Source'}/> that adheres to the shown **Config Structure**. The example config file editor is meant for a larger screen experience so **only the read-only example is shown.** Please use this site on a tablet/laptop/desktop to enable file editor features. </DetailsAdmo> </div> <FileConfigExample filePathName={`CONFIG/config.json`} configureAs={props.client ? 'client' : 'source'} data={props.fileContent} schemaName="aio" name={props.name} readOnlyAtWidth={500} aio /> </div> </div> </AIOType> </TabItem></Tabs>