From c1ed1afa5b053316bb1487ca60f3e938ee9174a8 Mon Sep 17 00:00:00 2001 From: Martin Michelsen Date: Fri, 8 Sep 2023 09:38:00 -0700 Subject: [PATCH] add more info about Ep3 lobby banners --- system/config.example.json | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/system/config.example.json b/system/config.example.json index 33307c8b..6f3cf089 100644 --- a/system/config.example.json +++ b/system/config.example.json @@ -383,10 +383,15 @@ }, // Episode 3 lobby banners. Currently only images are supported. - // Banners are specified as lists of [type, which, filename]. Files are - // expected to be BMP or PPM files in the system/ep3/banners directory. type - // should be 1 for image files. which is a bitmask specifying where in the - // lobby the banner should appear; the bits are: + // Image giles are expected to be in BMP or PPM format, and should be placed + // in the system/ep3/banners directory. Image sizes must be a multiple of 4 + // pixels in both dimensions, must be no larger than 0x37000 bytes when + // encoded as a GVM file (newserv will do this encoding internally), and must + // compress to no larger than 0x3800 bytes. newserv will fail on startup if + // any of these constraints aren't satisfied. + // Banners are specified as lists of [type, which, filename]. type should be + // 1 for image files. which is a bitmask specifying where in the lobby the + // banner should appear; the bits are: // 00000001: South above-counter banner (facing away from teleporters) // 00000002: West above-counter banner // 00000004: North above-counter banner (facing toward jukebox)