Skip to content

Server List Server Config

Jump to bottom
Daisuke Sato edited this page Feb 3, 2017 · 4 revisions

Server List URL

  1. if app has "serverlist.txt", it access to the url in the file
  • file should have only one line url text
  1. if app has "serverlist.json", use it for server list
  2. otherwise, access to https://hulop.github.io/serverlist.json

Content of Server List

{
  servers: [
    {
      server_id: "id for this server",
      available: <boolean>, // if false, item will be grayed out and unable to be selected 
      name: { // bold title of list
        <lang-2character-code>: <string>, ...
      },
      description: { // small subtitle under the title
        <lang-2character-code>: <string>, ...
      },
      hostname: "server host name",
      config_file_name: "full name of filename" // (optional)
    }, ...
  ]
}

Server Config

<selected_server> is a json object of the selected server in the server list

  1. if <selected_server> has config_file_name key access to https://<hostname>/config/<config_file_name>
  2. otherwise access to https://<hostname>/config/server_config.json

Content of Server Config

{
  conv_server: "host name of conversation server",
  conv_api_key: "api key for conversation",
  ask_enquete: <boolean>, // if true, ask users to submit feedback
  preset_for_blind: {
    src: "path from the route",
    size: <number> // size of the file in bytes
  },
  preset_for_wheelchair: {
    src: "path from the route",
    size: <number> // size of the file in bytes
  },
  preset_for_sighted: {
    src: "path from the route",
    size: <number> // size of the file in bytes
  },
  map_files: [
  {
    src: "path from the route",
    size: <number> // size of the file in bytes
  }
  ]
}
Clone this wiki locally