(Dark Souls) Text Overlay
Stream-overlay to include in Dark-Souls sessions for e.g. the number of deaths
An overlay that can be managed via twitch chat or via a password-secured webpage, that e.g. moderators can access and
How to edit the displayed content
You can either define a twitch chat and a command to be used, which then moderators and the broadcaster can use to update the shown content, e.g. using
!overlay 7 deaths.
Alternatively, the page offers a very simplistic, password-protected page, that can be used to update the value as well as configure the font color:
The docker image can be found
Possible environment variables:
DOMAIN: The domain this application is available at, e.g.
IS_SECURE: Whether this application is available as HTTPS / behind an HTTPS reverse proxy (which it should be).
ADMIN_USER: The username to access the dashboard to change the overlay content. Defaults to
ADMIN_PASSWORD: The password to access the dashboard to change the overlay content. Defaults to
definitely want to change that one!
TWITCH_COMMAND_CHANNEL: The name of the twitch channel to listen for commands. If not set, will not listen on any
chats for commands.
TWITCH_COMMAND_PREFIX: The command prefix for updating the content via twitch chat. Defaults to
The data is being persisted in
/var/dark-souls-backend/data. It is advised to map this path as a volume, although not
services: buzzer: image: "flowmo7/dark-souls-overlay:1.0.0" restart: unless-stopped ports: - 8080:8080 #Should be behind an SSL reverse proxy environment: - DOMAIN=dark-souls-overlay.example.org - ADMIN_USER=admin - ADMIN_PASSWORD=S0m3S3cur3P4assw0rd volumes: - /opt/docker/dark-soul-persistence:/var/dark-souls-backend/data:rw #Change host location to your persistence path
Copyright 2021-2022 Florian Mötz Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.