Skip to content

Commit

Permalink
Document the config option to disable sound effects
Browse files Browse the repository at this point in the history
Related: #96
  • Loading branch information
duncanmcclean committed Mar 25, 2024
1 parent ecae3a1 commit f2049a9
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ In your `.env` file, make sure the `pusher` broadcast driver is used:
BROADCAST_DRIVER=pusher
```

Create an app inside your [Pusher account](https://pusher.com).
Create an app inside your [Pusher account](https://pusher.com).

Be sure to enable the "Client Events" setting (under the "App Settings" page in your Pusher App Dashboard).

Expand All @@ -48,6 +48,22 @@ PUSHER_APP_SECRET=
PUSHER_APP_CLUSTER=
```

## Configuration

### Sound Effects

By default, the Collaboration addon plays sound effects when other users join & leave entries.

If you wish to disable these, you may publish the configuration file (via `php artisan vendor:publish --tag=collaboration`) and set `sound_effects` to `false`.

```php
// config/collaboration.php

return [
'sound_effects' => false,
];
```

## Advanced Usage

When the ["meta data"](https://statamic.dev/extending/fieldtypes#meta-data) of a fieldtype is updated, it will be broadcast to the other users in the channel. If you have a fieldtype that contains a large amount of meta data, and it gets updated (some may just provide initial state and never change), you may consider specifying the fields that should be broadcast. This could help keep message sizes smaller and improve performance.
Expand Down

0 comments on commit f2049a9

Please sign in to comment.