diff --git a/README.md b/README.md index 940b88f223c6288a97dce9ddb5206fec9b40ec67..67a52627cf5faf2b1cffa111d3f114fbb5b00a64 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ A bridge between [Matrix](http://matrix.org/) and [Discord](https://discordapp.c Currently the bridge is in **Beta** and quite usable for everyday bridging, with one or two bugs cropping up. - + ## Helping out @@ -88,8 +88,8 @@ file. The metrics will be reported under the URL provided in the registration fi #### 3PID Protocol Support This bridge support searching for rooms within networks via the 3pid system -used in clients like [Riot](https://riot.im). Any new servers/guilds you bridge -should show up in the network list on Riot and other clients. +used in clients like [Element](https://element.io). Any new servers/guilds you bridge +should show up in the network list on Element and other clients. ### Setting up Discord @@ -99,7 +99,7 @@ should show up in the network list on Riot and other clients. * Give this link to owners of the guilds you plan to bridge. * Finally, you can join a room with ``#_discord_guildid_channelid`` * These can be taken from the url ("/$GUILDID/$CHANNELID") when you are in a channel. - * Riot (and other clients with third party protocol support) users can directly join channels from the room directory. + * Element (and other clients with third party protocol support) users can directly join channels from the room directory. * You can use Webhooks to make messages relayed by the bridge not nested by the bot user. This will also display the avatar of the user speaking on matrix with their messages. * The bot should create this automatically, but if not perform the following: * Enable ``Manage Webhooks`` on the role added by the bot. diff --git a/config/config.sample.yaml b/config/config.sample.yaml index 9f66f8f35ebdd7697fd0fb10b6ce5d8cc095c504..a4ea82d9e0685b275171ff9adf09b8a7effcf7d4 100644 --- a/config/config.sample.yaml +++ b/config/config.sample.yaml @@ -1,11 +1,11 @@ -# This is a sample of the config file showing all avaliable options. +# This is a sample of the config file showing all available options. # Where possible we have documented what they do, and all values are the # default values. bridge: # Domain part of the bridge, e.g. matrix.org domain: "localhost" - # This should be your publically facing URL because Discord may use it to + # This should be your publicly-facing URL because Discord may use it to # fetch media from the media store. homeserverUrl: "http://localhost:8008" # The TCP port on which the appservice runs on. @@ -40,7 +40,7 @@ auth: # This MUST be a string (wrapped in quotes) clientID: "12345" botToken: "foobar" - # You must enable "Privileged Gateway Intents" in your bot settings on discord.com (e.g.g https://discord.com/developers/applications/12345/bot) + # You must enable "Privileged Gateway Intents" in your bot settings on discord.com (e.g. https://discord.com/developers/applications/12345/bot) # for this to work usePrivilegedIntents: false logging: @@ -86,14 +86,14 @@ channel: unsetRoomAlias: true # Remove the room from the directory. unlistFromDirectory: true - # Set the room to be unavaliable for joining without an invite. + # Set the room to be unavailable for joining without an invite. setInviteOnly: true # Make all the discord users leave the room. ghostsLeave: true limits: # Delay in milliseconds between discord users joining a room. roomGhostJoinDelay: 6000 - # Lock timeout in milliseconds before seinding messages to discord to avoid + # Lock timeout in milliseconds before sending messages to discord to avoid # echos. Default is rather high as the lock will most likely time out # before anyways. # echos = (Copies of a sent message may arrive from discord before we've diff --git a/docs/howto.md b/docs/howto.md index cbdee791fc771018dbbf0481cb07da5d15c3357b..5190207effcb615a53add6ec4306e1f69d1060a0 100644 --- a/docs/howto.md +++ b/docs/howto.md @@ -19,7 +19,7 @@ is formatted as https://discordapp.com/channels/``guildid``/``channelid`` * Run ``npm run adminme -- -h`` for usage. Please note that `!AbcdefghijklmnopqR:example.com` is the internal room id and will always begin with `!`. -You can find this internal id in the room settings in Riot. +You can find this internal id in the room settings in Element. ### Migrate to postgres from sqlite * Stop the bridge.