Provided by: cyphesis-cpp-clients_0.6.2-2ubuntu1_amd64 bug


       cycmd - cycmd game server process


       cycmd [ --section:option=value ... ] [ command [ server ] ]


       The cycmd program provides a commandline interface to a cyphesis server.


       Configuration  options are divided up into named sections, which need to be specified when
       modifying or overriding the options. In a config file the name of a section  is  specified
       in  square  brackets  at  the beginning of the section. On the command line the section is
       given at the beginning of the option specification, as shown in the synopsis above.

       The following options used by cycmd are present in the client section of the config  file,
       and overridden by specifying the client section name on the command line.

              Hostname of the server to connect to.

              This  setting  provides  the  hostname of the system where cyphesis is running that
              cycmd should try and connect to.

       The following options are present  in  the  cyphesis  section  of  the  config  file,  and
       overridden  by  specifying  the  cyphesis  section name on the command line. These options
       apply to the server, but are also required by the client to ensure  that  the  client  can

              Network port for server TCP connections.

              Specifies the port number to use when connecting to the server.

              Local liston socket for Unix domain connections.

              Specifies the filename to use to listen for local trusted client connections.


         add_agent [ type ]
              Create an in-game agent.

              Create  an  avatar  or  agent  in  the game to be used to manipulate the world.  By
              default an avatar of type "creator" is created,  and  this  is  required  for  most
              operations. Avatars of other types can be created, but have limited ability to edit
              the world.

              Cancel the current admin task.

              Various commands begin a background admin task in the client.  This  command  stops
              any currently running task.

         connect hostname
              Connect the server to a peer.

              Try and establish a connection to a peer server.

         creator_create type
              Use agent to create an entity.

              Use the in-game agent owned by this client to create an in-game entity of any type.

         delete id
              Delete an entity from the server.

              Delete the in-game entity with the given ID from the world.

         dump [ filename ]
              Write the contents of the world to an Atlas dump file.

              An  Atlas  representation  of every entity on the server is written to a file using
              the XML codec.

         get id
              Examine any object on the server.

              Get an object description from the server, and display its contents.

         find_by_name name
              Find an entity with the given name.

              Search the world for an entity with the given name, and return the first one found.

         find_by_type type
              Find an entity with the given type.

              Search the world for an entity with the given type, and return the first one found.

         flush type
              Flush entities from the server

              Search the world for entities with the given type, and delete them all.

              This process does not work perfectly reliably, so may have to be run multiple times
              to fully clear the server.

         help Display online help.

              Lists all the commands available, with a short description of what each one does.

         install type_id parent_id
              Install a new type in the server.

         look Return a view of the current server lobby.

              Look  at  the  current  server  lobby,  where  all  users  currently  logged in are
              represented. The view is returned and displayed.

         logout [ account ]
              Log user out of server.

              Enable server monitoring.

              Direct the server to report all in-game operations to the client. A digest of  each
              operation  is displayed, including the type, which entity the operation is from and
              which entity the operation is to.

         query entity_id
              Synonym for "get" (deprecated).

         reload type
              Reload the script for a type.

              Reload the Python script for a given type from the file on disk.

         restore [ filename ]
              Restore the contents of an Atlas dump file into the world.

              Read entities from an Atlas XML codec dump file, and restore them into the  server.
              The  most  reliable use case for this is with an empty server to restore a snapshot
              of the world taken at an earlier time.

              It is possible to restore a dump file into server which already contains  a  world,
              but the following caveats apply:

              If  there are collisions between the ID space being used in the existing world, and
              the ID space used in the dump file, the tool will do  its  best  to  do  the  right
              thing,  but the results are to some extent undefined. If an entity with the same ID
              and type exists in both spaces, only one will exist after the restore and  it  will
              have some of the properties of both copies of that entity.

         stat Examine the current server status.

              Get a description of the current server status, and display its contents.

              Disable server monitoring.

              Direct the server to stop reporting all in-game operations to the client.


       The first example shows getting the current server status and checking the lobby to see if
       any users are logged in.

       cyphesis> stat
            clients:  1
            objtype:  obj
            parents:  [  server ]
            ruleset:  mason
            server:  cyphesis
            uptime:  1728.2
            version:  0.3.2
       cyphesis> look
             id: lobby
             name: lobby
             objtype: obj
             parents: [  room ]
             people: [  1 ]
             rooms: [  ]

       The first entity returned shows various information about the server,  including  when  it
       was built, the number of connected client, the current ruleset, and the server uptime. The
       second entity representing the lobby shows that only one user is current logged in, and no
       chat rooms have been created.

       The second example shows how to install a new type.

       cyphesis> get thing
            children:  [  feature character plant food stackable structure arm arrow axe barrel block_house board boat boundary bow campfire cleaver coin fire gallows house lumber pelvis ribcage shin skull stall sword thigh tower twobyfour wall weather ]
            contains:  [  ]
            id:  thing
            objtype:  class
            parents:  [  game_entity ]
            pos:  [  0 0 0 ]
            stamp_contains:  0
            velocity:  [  0 0 0 ]
       cyphesis> install box thing

       The  third  example  shows  server  monitoring  being enable, followed by information of a
       series of in-game operations. The flow of messages in while monitoring the server  can  be
       large. In order to suppress the flow, the unmonitor command must be used.

       cyphesis> monitor


       Written by Alistair Riddoch.


       Report bugs to <>.


       Copyright 2004 Alistair Riddoch.


       cyphesis(1), cyclient(1), cyphesis-tools(1)

                                         18 November 2010                                CYCMD(1)