Skip to content

Latest commit

 

History

History
73 lines (52 loc) · 3.67 KB

README.md

File metadata and controls

73 lines (52 loc) · 3.67 KB

NOTE! This project was initially conceived as a proof of concept and can be considered the MVP-1 of what has now become a full-scale project. Currently, MVP-2 has been completed, and you can learn more about it at the following link: link. Feel free to join our developer chat as well, or right me directly: @dev9ft6.

ЗАМЕЧАНИЕ! Этот проект изначально задумывался как proof of concept и можно считать его MVP-1 того, во что он сейчас развился. В настоящее время завершен MVP-2, ознакомиться с которым подробнее можно по ссылке: link. Присоединяйтесь также к нашему чату разработчиков, или пишите мне напрямую: @dev9ft6.

User Interface

Bot screenshot

Project Overview

This project started as an evening coding session over a beer to explore the mechanics of the hyped-up "Hamster Kombat." Now, it's an attempt to create a unified farm for similar projects. To work with it, you need to run the local server and bot modules located in src/services. Each module is essentially an API client with logic for auto-leveling, implementing useful functions, and displaying information in the terminal. Currently, there is a Telegram bot that allows users to verify themselves and administrators to approve user participation in the system. The bot supports hot account additions without needing to restart the runners. The system architecture is now microservice-based and includes the following components:

  • Runners: Each runner is dedicated to managing a specific game.
  • Telegram bot: Manages user registration and verification processes.
  • Central FastAPI server: Manages account and user databases, communicates with the bot, and has WebSocket support for communication with the runners.

Implemented:

Installation and Launch

add bot token to env/.env look

add default user ids to data/users/admins or data/users/users

  1. Clone the repository: If you have Git installed, you can clone the repository using:

    git clone https://github.com/9ft6/hamster_farm.git
cd hamster_farm

  2. Create and activate a virtual environment: Use make to create a virtual environment and install the required packages:

    make install

  3. Settings:

    1. add telegram bot token to env/.env as you can see in env/.env.example
    2. add default user telegram ids to data/users/admins or data/users/users files
    3. Create a directory named accounts/ in the root of the project and add files with game slugs (blum, hamster_kombat). Learn more at game module pages.

  4. Run the local account server in one terminal:

    make run-server

  5. Run the telegram bot:

    make run-bot

  6. Run the local bots in different terminals:

    make run-blum

    or

    make run-hamster

    It's convenient to use tmux for this. The deployment is currently basic, but we will improve it.