packages - Revision history

BlueMountains at 12:14, 11 January 2021

2021-01-11T12:14:25Z

← Older revision		Revision as of 12:14, 11 January 2021
Line 13:		Line 13:

	==Folder layout==		==Folder layout==
	Each package has a folder that is placed inside the '''packages''' folder on your server. Example layout:		Each package has a folder that is placed inside the '''packages''' or inside the '''autostart''' folder on your server. Example layout:
	<pre>		<pre>
	OnsetServer.exe		OnsetServer.exe
Line 33:		Line 33:
	server.lua		server.lua
	</pre>		</pre>

			==autostart==
			Packages can be automatically started on server start. For that to work you must place your package into the '''autostart''' folder. If the folder does not exist, create it at the root where your OnserServer executable is located.

			Notice: [[StartPackage]] will first look into the '''autostart''' folder before looking in the '''packages''' folder.

	==index.lua==		==index.lua==

BlueMountains at 12:11, 11 January 2021

2021-01-11T12:11:41Z

← Older revision		Revision as of 12:11, 11 January 2021
Line 17:		Line 17:
	OnsetServer.exe		OnsetServer.exe
	server_config.json		server_config.json
			/autostart
			/myautostartpackage
			index.lua
			script.lua
	/packages		/packages
	/mypackagename		/mypackagename

BlueMountains at 11:52, 11 January 2021

2021-01-11T11:52:15Z

← Older revision		Revision as of 11:52, 11 January 2021
Line 33:		Line 33:
	The ''index.lua'' is executed before the server loads the ''package.json'' file. In this Lua file you can register scripts and files to this package.		The ''index.lua'' is executed before the server loads the ''package.json'' file. In this Lua file you can register scripts and files to this package.

	The following functions are only available to the ''index.lua'' script. ~~Other server~~ functions are ~~'''not'''~~ exposed to the ''index.lua''.		The following functions are only available to the ''index.lua'' script. Besides that, only Lua library functions are exposed the ''index.lua'' but no other Onset server functions.
	* [[AddServerScript]]		* [[AddServerScript]]
	* [[AddClientScript]]		* [[AddClientScript]]
Line 48:		Line 48:
	</syntaxhighlight>		</syntaxhighlight>

	For the package to work there has to be either an ''index.lua'' or a ''package.json'' config file. Both at the same time are also supported.		For the package to work, there has to be either an ''index.lua'' or a ''package.json'' config file. Both at the same time are also supported.

	==package.json==		==package.json==

BlueMountains at 11:50, 11 January 2021

2021-01-11T11:50:06Z

← Older revision		Revision as of 11:50, 11 January 2021
Line 19:		Line 19:
	/packages		/packages
	/mypackagename		/mypackagename
			index.lua
	package.json		package.json
	/mapeditor		/mapeditor
			index.lua
	package.json		package.json
	/client		/client
Line 27:		Line 29:
	server.lua		server.lua
	</pre>		</pre>

			==index.lua==
			The ''index.lua'' is executed before the server loads the ''package.json'' file. In this Lua file you can register scripts and files to this package.

			The following functions are only available to the ''index.lua'' script. Other server functions are '''not''' exposed to the ''index.lua''.
			* [[AddServerScript]]
			* [[AddClientScript]]
			* [[AddSharedScript]]
			* [[AddFile]]

			<syntaxhighlight lang="Lua">
			--index.lua
			AddServerScript("server/*_s.lua")
			AddClientScript("client/*_c.lua")
			AddSharedScript("shared/*.lua")
			AddFile("audio/sound.mp3")
			AddFile("ui/*.html")
			</syntaxhighlight>

			For the package to work there has to be either an ''index.lua'' or a ''package.json'' config file. Both at the same time are also supported.

	==package.json==		==package.json==
	Your package.json defines server and client script files. It also defines what files are required for this package to work.		Your ''package.json'' defines server and client script files. It also defines what files are required for this package to work.
	Files defined in '''client_scripts''', '''shared_scripts''' and '''files''' are being downloaded by clients once they join the game server.		Files defined in '''client_scripts''', '''shared_scripts''' and '''files''' are being downloaded by clients once they join the game server.

	Lua scripts defined in '''shared_scripts''' are executed on both server and client. The function [[IsServer]] and [[IsClient]] can be used to determine if a script currently runs on the server or client.		Lua scripts defined in '''shared_scripts''' are executed on both server and client. The function [[IsServer]] and [[IsClient]] can be used to determine if a script currently runs on the server or client.

			For the package to work there has to be either an index.lua or a package.json config file. Both at the same time are also supported.

	Wildcards (*) are supported.		Wildcards (*) are supported.
