NeoVariable Server/API

A "cloud variable" solution for ComputerCraft using the modem API. Designed to make net-based apps like multiplayer games easier to code.

Downloads:

Client API:

wget https://raw.githubusercontent.com/LDDestroier/neovari/master/neovari neovari

Server Program:

wget https://raw.githubusercontent.com/LDDestroier/neovari/master/neoserver neoserver

The server does not require the client API.

Documentation:

Make sure a NeoVariable server is set up within modem range. When there's a timeout, the default is to wait for a response for 1 second. Functions So Far:

serverName, serverID = neovari.findServer( number timeout, number/string ID or serverName )

Finds a server, and returns its name, with which you'll use with the other functions. Searches for 'timeout' seconds. If optional argument 'ID' is defined, it will only accept the server with that ID.

neovari.findServerList( number timeout )

Returns a list of servers with their names and IDs. Formatted as such:

{
	[1] = {
		serverName = "Server1",
		id = 1
	},
	[2] = {
		serverName = "Server2",
		id = 2
	}, ...
}

success/modemName = neovari.specifyModem( string_or_peripheral modemPeripheral )

This locks NeoVariable to use one modem, instead of using whatever modem is handy, prioritizing wireless ones. If no arguments are given, NeoVariable will revert back to using whatever wireless modem is handy.

modemName = neovari.getSpecifiedModem()

This gets the specified modem for NeoVariable to use, if one was specified.

Here we get into server functions:

In order to do all sorts of fancy things, you need to set up a neovariable object.

object = neovariable.connectToServer( string serverName, string gameName, string userName, optional_number timeout )

And from there...

success = object.setVariable( string variableName, any variableValue, optional_string userName )

This function sets the variable 'variableName' inside of 'userName' inside of 'gameName' as 'variableName'. Each variable on a NeoVariable server is stored in the following structure:

allVariables = {
  	gameName = {
		userName = {
			variableName = variableValue,
		}, ...
	}, ...
}`

success, variable = object.getVariable( string variableName, optional_string userName )```

This takes the same arguments as neovari.setVariable, except for 'variableValue'. Returns the value of 'variableName' inside of 'userName' inside of 'gameName'.

success = object.setEnvironment( table everyVariable, optional_string userName )```

Sets every variable in 'serverName' in 'gameName' in 'userName' to all the values in 'everyVariable'. The table 'everyVariable' would be in this string-indexed table format:

{
	var1 = "hello ",
	var2 = "world!",
	...
}`

success, environment = getEnvironment( optional_string userName )```

Returns every variable in 'serverName' in 'gameName' in 'userName' in a string-indexed table, like the one above.

success, users = neovari.getUsers( optional_string gameName )

Returns a numerically indexed table containing all users that have variables attached to them.

success = neovari.clearVariable( string variableName, optional_string userName, optional_string gameName )

Sets 'variableName' in 'userName' in 'gameName' in 'serverName' to nil.

success = neovari.clearUser(optional_string userName, optional_string gameName)

Sets every variable belonging to 'userName' to nil, effectively removing that user from 'gameName'.

success = neovari.clearGame()

Removes 'gameName' from 'serverName', along with any users within it.

neovari.queueEvent( string event1, any event2, any event3, ... )

Sends an event + argument list to 'serverName' for use with 'gameName', similar to how os.queueEvent() handles it.

neovari.queuePrivateEvent( string recipientName, string event1, any event2, any event3, ... )

Same as 'neovari.queueEvent', but sends an event that only 'recipientName' will be able to decrypt and receive.

neovari.pullEvent( optional_string eventName )

Receives an event sent by 'neovari.queueEvent' to 'serverName' and 'gameName', similar to how os.pullEvent() handles it. Argument 'eventName' is optional.