DOCSEARCHbyAlgolia
Submit Docs

TwiWorks Documentation

website·Indexed 31 days ago

https://docs.h2cstudios.com

Documentation for TwiWorks, an Unreal Engine plugin for Twitch integration. Includes guides on installation, login backends, chat interaction, command systems, and a comprehensive reference for events and nodes in the 2.0 release.

Tokens
18.6K
Snippets
35
Records
173
Agent score
50%

What's inside TwiWorks

  1. Overview of RSSFeeder for Unreal Engine

    RSSFeeder is a plugin for Unreal Engine 4 and 5 that enables developers to integrate RSS feeds and fetch news articles directly within the engine using Blueprints. It is primarily used to bring external content such as devlogs, update news, and website articles into a game.

  2. Overview of NetShield Managed Workflow

    NetShield's managed workflow automates the management of TCP/TLS connections. It is important to note that NetShield does not provide a high-level protocol on top of TCP/TLS; it operates at the transport layer. Consequently, messages may be split at boundaries, and developers are responsible for implementing their own application-level protocol to handle message framing and parsing.

  3. Overview of NetShield capabilities

    NetShield is a library for Unreal Engine that enables the use of SSL/TLS, TCP sockets, AES, SHA, and BASE64 directly within Blueprints.

  4. Overview of TwiWorks for Unreal Engine

    TwiWorks is a Twitch integration plugin for Unreal Engine 4 and 5 designed to create interactive social experiences. It provides built-in functionality for handling Twitch commands, cheering, chat messages, and other livestream interactions. Common use cases include 24/7 automated streams, chat-driven gameplay, and virtual streamers.

  5. Overview of NetDB PostgreSQL Plugin

    NetDB is a PostgreSQL plugin designed for Unreal Engine that enables communication with a PostgreSQL database using blueprints.

  6. Overview of TwiWorks Local Twitch Login

    Local Twitch Login (introduced in TwiWorks v1.0.14) allows applications to authenticate Twitch users by starting an embedded local web server that uses the OAuth Implicit Flow. This removes the need for a hosted backend.

    Important Constraints:

    • Recommended Use: Small number of users, highly customized streamer overlays, virtual productions, or internal tools.
    • Not Recommended For: General public distribution. Local web servers may be blocked by firewalls/antivirus or conflict with other applications using the same port.
    • Status: Experimental; unpredictable behavior may occur, and it is not currently recommended for production use.

  7. Overview of uattool

    uattool is a command-line tool that detects installed versions of Unreal Engine on a system. It acts as a wrapper for RunUAT.bat, allowing developers to build games, plugins, and cook content by specifying the engine version instead of providing the full path to the RunUAT.bat script for every execution.

  8. Overview of ConfigBP for Unreal Engine

    ConfigBP is a blueprint library for Unreal Engine that enables developers to read and write 11 different data types from .ini configuration files. It supports interaction with both custom configuration files and standard engine files, such as Scalability.ini and Game.ini.

  9. Understand the Bare-bones Workflow for TCP sockets

    The 'Bare Bones' workflow provides direct control over TCP and secured TCP sockets. Unlike the managed approach, this workflow requires the developer to manually handle socket lifecycles. Key responsibilities include explicitly closing sockets and verifying that data is available to be read before attempting a read operation. Failure to manage these tasks can lead to game hangs or crashes. This workflow is recommended only for developers with experience in POSIX sockets.

  10. Choose between Managed and Bare Bones socket workflows in NetShield

    NetShield provides two distinct approaches for interacting with a server via sockets.

    1. Managed Workflow (Recommended): Handles the TCP/TLS connection automatically. It creates the socket in a separate task or thread and notifies the application when new data is available for processing. This is the easiest and safest method for most developers.
    2. Bare Bones Workflow (Advanced): Provides direct access to socket operations. The developer is responsible for manually ensuring data availability before reading, closing the socket, and managing the connection lifecycle. This approach requires a strong understanding of POSIX sockets, as errors can lead to application hangs or crashes.

  12. Prevent SQL injection using Prepared Queries in NetDB

    Prepared Queries mitigate the risk of SQL injection by separating the SQL command from user-provided values. This ensures that user input cannot be executed as SQL code, protecting the database from unauthorized data exposure or deletion.