Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
IconPippi committed Apr 22, 2023
2 parents aa9c9d3 + fe18c56 commit 2eed94c
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 4 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 IconPippi

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# MockMessagingService
This Roblox Studio plugin provides a local alternative to the MessagingService Roblox API.
This Roblox Studio plugin provides a localhost alternative to the MessagingService Roblox API.
It is currently impossible to communicate across locally-running Roblox servers on your machine through the provided MS API, unless you were to create a secondary place under the same universe of your main one. This, however did not cover my specific use case and I therefore decided to engineer a hacky alternative.

## Installation
Expand Down Expand Up @@ -38,10 +38,11 @@ Received data: Hello world!
```

## How it works
MockMessagingService takes advantage of the plugin `settings.json file`. The service writes incoming topic messages in specific setting fiels, and at the same time it listens for any changes to the fields of subscribed topics so it can relay them to the game. Communication between the plugin and game scripts is achieved through `BindableEvents`.
MockMessagingService takes advantage of the plugin `settings.json` file. The service writes incoming topic messages in specific setting fiels, and at the same time it listens for any changes to the fields of subscribed topics so it can relay them to the game. Due to this file being shared across all active Roblox Studio instances, data is able to travel across the sandbox boundaries.
Communication between the plugin and game scripts is achieved through `BindableEvents`.

## Building and contributing
This project uses Rojo to manage its structure and perform builds.
Use this bash command to quickly deploy the plugin in your Roblox Studio environment:

`rojo build -o $LOCALAPPDATA/Roblox/Plugins/MockMessagingService.rbxm`
Use this bash command to quickly deploy the plugin in your Roblox Studio environment:
`rojo build -o $LOCALAPPDATA/Roblox/Plugins/MockMessagingService.rbxm`

0 comments on commit 2eed94c

Please sign in to comment.