This repository has been archived on 2024-07-30. You can view files and clone it, but cannot push or open issues or pull requests.
python-aternos/docs/howto/players.md
DarkCat09 4892430f19 MkDocs, Readme, Files API, Automated session saving, v2.0.1
MkDocs: sphinx docstrings rewritten to google, improved config, written the major part of how-to.
Readme: centered title + logo, added badges, features list, updated changelog.

Improved Files API, added automatical session saving and restoring to Client.
Some changes in makefile and gitignore.
License Notice now refers to all contributors.
2022-08-26 16:14:07 +04:00

1 KiB

How-To 3: Players lists

You can add a player to operators, include in the whitelist or ban using this feature.

Common usage

It's pretty easy:

from python_aternos import Client, Lists

...

whitelist = serv.players(Lists.whl)

whitelist.add('jeb_')
whitelist.remove('Notch')

whitelist.list_players()
# ['DarkCat09', 'jeb_']

List types

Name Enum key
Whitelist Lists.whl
Operators Lists.ops
Banned Lists.ban
Banned by IP Lists.ips

For example, I want to ban someone:

serv.players(Lists.ban).add('someone')

And give myself operator rights:

serv.players(Lists.ops).add('DarkCat09')

Unban someone:

serv.players(Lists.ban).remove('someone')

Unban someone who I banned by IP:

serv.players(Lists.ips).remove('anyone')

Caching

If list_players doesn't show added players, call it with cache=False argument, like list_servers.

lst = serv.players(Lists.ops)
lst.list_players(cache=False)
# ['DarkCat09', 'jeb_']