evennia/docs/source/Guest-Logins.md

30 lines
1.6 KiB
Markdown
Raw Normal View History

# Guest Logins
2020-10-11 19:31:05 +02:00
Evennia supports *guest logins* out of the box. A guest login is an anonymous, low-access account
and can be useful if you want users to have a chance to try out your game without committing to
creating a real account.
Guest accounts are turned off by default. To activate, add this to your `game/settings.py` file:
GUEST_ENABLED = True
2020-10-11 19:31:05 +02:00
Henceforth users can use `connect guest` (in the default command set) to login with a guest account.
2021-10-26 21:14:33 +02:00
You may need to change your [Connection Screen](./Connection-Screen.md) to inform them of this
2020-10-11 19:31:05 +02:00
possibility. Guest accounts work differently from normal accounts - they are automatically *deleted*
whenever the user logs off or the server resets (but not during a reload). They are literally re-
usable throw-away accounts.
You can add a few more variables to your `settings.py` file to customize your guests:
2021-10-26 21:14:33 +02:00
- `BASE_GUEST_TYPECLASS` - the python-path to the default [typeclass](./Typeclasses.md) for guests.
2020-10-11 19:31:05 +02:00
Defaults to `"typeclasses.accounts.Guest"`.
2021-10-26 21:14:33 +02:00
- `PERMISSION_GUEST_DEFAULT` - [permission level](./Locks.md) for guest accounts. Defaults to `"Guests"`,
2020-10-11 19:31:05 +02:00
which is the lowest permission level in the hierarchy.
- `GUEST_START_LOCATION` - the `#dbref` to the starting location newly logged-in guests should
appear at. Defaults to `"#2` (Limbo).
- `GUEST_HOME` - guest home locations. Defaults to Limbo as well.
2020-10-11 19:31:05 +02:00
- `GUEST_LIST` - this is a list holding the possible guest names to use when entering the game. The
length of this list also sets how many guests may log in at the same time. By default this is a list
of nine names from `"Guest1"` to `"Guest9"`.