WebScriptHook plugin + server

A platform that allows interaction with a running instance of GTAV through a REST API. Extendable through extensions! Includes server and game-side plugin. Inspired by ETS2 Telemetry Server

Features

Second-screen experiences for GTAV through a web interface
Fetching real-time game statistics in JSON format with a GET request
Calling GTAV script native functions with POST requests
Web server included! Drop your HTML and CSS and JavaScript and you are good to go
Extension support allows developers to create extensions to handle more request types. Extensions are stateful and can be ticked with the game
You can easily port an existing ScriptHook V .NET script to a WebScriptHook extension
Includes a "Drive Cars With Your Phone" example extension (frontend and backend)

Installation

Requirements

WebScriptHook

Extract "WebScriptHook" folder to "GTAV/scripts"
The configuration file should be at GTAV/scripts/WebScriptHook/WebScriptHook.ini
The DLLs should be at GTAV/scripts/WebScriptHook/*.dll
The server exe should be at GTAV/scripts/WebScriptHook/webscripthook-server.exe
Run the game

WebScriptHook apps

Running a web app

Start the game
Run "webscripthook-server.exe"
You need to allow the program to communicate through firewall
The default port is 25555. Can be changed in config (restart game and the server to apply)
Open your browser and go to http://localhost:25555 You should see the home page
To access the page from devices on your LAN, replace "localhost" above with the address of your PC. Google "How to find my LAN IP" if you don't know how to do that
There is an Android client app for WebScriptHook

Installing a web app

Drop the folder of a WebScriptHook app under "/apps" folder
If done correctly, the index page of the app should be at /apps/<app name>/index.html
Refresh the webpage

WebScriptHook REST API

WebScriptHook provides a REST API that allows you to pull real-time data from the game, as well as calling native functions remotely!

Pulling some real-time data in JSON format

GET /pull

Calling a native function

POST /input
{
	"Cmd": "native",
	"Arg": "GET_ENTITY_HEALTH", <- Name or hash of the native function
	"Args": ["int", 2]  <- Return type (a string), native function arguments (an int/float/string/bool)
}

See the wiki page for details

WebScriptHook extensions

Installing an extension

Put the extension dll files under "/extensions" folder
WebScriptHook searches for assemblies recursively, so create subfolders if you wish
Extensions will be automatically loaded when WebScriptHook starts

Creating an extension

You can write your own extensions to handle inputs sent through web
Subclass WebScriptHook.Extensions.Extension and override HandleCall method, which is invoked whenever your extension is called through web
Implement WebScriptHook.Extensions.ITickable if you want your extension to be ticked every frame
Your extension can also send stuff back to the caller, whenever HandleCall is called
It's possible to convert an existing ScriptHookVDotNet script to a WebScriptHook extension
See the wiki page for details

Calling an extension through REST API

POST to /input with cmd "extension"
Arg needs to be "assemblyname.namespace.classname". e.g. extension-examples.ExampleExtensions.MyExtension
Args will be used to call the extension

Other notes

Whether you start the game first or the server first does not matter
If things broke, check "GTAV/ScriptHookVDotNet-2016-01-19.log" (replace the date with your current date) for errors