YORU

• Why Choose Yoru?
• Requirements
• Getting Started
• Configuration
• Running the Bot
• Installation via Docker
• Plugin Development
• PM2 Configuration
• Contributing
• Troubleshooting
• License

• Free & Open Source: Completely free for personal and commercial use under the MIT License.
• Modular Architecture: Easily extend functionality with a simple plug-and-play plugin system.
• Fast & Stable: Powered by Telegraf, one of the most popular and reliable Telegram bot libraries.
• Hybrid Storage: Choose between simple JSON file-based storage or a powerful MongoDB database for scalability.
• Active Roadmap:
  • Robust Error Handling: A more resilient system to gracefully handle errors and maintain a stable connection.
  • Easy Deployment: Streamlined processes for hosting on various platforms.

• NodeJS: Version 16.x or higher. (Recommended 20.x)
• Git: For cloning the repository.

• vCPU: 1 Core
• RAM: 500 MB

• Hosting: Hostdata (NAT VPS), Optiklink, VPS, RDPWin
• Database: MongoDB Atlas for a free cloud database.

# Clone the repository
git clone https://github.com/yuurahz/yoru.git

# Navigate into the project directory
cd yoru

# Install all required dependencies
npm install

Copy the example .env file to create your own configuration file.

cp .env.example .env

Next, open the .env file and customize the values as needed.

Edit the .env file you just created:

You can run the bot in several different modes:

• Production Mode:

  npm start

• Development Mode (with auto-reload on file changes):

  npm run dev

• Using PM2 (to keep the bot online):

  npm run pm2

For an easy and isolated setup, you can use Docker.

# Update packages and install dependencies
sudo apt update -y && sudo apt install curl git -y

# Install Docker
curl -fsSL https://get.docker.com | bash

# Clone the repository
git clone https://github.com/yuurahz/yoru

# Navigate into the directory
cd yoru

# (IMPORTANT) Create and edit your .env file before building the image
# cp .env.example .env
# nano .env

# Build the Docker image
docker build -t yoru-bot .

# Run the container in detached mode and set it to always restart
docker run -d --name yoru --restart always yoru-bot

# View the bot's logs in real-time
docker logs -f yoru

To stop the container:

docker stop yoru

Yoru uses a flexible and easy-to-extend plugin system.

This is a simple ping plugin to check the bot's latency.

// file: plugins/tools/ping.js
module.exports = {
	// Plugin metadata
	help: ["ping"],
	category: "tools",
	command: "ping",

	// The main logic of the plugin
	run: async (m, { client }) => {
		const start = Date.now();
		const msg = await m.reply("Pinging...");
		const latency = Date.now() - start;

		await client.telegram.editMessageText(
			m.chat,
			msg.message_id,
			null,
			`🏓 Pong!\n*Latency:* ${latency} ms`,
			{ parse_mode: "Markdown" }
		);
	},

	// Plugin permissions and properties
	group: true, // Works in groups
	admin: false, // Does not require admin
	limit: 1, // Consumes 1 usage limit (can be a Number or Boolean)
	premium: false, // Not premium-only
	botAdmin: false, // Bot does not need to be an admin
	owner: false, // Not owner-only
};

Plugins can also respond to events instead of commands, such as replying to specific messages.

// file: plugins/events/auto-reply.js
module.exports = {
	// The 'before' function runs on every incoming message
	before: async (m, { client }) => {
		if (m.body?.toLowerCase().includes("hello yoru")) {
			await m.reply("👋 Hello there!");
		}

		// Always return a boolean value
		return true;
	},
};

If you run the bot using npm run pm2, you can customize its configuration in the ecosystem.config.js file.

module.exports = {
	apps: [
		{
			name: "yoru",
			script: "index.js",
			exec_mode: "fork",
			instances: 1,
			max_memory_restart: "300M",
			watch: false, // Set to true to automatically restart on file changes
		},
	],
};

Your contributions are highly appreciated! If you'd like to help improve Yoru, please follow these steps:

1. Fork the repository.
2. Create a new feature branch (git checkout -b feature/NewFeature).
3. Make your changes and commit them (git commit -m "Add NewFeature").
4. Push to your branch (git push origin feature/NewFeature).
5. Open a Pull Request.

This project is licensed under the MIT License. Free for personal & commercial use.