forked from
tokono.ma/diffuse
A music player that connects to your cloud/distributed storage.
feat: add llms.txt
+29
+2
_config.ts
+2
_config.ts
+27
src/llms.txt
+27
src/llms.txt
···
1
+
# Diffuse
2
+
3
+
Diffuse is a few things:
4
+
5
+
- A collection of custom DOM elements (aka. web components) that allow you to build an audio player, do audio metadata processing, list audio files and streams from various sources/apis/servers, define how to save or sync user-data, etc.
6
+
- A HTML loader that loads "interfaces" from the local user-data cache, the default set from Diffuse, HTTP(S) URLs, or [AT Protocol](https://atproto.com) URIs. When you load an interface, it's supplied with optional "features", from your configured storage, which are also pieces of HTML. These pieces are called "facets".
7
+
- A default configuration of the custom elements that's called "the foundation". This is used throughout the default set of facets. This foundation is configured so that the facets can communicate across tabs/frames; this is done by setting the element's `group` attribute.
8
+
- A collection of data schemas in the form of atproto [lexicons](https://atproto.com/specs/lexicon). These live in the `definitions` directory.
9
+
10
+
11
+
12
+
## Details
13
+
14
+
- Custom elements live under the `components` directory. The elements [page](./elements/) lists all the custom elements along with a description. It also has links to the script for each element.
15
+
- Interface facets are loaded by the loader that lives under the `l` directory. It supports various query parameters:
16
+
* `uri`: Load from HTTP(S) or the AT Protocol (`at` scheme)
17
+
* `id`: Load from local user-data storage cache (indexedDB)
18
+
* `path`: Load from default Diffuse set, path to HTML file in the project.
19
+
- Feature facets that are enabled in the user's storage are loaded automatically before any interface is loaded through the loader.
20
+
- Elements that are configured to be part of a `group` use a `BroadcastChannel` to communicate and/or use a `SharedWorker`.
21
+
- Data schemas are originally defined as lexicon JSON files. From this Typescript files/types are generated.
22
+
23
+
24
+
25
+
## Instructions
26
+
27
+
- When you're asked to build an "interface", that would be a facet of the `interactive` kind. Similarly, when asked to build a "feature", you'd create a facet of the `prelude` kind.