diff --git a/public/static/img/mobile.png b/public/static/img/mobile.png index 2f69250..5fa3186 100644 Binary files a/public/static/img/mobile.png and b/public/static/img/mobile.png differ diff --git a/public/static/img/screenshot.png b/public/static/img/screenshot.png index 703113a..885675e 100644 Binary files a/public/static/img/screenshot.png and b/public/static/img/screenshot.png differ diff --git a/screenshot.png b/screenshot.png index d760d7c..386dc6c 100644 Binary files a/screenshot.png and b/screenshot.png differ diff --git a/web/templates/about.html b/web/templates/about.html index 3034eb9..09b6f36 100644 --- a/web/templates/about.html +++ b/web/templates/about.html @@ -12,7 +12,7 @@ -
+

About BareRTC

@@ -47,15 +47,15 @@

Tour of the user interface

-
+
Screenshot of the user interface on desktop
Pictured: Screenshot of the user interface on tablet or desktop-sized screens.

Screenshot of the user interface on mobile @@ -82,9 +82,29 @@ 0 button, which will show the number of watchers inside the button itself. +
    + {{if .Config.PermitNSFW}} +
  • + The + button will toggle the setting on your camera. If you are going to be + behaving sexually on cam, we ask that you please mark your own camera + as 'Explicit' by using this button. The button will illuminate in red + when active, and look like: + +
    • + {{end}} +
  • + You can also see who is Watching your camera by clicking on the "Watching" + tab on the Who's Online list. +
    • +
  • - The Who List shows all of the people who are currently connected + The Who Is Online list shows all of the people who are currently connected to the chat room. The Who List is global to the entire chat - it is the same list of people no matter which Channel you are currently looking at. In the Who List you may also find buttons to open a Direct Message (DM) or tune in to somebody's @@ -94,7 +114,10 @@ - This button will open their profile page, if they have one. + This button will open their profile page, if they have one. The icon may + be color-coded for the user's gender, if available: male, + female, and + non-binary/trans/other.
  • + button at the bottom right corner.

    - It works in these browsers on desktop operating systems (including Windows, - Mac OS and GNU/Linux) as well as on - Android devices. + Reactions added by yourself or others will appear at the bottom of their message. You can + see who reacted by hovering your mouse cursor over the button, or you can 'upvote' their + reaction by clicking on it. +

    + +

    Muting spammy users

    + +

    + If somebody on chat is bothering you, you may mute their messages by clicking + on the red button on their message.

    - Unfortunately, the chat does not work on Apple's mobile - devices such as the iPad and iPhone -- but research on this is underway and hopefully iOS devices - will be supported soon! + While they are muted: +

    + +
      +
    • You will no longer see their future messages in public chat rooms.
      • +
    • You will no longer receive any of their future Direct Messages (DMs).
      • +
    • + They will not be allowed to watch your webcam if you are sharing. The chat + server will lie and tell them your camera isn't even online so they + will not know they had been muted. +
      • +
    + +

    + The mute is temporary and will last for the remainder of your chat + session (until you log off). +

    + +

    Styling Your Messages

    + +

    + BareRTC supports Markdown syntax for your chat messages. You can make text bold + by putting asterisks around part of it, **like this** or make text italic with + *single asterisks*.

    - Feature support matrix of browsers currently tested: + Hyperlinks you paste that begin with https:// will be clickable as-is, or you can create a custom + label for it by typing e.g. [click my link](https://www.wikipedia.org/).

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Device TypeWeb BrowsersChat works?Video works?
    All Desktops Mozilla Firefox✔️✔️
    All Desktops Chromium (Chrome, Edge)✔️✔️
    Mac OS Desktop Safari✔️❌
    Android Mozilla Firefox✔️✔️
    Android Chromium (Vanadium)✔️✔️
    iPhone & iPad All browsers❌❌
    +

    + To learn more about Markdown, please check out the Markdown Guide + website. +

    -

    Webcam sharing

    +

    Video Sharing How-To's

    + +

    About webcam sharing

    The WebRTC technology used by this chat room allows for direct, peer to peer @@ -250,22 +288,200 @@ way so that they may be banned from the chat room.

    -

    Styling Your Messages

    +

    How do I go on video?

    - BareRTC supports Markdown syntax for your chat messages. You can make text bold - by putting asterisks around part of it, **like this** or make text italic with - *single asterisks*. + To share your webcam, click on the green + + button at the top left of the web page. This will open a modal with some options for + your camera: +

    + +
      +
    • + You may start with your microphone muted by default. +
      • + {{if .Config.PermitNSFW}} +
    • + You may mark your camera as "Explicit" to begin with. If you are intending immediately to + behave sexually on camera, please mark this box so that your camera will appear 'red' by + default and other people on chat can know what they're getting into when they click to + watch your camera. +
      • + {{end}} +
    • + You may opt-in to some "mutual webcam settings": +
        +
      • You may require your viewers to also be sharing their own camera first before they can open yours.
        • +
      • You may automatically open your viewer's cameras when they open yours (and they are also broadcasting).
        • +
      +
      • +
    + +

    How do I stop my camera?

    + +

    + When you are broadcasting, the red " Stop" button at the top of the + page will turn your camera off. +

    + +

    How do I mute my camera's microphone?

    + +

    + The button to Mute will be at the top of the page next to the + Stop button. Alternatively, you can click on the microphone inside + your own webcam video preview to toggle the mute that way. Either button works! +

    + +

    How do I see who is watching me?

    + +

    + You may click on the button at the top of the page to see who is watching you. The number inside the + button will be your current number of viewers.

    - Hyperlinks you paste that begin with https:// will be clickable as-is, or you can create a custom - label for it by typing e.g. [click my link](https://www.wikipedia.org/). + You may also click on the Watching tab in the Who's Online list. +

    + +

    How do I stop somebody from watching me?

    + +

    + On the Who's Online list, click on the Watching tab to see who + is currently watching your camera.

    - To learn more about Markdown, please check out the Markdown Guide - website. + To 'boot' somebody off your camera, click on the + + button next to their name. This will kick them off your camera and they will not + be allowed to re-open your cam for the remainder of your chat session. +

    + +

    + To people who have been booted from your camera, the chat server will tell them that + your camera isn't even broadcasting at all! They will see a greyed-out video + button and may think you have simply turned off your camera, and they won't know for + sure that you have booted them! +

    + +

    Supported Browsers

    + +

    + Currently, BareRTC works best on Chromium browsers (including Google + Chrome, Microsoft Edge, Opera, Brave, and other Chromium derivatives) as well as + Mozilla Firefox. +

    + +

    + It works in these browsers on desktop operating systems (including Windows, + Mac OS and GNU/Linux) as well as on + Android devices. +

    + +

    + Feature support matrix of browsers currently tested: +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Device TypeWeb BrowsersChat works?Video works?
    All Desktops Mozilla Firefox
    All Desktops Chromium (Chrome, Edge)
    Mac OS Desktop Safari
    Android Mozilla Firefox
    Android Chromium (Vanadium)
    iPhone & iPad All browsers
    + +
    Apple Safari Browsers
    + +

    + This section applies to web browsers based on Safari, which includes every web + browser on iPad and iPhone. There are some more nuances to the support level of these browsers on + BareRTC. +

    + +

    + The regular chat features (logging in, chatting, sharing pictures) are 100% supported on Safari, + but webcam sharing may be more difficult to get working. On iPad, iPhone, and Safari browsers, + connecting to somebody's webcam may only work correctly if you follow exactly + these steps: +

    + +
      +
    1. + First, you need to share your own local webcam first (by clicking on the green "Share webcam" + button at the top of the chat page). +
      2. +
    2. + Then, you may only be able to view somebody else's camera IF they have marked + the setting "When somebody opens my camera, I also open their camera automatically." +
      3. +
    + +

    + This is because Apple Safari only supports two-directional video calls, which is in contrast to the + way that BareRTC was designed to work: it is intended to be possible that somebody can start their webcam + and be watched by anybody who wants to tune in, without it always needing to be a two-way video call. But + for Apple Safari browsers, uni-directional video channels are not supported, so iPads and iPhones are only + able to successfully connect to a video if that person opts-in to open your video in + return (thus making it a two-way video call). +

    + +

    + For macOS users, it is recommended to use a Chromium or + Firefox browser instead of Safari for the best experience. It is only Safari-based browsers that have + this limitation. Unfortunately, there is no alternative for iPad or iPhone: every web browser on + iOS is based on Safari per Apple's app store guidelines. (Chrome and Firefox on iOS were not allowed to + bring their actual web browser engine to Apple's mobiles).

    Privacy

    @@ -310,4 +526,4 @@ -{{end}} \ No newline at end of file +{{end}}