Skip to content

Latest commit

 

History

History
70 lines (54 loc) · 1.61 KB

README.md

File metadata and controls

70 lines (54 loc) · 1.61 KB

Streamertools

Available on https://streamertools.app/

Streamertools is an open source website where you can find all the best tools for livestream. Twitch, Kick, Youtube, Tiktok, find the best to enhance your streaming experience.

Start the project

npm run dev

Build the project

npm run build

Add a tool

To add a tool, you just need to create a file in the ./src/tools directory with this template

import type { Tool } from '../types/tool';

const tool: Tool = {
	iconUrl: 'https://example.com/example.jpg', // 1:1 format
	name: 'Example',
	slug: 'example', // Same as your tool file name
	url: 'https://example.com/',
	urlDisplay: 'example.com',
	description: 'Tool description',
	prices: ['free', 'paid'],
	providers: ['twitch', 'youtube', 'tiktok'],
	tags: ['chat', 'music', 'tool', 'software'],
	screenshots: [
		'https://example.com/example.jpg',
		'https://example.com/example.jpg',
	],
};

export default tool;

Add an OBS plugin

To add an OBS plugin, you just need to create a file in the ./src/obs directory with this template

import type { Tool } from '../types/tool';

const tool: Tool = {
	iconUrl: 'https://example.com/example.jpg', // 1:1 format
	name: 'Example',
	slug: 'example', // Same as your obs plugin file name
	url: 'https://example.com/',
	urlDisplay: 'example.com',
	description: 'Plugin description',
	prices: ['free', 'paid'],
	providers: ['twitch', 'youtube', 'tiktok'],
	tags: ['chat', 'music', 'tool', 'software'],
	screenshots: [
		'https://example.com/example.jpg',
		'https://example.com/example.jpg',
	],
};

export default tool;