-
Notifications
You must be signed in to change notification settings - Fork 0
Setup: Local (Advanced)
- Server that needs to be running locally. This is the source of truth for the data and communicates with both the overlay and the user script that gets the data from Buckler.
- User script that needs to be installed with your favourite script runner. This sends fresh data to the running server periodically (every 2 minutes but this can be configured). You need to be on the required page for the user script to run and send data to the server.
- Website/Overlay that is hosted, but you can also run this locally. This is the browser source that you load into OBS. It communicates with the server running on your computer.
The following instructions are developer-related. For more comprehensive instructions, see the AppWrite option on the right. The user script and overlay behave similarly so you may find this useful.
In your terminal, cd into the ./server directory and install the project dependencies:
npm install
Run the server using the following command:
npm start
This will run the server on port 55743.
You can configure the following:
| Key | Type | Description |
|---|---|---|
| host | string | URI-encoded IP address of the server to connect to including port, e.g. 0.0.0.87:55743 would be 0.0.0.87%3A55743
|
You can use the hosted version of the client here, or you can run the client locally by serving the ./client directory by running the following command:
npm run client
If you're using the linked URL, that's to my website which can change at any point. I try not to break things, but that's not guaranteed.
If you're using the local user script, you may have to set your browser to allow unsafe content. To do this in Chrome, go into the Site settings, and set Insecure content to Allow.
Install the user script at ./scripts/sf6-rank-watchrrr.local.user.js.