Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.59 KB

README.md

File metadata and controls

28 lines (21 loc) · 1.59 KB

Blackprint - Remote Control

This module will provide an ability for Blackprint to control engine remotely and can be used for multi-user collaboration

Not for production!
Please remove this feature if you're going to ship your product, unless you know what you're doing. This module gives ability to remotely control your software, you will need a sandboxed environment and permission based system in order to ship to production..

Any ports data flow for sketch will be disabled if it's connected to remote engine. It's not recommended to combine different data flow between remote <~> remote in just one instance, you should create two different instance for them and use feature from other module/library to sync data between the two instance itself.

Security notes

  • Blackprint.Environment data must be protected by adding connection rules, you must only allow the environment node to be connected to known namespace. It's required to forbid unexpected connection to logger node that can synced throught any user connected to the remote, or the environment data was connected to nodes that transmit your data to third party. You also need to only use trusted module.
Blackprint.Environment.import({
	DISCORD_TOKEN: process.env.DISCORD_TOKEN,
});

// Add rule for environment node connection
Blackprint.Environment.rule('DISCORD_TOKEN', {
	// Allow specific node only to get value from this environment variable
	allowGet: ['Discord/Connection/WebSocket', 'Discord/Connection/REST'],

	// Disallow any node to set value for this environment variable
	allowSet: [],
});

License

MIT License