Line 80:		Line 104:

	== Client package cache ==		== Client package cache ==
	Files downloaded from servers are being cached on the client in the folder: '''%~~appdata~~%~~\..\Local~~\Onset\Saved\ServerContent		Files downloaded from servers are being cached on the client in the folder: '''%LocalAppData%\Onset\Saved\ServerContent'''

	That way files are only downloaded once. If you change a file on the server the checksum of it will change. In this case the client will be downloaded again by the client.		That way files are only downloaded once. If you change a file on the server the checksum of it will change. In this case the client will be downloaded again by the client.
	The ''server.json'' file stores information of the server from where the files have been downloaded from.		The ''server.json'' file stores information of the server from where the files have been downloaded from.

BlueMountains at 19:09, 14 December 2020

2020-12-14T19:09:01Z

← Older revision		Revision as of 19:09, 14 December 2020
Line 30:		Line 30:
	==package.json==		==package.json==
	Your package.json defines server and client script files. It also defines what files are required for this package to work.		Your package.json defines server and client script files. It also defines what files are required for this package to work.
	Files defined in '''client_scripts''' and '''files''' are being downloaded by clients once they join the game server.		Files defined in '''client_scripts''', '''shared_scripts''' and '''files''' are being downloaded by clients once they join the game server.

			Lua scripts defined in '''shared_scripts''' are executed on both server and client. The function [[IsServer]] and [[IsClient]] can be used to determine if a script currently runs on the server or client.

			Wildcards (*) are supported.

	<syntaxhighlight lang="json">		<syntaxhighlight lang="json">
	{		{
Line 36:		Line 41:
	"version": "1.0",		"version": "1.0",
	"server_scripts": [		"server_scripts": [
	"server/~~editor~~.lua"		"server/*.lua"
	],		],
	"client_scripts": [		"client_scripts": [
	"client/editor.lua"		"client/editor.lua"
			],
			"shared_scripts": [
			"shared_script.lua"
	],		],
	"files": [		"files": [
Line 47:		Line 55:
	"client/gui/jquery.js",		"client/gui/jquery.js",
	"client/gui/OpenSansRegular.woff2",		"client/gui/OpenSansRegular.woff2",
	"client/gui/OpenSansBold.woff2"		"client/gui/OpenSansBold.woff2",
			"client/gui/images/*"
	]		]
	}		}

BlueMountains at 22:11, 27 October 2020

2020-10-27T22:11:48Z

← Older revision		Revision as of 22:11, 27 October 2020
Line 1:		Line 1:
	A package is collection of Lua scripts and other files. You can have up to 64 packages and 1024 files per package on your server.		A package is collection of Lua scripts and other files. You can have up to 64 packages and 1024 files per package on your server.

	Allowed file type extensions: '''lua, js, css, html, htm, png, jpg, jpeg, gif, svg, wav, mp3, ogg, oga, flac, woff2, ttf, pak, json, map'''		Allowed file type extensions: '''lua, js, css, html, htm, png, jpg, jpeg, gif, svg, wav, mp3, ogg, oga, flac, m4a, woff2, ttf, pak, json, map'''

	Example packages: https://github.com/BlueMountainsIO/OnsetLuaScripts		Example packages: https://github.com/BlueMountainsIO/OnsetLuaScripts

BlueMountains at 11:25, 15 August 2020

2020-08-15T11:25:48Z

← Older revision		Revision as of 11:25, 15 August 2020
Line 1:		Line 1:
	A package is collection of Lua scripts and other files. You can have up to 64 packages and 1024 files per package on your server.		A package is collection of Lua scripts and other files. You can have up to 64 packages and 1024 files per package on your server.

	Allowed file type extensions: '''lua, js, css, html, htm, png, jpg, jpeg, gif, svg, wav, mp3, ogg, oga, flac, woff2, ttf, pak, json'''		Allowed file type extensions: '''lua, js, css, html, htm, png, jpg, jpeg, gif, svg, wav, mp3, ogg, oga, flac, woff2, ttf, pak, json, map'''

	Example packages: https://github.com/BlueMountainsIO/OnsetLuaScripts		Example packages: https://github.com/BlueMountainsIO/OnsetLuaScripts

BlueMountains at 10:57, 14 July 2020

2020-07-14T10:57:52Z

← Older revision		Revision as of 10:57, 14 July 2020
Line 1:		Line 1:
	A package is collection of Lua scripts and other files. You can have up to 64 packages and 1024 files per package on your server.		A package is collection of Lua scripts and other files. You can have up to 64 packages and 1024 files per package on your server.

	Allowed file type extensions: '''lua, js, css, html, htm, png, jpg, jpeg, gif, svg, wav, mp3, ogg, oga, flac, woff2, ttf, pak'''		Allowed file type extensions: '''lua, js, css, html, htm, png, jpg, jpeg, gif, svg, wav, mp3, ogg, oga, flac, woff2, ttf, pak, json'''

	Example packages: https://github.com/BlueMountainsIO/OnsetLuaScripts		Example packages: https://github.com/BlueMountainsIO/OnsetLuaScripts

BlueMountains at 17:24, 8 March 2020

2020-03-08T17:24:03Z

← Older revision		Revision as of 17:24, 8 March 2020
Line 58:		Line 58:
	\|-		\|-
	\|Max packages		\|Max packages
	~~\|32~~
	\|-
	~~\|Max client scripts per package~~
	\|64		\|64
	\|-		\|-
	\|Max client files per package, ~~not~~ including client scripts		\|Max client files per package, including client scripts
	\|~~255~~		\|1024
	\|-		\|-
	\|Max file size		\|Max file size

BlueMountains at 17:23, 8 March 2020

2020-03-08T17:23:35Z

← Older revision		Revision as of 17:23, 8 March 2020
Line 1:		Line 1:
	A package is collection of Lua scripts and other files. You can have up to 32 packages and ~~255~~ files per package on your server.		A package is collection of Lua scripts and other files. You can have up to 64 packages and 1024 files per package on your server.

	Allowed file type extensions: '''lua, js, css, html, htm, png, jpg, jpeg, gif, wav, mp3, ogg, oga, flac, woff2, ttf, pak'''		Allowed file type extensions: '''lua, js, css, html, htm, png, jpg, jpeg, gif, svg, wav, mp3, ogg, oga, flac, woff2, ttf, pak'''

	Example packages: https://github.com/BlueMountainsIO/OnsetLuaScripts		Example packages: https://github.com/BlueMountainsIO/OnsetLuaScripts