sbundler v1.2.1

A bundler for SB projects.

🏠 Homepage

Install

npm install -g sbundler

Usage

sbundler [output] -s <serverMainName> -c <clientMainName> --no-watermark

Author

👤 romdotdog

• Website: https://rom.dog
• Github: @romdotdog

🤝 Contributing

Contributions, issues and feature requests are welcome!Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📜 Documentation

Logistics

Each project should take place in a separate directory. There should be two files, main.server.lua and main.client.lua. Every filename of the project must be infixed by either server, client, or shared.

API

import(relativePath: string)
--[[
	All paths taken must be part of the directory at which the `sbundler` command has been run.
	They are always relative to the project directory.
]]

on(event: string, callback: anyFunction)
--[[
	This is a wrapper for the RemoteEvent connection.
	`event` can be any string and is transferred through the connection.
]]

onInvoke(event: string, callback: anyFunction, overwrite: boolean | nil)
--[[
	This is a wrapper for the RemoteFunction connection.
	`event` can be any string and is transferred through the connection.

	** There can only be one function per event,
	you can overwrite the current event by using the third argument. **
]]

emit(event: string, ...: any)
--[[
	Emit to the opposing side the information in the variadic argument
	through a RemoteEvent.
]]

invoke(event: string, ...: any)
--[[
	Emit to the opposing side the information in the variadic argument
	through a RemoteFunction.

	** This yields for the return. **
]]


-- // Server API //

-- Whether other players firing the remote are able to trigger
-- a response from the server.
local disallowOtherPlayers: boolean = true

-- The client script instance.
local clientScript: LocalScript


-- // Client API //

-- The server script instance.
local serverScript: Script

📝 License

Copyright © 2021 romdotdog. This project is MIT licensed.

This README was generated with ❤️ by readme-md-generator