Skip to content

dpleshkov/serverlistplus-client

Repository files navigation

ServerList+ Client

Front-end source code for ServerList+.

Installation

To run, you will need Git and Node.js installed.

First, clone the repo

git clone https://github.com/dpleshkov/serverlistplus-client

Then, install dependencies

cd serverlistplus-client
npm install

Then, copy config.example.json to config.json and edit the config file.

Compile the site using

npm run build

Then open public/index.html to see the ServerList+ webpage.

Explanation of config values (do not copy-paste the const config =):

const config = {
    "site": {
        "analytics": {
            // if you want to enable site analytics, set this to true
            // and put your analytics tag in views/index/analytics.ejs
            "enabled": false
        },
        // set to "standalone" if you don't want features like
        // player listing or live view. You won't need an external API
        // server for that. 
        
        // If you want player listing however, you need to set the mode 
        // to "live"
        
        "mode": "standalone",
        "live-api-provider": "wss://starblast.dankdmitron.dev/",
        "static-api-provider": "https://starblast.dankdmitron.dev/"
    }
}

About

Front-end source code of ServerList+, a third-party tool for listing player and system data of active starblast.io games

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published