Skip to content

Contributing

fluteds edited this page Oct 31, 2023 · 9 revisions

Since this repo is open sourced and community driven. Pull requests and issues are highly recommended.

How to Submit Themes

Submitting can be as easy as opening a pull request or submitting an issue with the correct template. So far there are two methods for submitting.

Method One

  • Fork the repo
  • Add your theme/addon files
  • Open a pull request

Method Two

  • Open an issue
  • Link the source of your theme/addon
  • Paste the theme/addon code in Code Blocks

Credit & Formatting

When submitting a theme, you must put a CSS or Javascript meta comment before the code stating who made the theme and include update urls. This is needed for users who decide to use Stylus and Tampermonkey.

CSS Meta for Stylus

Note: Save your file as .user.css

/* ==UserStyle==
@name         Name of Theme
@version      1.0.0
@description  Description of Theme
@namespace    https://github.com/fluteds
@author       Your Name
@homepageURL  https://github.com/fluteds/tttools
@supportURL   https://github.com/fluteds/tttools/issues/
@match        https://turntable.fm/*
@match        https://deepcut.fm/*
@updateURL    https://raw.githubusercontent.com/fluteds/tttools/link-to-your-theme
==/UserStyle== */

/* Your CSS styling */
body::before {
    content: "Hello World";
}

Javascript Meta for Tampermonkey

For submitting a Javascript addon use the following code block.
Note: Save your file as .user.js

// ==UserScript==
// @name         Name of Addon
// @namespace    http://tampermonkey.net/
// @version      1.0.0
// @description  Description of Addon
// @author       Your name
// @match        https://turntable.fm/*
// @match        https://deepcut.fm/*
// @updateURL    https://raw.githubusercontent.com/fluteds/tttools/link-to-addon
// @grant        none
// ==/UserScript==

// Your script
console.log('Hello World');
Clone this wiki locally