gameServer/CommandHelp.hs
author Simon McVittie <smcv@debian.org>
Mon, 12 Sep 2022 10:40:53 -0400
branch1.0.0
changeset 15859 7b1d6dfa3173
parent 15408 d9a12aba5c05
permissions -rw-r--r--
Remove FindSDL2 find-module, use sdl2-config.cmake instead This requires SDL >= 2.0.4. Since <https://bugzilla.libsdl.org/show_bug.cgi?id=2464> was fixed in SDL 2.0.4, SDL behaves as a CMake "config-file package", even if it was not itself built using CMake: it installs a sdl2-config.cmake file to ${libdir}/cmake/SDL2, which tells CMake where to find SDL's headers and library, analogous to a pkg-config .pc file. As a result, we no longer need to copy/paste a "find-module package" to be able to find a system copy of SDL >= 2.0.4 with find_package(SDL2). Find-module packages are now discouraged by the CMake developers, in favour of having upstream projects behave as config-file packages. This results in a small API change: FindSDL2 used to set SDL2_INCLUDE_DIR and SDL2_LIBRARY, but the standard behaviour for config-file packages is to set <name>_INCLUDE_DIRS and <name>_LIBRARIES. Use the CONFIG keyword to make sure we search in config-file package mode, and will not find a FindSDL2.cmake in some other directory that implements the old interface. In addition to deleting redundant code, this avoids some assumptions in FindSDL2 about the layout of a SDL installation. The current libsdl2-dev package in Debian breaks those assumptions; this is considered a bug and will hopefully be fixed soon, but it illustrates how fragile these assumptions can be. We can be more robust against different installation layouts by relying on SDL's own CMake integration. When linking to a copy of CMake in a non-standard location, users can now set the SDL2_DIR or CMAKE_PREFIX_PATH environment variable to point to it; previously, these users would have used the SDL2DIR environment variable. This continues to be unnecessary if using matching system-wide installations of CMake and SDL2, for example both from Debian.

{-
 * Hedgewars, a free turn based strategy game
 * Copyright (c) 2004-2015 Andrey Korotaev <unC0Rr@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 2 of the License
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 \-}

{-# LANGUAGE CPP, OverloadedStrings #-}
module CommandHelp where

import qualified Data.ByteString.Char8 as B

import CoreTypes
import Utils
import Consts

-- List and documentation of chat commands

cmdHelpSharedPlayer :: [B.ByteString]
cmdHelpSharedPlayer = [
    loc "/info <player>: Show info about player",
    loc "/me <message>: Chat action, e.g. '/me eats pizza' becomes '* Player eats pizza'",
    loc "/rnd: Flip a virtual coin and reply with 'heads' or 'tails'",
    loc "/rnd [A] [B] [C] [...]: Reply with a random word from the given list",
#if defined(OFFICIAL_SERVER)
    loc "/watch <id>: Watch a demo stored on the server with the given ID",
#endif
    loc "/quit: Quit the server",
    loc "/help: Show chat command help"
    ]

cmdHelpRoomOnlyPlayer :: [B.ByteString]
cmdHelpRoomOnlyPlayer = [
    -- For everyone
    loc "/callvote [arguments]: Start a vote",
    loc "/vote <yes/no>: Vote 'yes' or 'no' for active vote",
    -- For room master only
    loc "/greeting [message]: Set or clear greeting message to be shown to players who join the room",
    loc "/delegate <player>: Surrender room control to player",
    loc "/maxteams <N>: Limit maximum number of teams to N"
    ]

cmdHelpSharedAdmin :: [B.ByteString]
cmdHelpSharedAdmin = [
    loc "/global <message>: Send global chat message which can be seen by everyone on the server",
    loc "/registered_only: Toggle 'registered only' state. If enabled, only registered players can join server",
    loc "/super_power: Activate your super power. With it you can enter any room and are protected from kicking. Expires when you leave server"
    -- TODO: Add /restart_server? This command seems broken at the moment
    ]

cmdHelpLobbyOnlyAdmin :: [B.ByteString]
cmdHelpLobbyOnlyAdmin = [
    loc "/stats: Query server stats"
    ]

cmdHelpRoomOnlyAdmin :: [B.ByteString]
cmdHelpRoomOnlyAdmin = [
    loc "/force <yes/no>: Force vote result for active vote",
    loc "/fix: Force this room to stay open when it is empty",
    loc "/unfix: Undo the /fix command",
    loc "/save <config ID> <config name>: Add current room configuration as votable choice for /callvote map",
    loc "/delete <config ID>: Delete a votable room configuration"
#if defined(OFFICIAL_SERVER)
    ,
    loc "/saveroom <file name>: Save all votable room configurations (and the greeting) of this room into a file",
    loc "/loadroom <file name>: Load votable room configurations (and greeting) from a file"
#endif
    ]

cmdHelpHeaderLobby :: [B.ByteString]
cmdHelpHeaderLobby = [ loc "List of lobby chat commands:" ]

cmdHelpHeaderRoom :: [B.ByteString]
cmdHelpHeaderRoom = [ loc "List of room chat commands:" ]

cmdHelpHeaderAdmin :: [B.ByteString]
cmdHelpHeaderAdmin = [ loc "Commands for server admins only:" ]

-- Put it all together
-- Lobby commands
cmdHelpLobbyPlayer :: [B.ByteString]
cmdHelpLobbyPlayer = cmdHelpHeaderLobby ++ cmdHelpSharedPlayer

cmdHelpLobbyAdmin :: [B.ByteString]
cmdHelpLobbyAdmin = cmdHelpLobbyPlayer ++ cmdHelpHeaderAdmin ++ cmdHelpLobbyOnlyAdmin ++ cmdHelpSharedAdmin

-- Room commands
cmdHelpRoomPlayer :: [B.ByteString]
cmdHelpRoomPlayer = cmdHelpHeaderRoom ++ cmdHelpRoomOnlyPlayer ++ cmdHelpSharedPlayer

cmdHelpRoomAdmin :: [B.ByteString]
cmdHelpRoomAdmin = cmdHelpRoomPlayer ++ cmdHelpHeaderAdmin ++ cmdHelpRoomOnlyAdmin ++ cmdHelpSharedAdmin

-- Helper functions for chat command handler
cmdHelpActionEntry :: [ClientChan] -> B.ByteString -> Action
cmdHelpActionEntry chan msg = AnswerClients chan [ "CHAT", nickServer, msg ]

cmdHelpActionList :: [ClientChan] -> [B.ByteString] -> [Action]
cmdHelpActionList chan list = map (cmdHelpActionEntry chan) list