LordAshes-RemoteControlPlugin icon

RemoteControlPlugin

Allows players to move and rotate minis and the camera in Talespire without using Talespire.

Last updated a week ago
Total downloads 746
Total rating 0 
Categories Tweaks Networked Tools Integration Assets Minis
Dependency string LordAshes-RemoteControlPlugin-2.1.1
Dependants 0 other mods depend on this mod

This mod requires the following mods to function

bbepisTaleSpire-BepInExPack-5.4.10 icon
bbepisTaleSpire-BepInExPack

Unified BepInEx all-in-one modding pack - plugin framework, detour library

Preferred version: 5.4.10
brcoding-SetInjectionFlagPlugin-2.3.0 icon
brcoding-SetInjectionFlagPlugin

Allows players to flag mods are installed

Preferred version: 2.3.0

README

Remote Control Plugin

This unofficial TaleSpire allows players toi move their minis in a Talespire game without having Talespire.

Video Demo: https://youtu.be/aLRPOsEqA0s

This plugin, like all others, is free but if you want to donate, use: http://198.91.243.185/TalespireDonate/Donate.php

Change Log

2.1.1: Replaced web based remote code with improved version provided by Victor Hurtado. No plugin change.
2.1.0: Added support for Talespire Dice rolls (use Auto Roll plugin to auto roll the dice).
2.1.0: Added support for zoom in, zoom out and zoom set.
2.0.0: Fix after BR HF Integration Update.
2.0.0: Added Web Remote. 
1.3.0: Added diagnostic setting for adding additional entries into the logs.
1.3.0: Added TCPSend tool which can be used be external apps to communicate to the plugin.
1.2.0: Added chat feature speaking as the indicated character or GM (if character name is GM).
       This function allows use of chat services such as Chat Roll if installed.
1.1.0: Updated Remote Control App and plugin to support rotation and camera operations.
1.0.0: Initial release

Install

Use R2ModMan or similar installer to install this plugin.

Use R2ModMan to configure optional settings (port) for the plugin.

Usage

This plugin does not provide any way for the players to see the Talespire environment. Typically to get around this the GM would stream a Talespire view for the players. Check out the Stream Views Plugin for the ability to stream different views for the players while still maintaining the GM account view as secret.

To prevent the Remote Controls from controlling both the Player and GM instances of Talespire, the Remote Control Server is started manually by keyboard shortcut (default RCTRL+C). It should be started on the Player instance but not the GM (to prevent players from controlling the GM camera).

Once this is done, the players can launch the Remote Control App. Currently this is a simple Win Forms app.

The player enters the IP address of the GM's machine (that the GM provides to the players) and the port. The default port is 11000 but can be changed using the R2ModMan configuration for the Remote Control Plugin (i.e. the Talespire component run by the GM).

The player then enters the mini name that they wish to control. Typically this would be the name of their own mini.

After that the player can press the directional buttons on the Remote Control App in order to move his/her mini, rotate his/her mini, move the camera, and/or rotate the camwera.

Settings on the remote are provided to determine how much each button press moves, how much each button press rotates, and if the mini is to change facing whem moving.

The RemoteControlApp.exe can be found in the plugins install directory.

Web Control

Within the pack there is also a folder called Remote which contains two files: Remote.html and Request.php These allow the DM to host a web page to allow the use of a web page (as opposed to the Remote Control application) to control minis in the talespire game.

The solution does not provide hosting for the solution. The DM must run a PHP enabled web server in order to host these files and ensure that his/her firewall allows external access to the web server. Windows system typically have IIS installed although in some cases it needs to be turned on. By default IIS does not include a PHP implementation but a free PHP implementation can be added. However, any other PHP enabled web server can be used.

The web page is used similar to the remote control application: user connect to the web page, enter the name of the mini to be controlled and use the arrow keys to control the character or camera.

Chat Function

When using the Chat function, by default, the content will be spoken by the character whose name is in the Remote Control and the results are also written to the log. If the character name is changed to GM on the Remote Control, the message will be sent as the local player (GM or not) and will show up in the chat.

If any Chat Service plugins are installed (such as Chat Roll), the chat content will be processed through these Chat Service plugin. For example, if the Chat Roll plugin is installed, the Remote Control Chat function can be used to make Chat Roll requests.

TCPSend Utility

The TCPSend utility just takes a ip, port and message and sends a corresponding TCP/IP message using those specifications. If generating a TCP/IP message is difficult within an external application but executing command line utilities is not then this unility can be used to make requests to the plugin. The message content is automatically suffixed with a carriage return and new line (required by the plugin). So to send a message, one would do something like:

TCPSend 127.0.0.1 11000 Jon,CHAT,Hello!

Limitations

  1. The Remote Control App has no permission checking. You can use it to control any mini that you know the name of.
  2. The control over the camera is shared between all remotes, thus two or more players can be fighting for control.

Available versions

Please note that the install buttons only work if you have compatible client software installed, such as the Thunderstore Mod Manager. Otherwise use the zip download links instead.

Upload date Version number Downloads Download link  
2022-8-9 2.1.1 54 Version 2.1.1 Install
2022-8-8 2.1.0 21 Version 2.1.0 Install
2022-5-6 2.0.0 244 Version 2.0.0 Install
2022-3-25 1.3.0 138 Version 1.3.0 Install
2022-3-24 1.2.0 30 Version 1.2.0 Install
2022-2-20 1.1.0 114 Version 1.1.0 Install
2022-1-9 1.0.0 145 Version 1.0.0 Install