Signup

> cq signup --help
Signup to a Corridor Quest server (create a user)

Usage: cq signup [OPTIONS] --server-url <SERVER_URL> --user-name <USER_NAME> --email-address <EMAIL_ADDRESS> --password <PASSWORD>

Options:
  -s, --server-url <SERVER_URL>        the url of the game service
  -u, --user-name <USER_NAME>          the unique identifier of the user
  -d, --description <DESCRIPTION>      An optional description of the user
  -e, --email-address <EMAIL_ADDRESS>  Email Address of the user
  -p, --password <PASSWORD>            The password for the user
  -n, --ntfy-dm-topic <NTFY_DM_TOPIC>  The optional ntfy DM topic
  -P, --profile <PROFILE>              The optional profile name
  -h, --help                           Print help

To be able to play games you need to become a user of the game system. To become a user you need to sign-up. To sign-up you need the following information:

  • Username: must be unique within the system and maximum 10 long, among some other rules that will be checked by the system. If there is something wrong with your choice of username, you will be told what is problem is.
  • Email-address: must be unique within the system and is checked to be a valid email address format. You need to be reachable at this address or signup cannot be completed.
  • Description (optional): This is how you would like to describe yourself. It may be you full name, some fantasy name, or anything you like. Max 50 long. Tip: keep it decent.
  • Password: This is the secret string you need to provide when you log into the system to prove you are who you claim to be. It has the usual restrictions.
  • ntfy_dm_topic: This is an optional field. it is used to set a unique secret topic name to be able to send DM messages to you using the optional ntfs.sh notification service.
  • Server (optional): This game is implemented as a Client-Server system. This is done to facilitate many clients from one central system across the network. However, there can be multple game servers available on the network. So, you need to make a choice to which game server you want to sign-up. If you do not give this information the client will choose the default living on https://corridor-quest.net:3000.
If you do not want to type in your password in clear text while signing up, just leave it out and the sign-up command will prompt you for it without echoing it back on the terminal.

When you signup an email is send to the specified email address with a verification code. See Verify.

You can optionally give a profile name. See Profiles for an explanation.