Famoria

is an open-source telegram bot with the function of creating marriages and earning in-game currency.

Commands

• /help or /start - Get help.
• /menu - Open bot menu.
• /gobrak - Invite someone to create family. (Use as a reply to a user's message)
• /endbrak - End the marriage.
• /profile - Get your profile with family (if exist).
• /braks - Get a list of families in current chat.
• /braksglobal - Get a list of global families.
• /gokids - Give birth to a child. (Use as a reply to a user's message)
• /detdom - Disown of marriage.
• /kidannihilate - Annihilate a child.
• /tree - Get a family tree. (Without number - text format, with number from 1 to 5 - picture format)
• /deposit or /dep - Transfer in-game currency from the user balance to the family balance. (Use /dep 1)
• /withdraw or /with - Transfer in-game currency from your family's balance to your own balance. (Use /with 1)
• /inventory - Reviewing purchased family items.
• /shop - Purchase items from the secret shop to enhance the rewards of in-game events
• /subscribe - Take out a family subscription.

Self-hosting

Clone the Repository:

git clone https://github.com/koliy82/famoria.git

Set Up Environment Variables:

Create a .env file in the root directory and add your Telegram bot token.

• TELEGRAM_TOKEN - Your Telegram bot token. (How to get a token)
• APP_ENV [Optional] - Application environment. (default: dev)
• AppTimeZone [Optional] - Application timezone. (default: Europe/Moscow)
• CLICKHOUSE_URL - ClickHouse URL.
• CLICKHOUSE_PORT - ClickHouse port.
• CLICKHOUSE_USER - ClickHouse user.
• CLICKHOUSE_PASSWORD - ClickHouse password.
• CLICKHOUSE_DATABASE - ClickHouse database.
• MONGO_URI - MongoDB URI.
• MONGO_DATABASE - MongoDB database.
• ERRORS_CHAT_ID [Optional] - Telegram Chat ID for error messages.

Set Up the Database:

• Famoria uses ClickHouse and MongoDB. You can use Docker to run them.
• Generate replica.key for MongoDB. (How to generate a key)

cd database-compose
cd clickhouse
docker-compose up -d
cd ../mongo
docker compose build
docker compose up --wait

• Connect to MongoDB with the mongo shell and run the following command to initiate the replica set:

try { rs.status() } catch (err) { rs.initiate({_id:'rs0',members:[{_id:0,host:'host.docker.internal:27017'}]}) }

Set Up the Bot in root directory:

docker compose up -d

Contact

If you have any questions or suggestions, feel free to open an issue or contact Koliy82.