RPCPlugin
This is a developer tool to send network messages over RPC
Date uploaded | 2 years ago |
Version | 1.0.1 |
Download link | HolloFox_TS-RPCPlugin-1.0.1.zip |
Downloads | 2565 |
Dependency string | HolloFox_TS-RPCPlugin-1.0.1 |
This mod requires the following mods to function
bbepisTaleSpire-BepInExPack
Unified BepInEx all-in-one modding pack - plugin framework, detour library
Preferred version: 5.4.10README
RPC Plugin
This is a plugin for TaleSpire using BepInEx.
Install
Currently you need to either follow the build guide down below or use the R2ModMan.
Usage
Reference this dependency plugin in the parent plugin and then use the following syntax to add a chat service:
RPCManager.AddHandler(serviceKey, handler)
Where the service key is a string that must appear at the beginning of the rpc message in order to trip the corresponding handler.
Where hander is a function that takes in two string, the message content and the sender, and a source which is a ChatSource enumeration indicating if the source if a GM message, player message or creature message. The handler returns a string for Interface compatibility.
An example of adding a inline handler for "/w" function would be:
RPCManager.AddHandler("/w", (chatMessage, sender, source)=> { Debug.Log(sender+" whispered "+chatMessage); });
An example of removing a inline handler for "/w" function would be:
RPCManager.RemoveHandler("/w");
Usage programatically
RPCManager.SendMessage(message, sender);
Where message is the content to be sent and should include the handling prefix.
Where sender is the NGuid of either a creature mini (CreatureId) or player (PlayerId).
For example, to use the above hander for "/doSomething" assuming it is a whisper message to the GM:
RPCManager.SendMessage("/doSomething{\"I'm a\": \"json\"}", LocalPlayer.Id.Value)
Compiling
* BepInEx.dll (Download from the BepInEx project.)
* Bouncyrock.TaleSpire.Runtime (found in Steam\steamapps\common\TaleSpire\TaleSpire_Data\Managed)
* UnityEngine.dll
* UnityEngine.CoreModule.dll
* UnityEngine.InputLegacyModule.dll
* UnityEngine.UI
* Unity.TextMeshPro
* Newtonsoft.Json
* Photon
Build the project.
Browse to the newly created bin/Debug
or bin/Release
folders and copy the RPCPlugin.dll
to Steam\steamapps\common\TaleSpire\BepInEx\plugins
Changelog
- 1.0.1: Fix HideVolume recognition
- 1.0.0: Slight Optimization, Official Release
- 0.9.5: Updated depended dll
- 0.9.4: Hide Volume Support and Parallelization
- 0.9.3: Refactor RPCManager to Static class
- 0.9.2: Use SourceRoll.dll and implement static methods
- 0.9.1: remove logging
- 0.9.0: Alpha release
Shoutouts
Shoutout to my Patreons on https://www.patreon.com/HolloFox recognising your mighty contribution to my caffeine addiciton:
- John Fuller
- Tales Tavern - MadWizard