Metadata-Version: 2.5
Name: lupaxa-chat-server
Version: 0.4.0
Summary: Multi-room TCP chat server.
Project-URL: Homepage, https://github.com/lupaxa-after-hours/chat-server
Project-URL: Documentation, https://chat-server.thelupaxaproject.org/
Project-URL: Repository, https://github.com/lupaxa-after-hours/chat-server
Project-URL: Issues, https://github.com/lupaxa-after-hours/chat-server/issues
Author: The Lupaxa Project
License: MIT License
        
        Copyright (c) The Lupaxa Project
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENCE
Keywords: chat,server,tcp
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Communications :: Chat
Requires-Python: >=3.10
Requires-Dist: asyncssh>=2.14
Requires-Dist: bcrypt>=4.0
Requires-Dist: colorama>=0.4.6
Requires-Dist: cryptography>=44
Requires-Dist: maxminddb>=2.6
Requires-Dist: psutil>=5.9
Requires-Dist: pyyaml>=6.0
Requires-Dist: qrcode>=7.4
Provides-Extra: dev
Requires-Dist: bump-my-version>=1.2.0; extra == 'dev'
Requires-Dist: hatch>=1.12.0; extra == 'dev'
Requires-Dist: mkdocs-material==9.7.7; extra == 'dev'
Requires-Dist: mkdocs==1.6.1; extra == 'dev'
Requires-Dist: mypy>=1.12.0; extra == 'dev'
Requires-Dist: pip-audit>=2.7.0; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.6.0; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest-cov>=5.0; extra == 'test'
Requires-Dist: pytest>=8.0; extra == 'test'
Description-Content-Type: text/markdown

<p align="center">
  <a href="https://github.com/lupaxa-after-hours">
    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/after-hours/readme-logo.png" alt="After Hours" />
  </a>
</p>

<h1 align="center">Chat Server</h1>

Time for a little nostalgia, from the 1980s through the 2000s. Those years were full of
[talkers](https://en.wikipedia.org/wiki/Talker), [MUDs](https://en.wikipedia.org/wiki/Multi-user_dungeon) and
[MUSHes](https://en.wikipedia.org/wiki/MUSH): real-time chat and games, all of it text, reached by telnet or a
client made for the job. Most of them have long since left the internet, replaced by newer games and messaging.

This server is a throwback to that. The days we grew up online and spent playing these games.

It is a bare-bones chat system, and it works. Use it straight out of the box, or do what we used to do: tinker
with it, customise it, add to it, and make it your own.

## Key Features

- Telnet, SSH, or both. SSH has no SSH password. The chat name is still the first prompt.
- IPv4, IPv6, or both. `stack` is `ipv4`, `ipv6`, or `dual`.
- Country lookup from an MMDB file. Loopback is Localhost, a private address is Private Network, and a miss is Unknown.
- Saved players, bcrypt passwords, and ranks from newbie through Super Admin.
- MFA with a six-digit code. The secret is sealed in the player file with the password.
- Rooms, a map, tells, shouts, and staff tools for residents, super users, and admins.

## Install

```bash
pip install lupaxa-chat-server
```

Requires Python 3.10+. AsyncSSH, bcrypt, colorama, cryptography, maxminddb,
PyYAML, and qrcode are the runtime dependencies.

## Run

The server will not start without a config file. There is no default path.
From a checkout, setup runs once while the talker is stopped:

```bash
chat-server setup -c config/config.yml
chat-server -c config/config.yml
python -m lupaxa.chat_server -c config/config.yml
```

The files under `config/` are one example. After
`pip install lupaxa-chat-server`, create the config, the rooms file, and
the help file yourself.

## Documentation

- [Getting Started](mkdocs/getting-started.md) covers the config file and how to run.
- [Security](mkdocs/security/index.md) covers the checks on a connection, including [SSH](mkdocs/security/ssh.md) and [MFA](mkdocs/security/mfa.md).
- [Connect](mkdocs/usage/index.md), [Players](mkdocs/usage/players.md), [Rooms](mkdocs/usage/rooms.md), and [Commands](mkdocs/usage/commands.md) are how a player uses it.
- [Reference](mkdocs/reference.md) is the config keys, ranks, and public names.
- [Examples](mkdocs/examples.md) is a short telnet session and the SSH command.
- [Developer Docs](developer-docs/README.md) is for changing the source. It is not part of the public site.

<a href="https://github.com/the-lupaxa-project">
    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
</a>
