xonotic-server-info-page

An easy to configure informational page for your Xonotic game server

🔗 live demo

Features

• Live server information (polls the master server every 30 seconds)
• Multi-server support
• Configurable Maplist
• IRC widget
• News page (blog)
• Themes
• Custom Pages
• Content written in Markdown

Quick Start

1. Fork this repository
2. Edit config/site.js with your server information (this can be generated with the GUI and exported as a zip)
3. Edit config/manifest.js to define your map list and link to blog posts
4. To edit pages, edit the existing files in resources/data/pages
5. To write blog posts, add markdown files to resources/data/blog, be sure to include them explicitly in config/manifest.js

Tips

You can host this on github.io:

• As an organization: create a <organization>.github.io repository within that organization (recommended)
• As a user: by create a gh-pages branch in your fork

You can use the github interface to write blog posts, and maintain the site.

Modifying Content

All content is written in markdown files that are parsed into HTML at runtime. You can add/edit/delete pages and posts this way. The site doesn't know about your markdown files (pages and posts) unless they are specified in the config/manifest.json file.

HTML is allowed in markdown files, in fact, this site uses some you should consider "reserved". Currently the assumption is that all these pages except "about" exist (this will be more configurable in the future). Additional pages are possible.

Advanced Configuration

The configuration is defined in two files, options.json and config/manifest.json. These can be created with the GUI editor, or written by hand.

While these files below contain comments for reference, JSON does not support comments. *Do not use comments in your .json files or the site will not work.

config/options.json:

This file defines site configuration options.

{

    // the remote address where a qstat xml can be returned
    qstatAddress: 'http://dpmaster.deathmask.net/?&xml=1&showplayers=1',

    // local or remote for bspname.jpg
    mapshotDir: 'http://xonotic.co/resources/mapshots/maps/',
    
    // theme (can be overriden by user's choice if switcher is enabled)
    theme: 'default',

    // IRC channel
    ircChannel: 'smb',

    // if true, the chat iframe will be loaded only when requested
    enableLoadChatButton: true,

    // this allows users to choose their own theme (uses a cookie)
    enableThemeSwitcher: true,
    
    // allow for devmode
    enableEditor: true,

    // debug options in developer mode
    editorOptions: {

        // used for development / debugging
        useLocalXML: false,

        // where is it located?
        qstatLocalXML: 'resources/data/qstat.xml'

    }

}

config/manifest.json:

This file contains information about servers, pages, posts and themes.

{

    // Game Server config
    servers: [
        {
            id: 'insta',
            address: '96.44.146.149',
            port: '26010',
            game: 'xonotic',
            // list of bsp names
            mapList: [
                'swing',
                'boxflip',
                'accident_minsta',
            ]
        },
        {
            id: 'kansas',
            address: '96.44.146.149',
            port: '26000',
            game: 'xonotic',
            mapList: [
                'vinegar_v3',
                'dance_nex',
                'accident_v3',
                'battlevalentine',
                'furious',
                'gforce2',
                'got_wood',
                'gothic_block'
            ]
        }
    ],

    // id should be alphanumeric only, no duplicates
    // content refers to the .md file in resources/data/pages
    // icon is a font awesome icon
    pages: [
        {
            id: 'servers',
            title: 'Servers',
            content: 'servers',
            icon: 'list'
        },
        {
            id: 'about',
            title: 'About',
            content: 'about',
            icon: 'info-circle'
        },
        {
            id: 'maplist',
            title: 'Maplist',
            content: 'maplist',
            icon: 'map-o'
        },
        {
            id: 'chat',
            title: 'Chat',
            content: 'chat',
            icon: 'comment'
        },
        {
            id: 'news',
            title: 'News',
            content: 'news',
            icon: 'newspaper-o'
        }
    ],

    // list the posts you'd like to show here
    // latest first
    posts: [
        'second-post',
        'first-post'
    ],

    // Define Themes
    themes: {

        "default": "//maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css",
        "cerulean" : "//bootswatch.com/3/cerulean/bootstrap.min.css",
        "cosmo" : "//bootswatch.com/3/cosmo/bootstrap.min.css",
        "cyborg" : "//bootswatch.com/3/cyborg/bootstrap.min.css",
        "darkly" : "//bootswatch.com/3/darkly/bootstrap.min.css",
        "flatly" : "//bootswatch.com/3/flatly/bootstrap.min.css",
        "journal" : "//bootswatch.com/3/journal/bootstrap.min.css",
        "lumen" : "//bootswatch.com/3/lumen/bootstrap.min.css",
        "paper" : "//bootswatch.com/3/paper/bootstrap.min.css",
        "readable" : "//bootswatch.com/3/readable/bootstrap.min.css",
        "sandstone" : "//bootswatch.com/3/sandstone/bootstrap.min.css",
        "simplex" : "//bootswatch.com/3/simplex/bootstrap.min.css",
        "slate" : "//bootswatch.com/3/slate/bootstrap.min.css",
        "spacelab" : "//bootswatch.com/3/spacelab/bootstrap.min.css",
        "superhero" : "//bootswatch.com/3/superhero/bootstrap.min.css",
        "united" : "//bootswatch.com/3/united/bootstrap.min.css",
        "yeti" : "//bootswatch.com/3/yeti/bootstrap.min.css"
    }

}

This software was developed using static files, you can serve them locally for development with python -m simpleHTTPServer 8000 and visit http://localhost:8000.