Pokémon Absolute — Chat
Pokémon Absolute is an online text-based Pokémon RPG, comprised of numerous features adapted from the official Pokémon games, as well as entirely new features that enhance the playing experience of Pokémon.
This repository contains the source code for the Pokémon Absolute real time chat system.
Check us out on Discord and consider starring the repository if you liked it!
Table of Contents
About The Project
Tech Stack
- Node.JS
- TypeScript
- Socket.io
- MySQL
Features
- Direct database connection to allow for communication between users
- User authentication based on unique auth codes set upon account registration
- Includes numerous custom chat commands for user entertainment and utility
- Prevents clients from spamming numerous messages over a short period of time
Getting Started
It's expected that this chat system is ran through its parent repository Pokémon Absolute via Docker.
This chat system will fail to run if it is not able to connect to its designated database.
Prerequisites
This project is configured and engineered specifically for Pokémon Absolute, and as such, will not work out-of-the-box for anything else.
Do check out .env.local to see what environment variables you'll need to run this bot.
Development
If you do choose to add a feature or fix a bug, do note that your pull request will not be accepted if your code does not satisfy our eslint configuration.
Contributing
If you're interested in contributing to Absolute, please check out the main repository's CONTRIBUTING.md for more information.
License
This project is licensed under MIT.
For more information about the license, check out the LICENSE.