easygamechat 0.3.0

An easy and secure Python library for real-time game chat

EasyGameChat

EasyGameChat is a minimal, secure, and cross-platform chat server and client library designed for real-time communication in games or applications. It aims to provide simple, fast integration across multiple languages with a JSON-based protocol and message validation system.

Features

• Lightweight and efficient server implementation in Go
• TLS encryption for secure communication
• Secure and strict input validation
• Modular server-client architecture
• Cross-language support (C++, Python, and more to come)
• JSON-based protocol for easy parsing
• Thread-safe and rate-limited message broadcasting

Getting Started

Server (Go)

1. Install Go 1.18 or later.
2. Generate a TLS certificte and key with the provided scripts or, preferably, use your own. The server requires a valid certificate and key for secure communication.
3. Run the server:

go run main.go

TLS is enabled by default. You can configure certificate paths or disable TLS in the config file or server options.

Client (C++)

1. Include EasyGameChat.h in your project.
2. Install the required dependencies (only nlohmann/json for JSON parsing and a TLS library like OpenSSL) with your preferred package manager. On Windows, you can specify your preferred toolchain in the CMake build command with -DCMAKE_TOOLCHAIN_FILE=path/to/your/toolchain.cmake.
3. Compile and run the example:

cd examples/c-cpp
cmake -B build -S .
# If using vcpkg, specify the toolchain file:
cmake -B build -S . -DCMAKE_TOOLCHAIN_FILE=C:\path\to\vcpkg\scripts\buildsystems\vcpkg.cmake
cmake --build build
./build/chat-client

Run the /info command in the client to display connection details including TLS status.

Client (Python)

cd clients/python
python -m build
python -m pip install .\dist\easy_game_chat-0.3.0-py3-none-any.whl
# or install directly from the source
pip install .
python examples/python/main.py

Token Generation

To generate a token for authentication, use the following command:

go run main.go generate-token <username>

This will generate a token and store its hashed value securely in a tokens.json file. The token is valid for 24 hours and can be used for client authentication. Remember to save the token, as it will not be displayed again.

Protocol

Messages follow a simple JSON format:

{
  "from": "nickname",
  "text": "message content"
}

All input is sanitized and validated server-side to prevent injection, malformed data, or abuse.

License

This project is licensed under the MIT License.