https://github.com/foso/gtvmonkey-scripts

This a template project that helps you write Greasemonkey/Tampermonkey/ViolentMonkey scripts with KotlinJs
https://github.com/foso/gtvmonkey-scripts

greasemonkey kotlin kotlinjs tampermonkey userscripts violentmonkey

Last synced: 9 months ago
JSON representation

This a template project that helps you write Greasemonkey/Tampermonkey/ViolentMonkey scripts with KotlinJs

• Host: GitHub
• URL: https://github.com/foso/gtvmonkey-scripts
• Owner: Foso
• License: apache-2.0
• Created: 2020-10-17T07:34:14.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-02-26T07:47:56.000Z (11 months ago)
• Last Synced: 2025-03-25T20:22:13.302Z (10 months ago)
• Topics: greasemonkey, kotlin, kotlinjs, tampermonkey, userscripts, violentmonkey
• Language: Kotlin
• Homepage:
• Size: 167 KB
• Stars: 18
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Grease/Tamper/Violent-Monkey scripts with KotlinJs

This a template project that helps you write Greasemonkey/Tampermonkey/ViolentMonkey scripts with KotlinJs

### Show some :heart: and star the repo to support the project

[![GitHub stars](https://img.shields.io/github/stars/Foso/gtvmonkey-scripts.svg?style=social&label=Star)](https://github.com/Foso/gtvmonkey-scripts) [![GitHub forks](https://img.shields.io/github/forks/Foso/gtvmonkey-scripts.svg?style=social&label=Fork)](https://github.com/Foso/gtvmonkey-scripts/fork)  [![Twitter Follow](https://img.shields.io/twitter/follow/jklingenberg_.svg?style=social)](https://twitter.com/jklingenberg_)

## How does it work?

### Gradle

I configured a Gradle task [**buildUserScript**](https://github.com/Foso/gtvmonkey-scripts/blob/2ae1766cad85e847c93ae4cab894898115f191e4/build.gradle.kts#L32) that will generate a userscript file.

The task will concat the script metadata from main/resources/metadata.txt, the **kotlin.js** and your generated javascript file. 

Then it will append **main();** to the script, which will execute the main() of your Kotlin Code.

The script will be outputed to /build/distributions/$NAMEOFYOURGRADLEPROJECT.user.js

The gradle task will be triggered after every Gradle **build** task

### Metadata

You can configure the metadata of your userscript inside [/src/main/resources/metadata.txt](https://github.com/Foso/gtvmonkey-scripts/blob/master/src/main/resources/metadata.txt)

## Kotlin

Write your Kotlin Code inside **src/main/kotlin**. The **main()** will be executed first by the userscript.

## Hot Reload

When you use **gradle -t build** inside your project folder, Gradle will detect all changes to your Kotlin Code and metadata.txt file, and will compile and generate a new userscript on every change. The detection of changes on the userscript depends on your used addon. E.g. Violentmonkey supports tracking of file changes in Chrome (https://violentmonkey.github.io/posts/how-to-edit-scripts-with-your-favorite-editor/) and it can detect changes on a new generated userscript.

## Example

Let's create a script thats alerts "Hello GitHub" on every page of GitHub.

Add this inside your /main/resources/metadata.txt

```kotlin

// ==UserScript==

// @name        MyNew script - KotlinJs

// @namespace   GtvMonkey Scripts

// @grant       none

// @version     1.0

// @author      -

// @description 10/16/2020, 9:43:07 PM

// @include     https://github.com/*

// ==/UserScript==

```

You can find out more about the Metadata section [HERE](https://wiki.greasespot.net/Metadata_Block)

This is your Kotlin Code

```kotlin

fun main() {

    window.alert("Hello Github!")

}

```

Run the **build** task of Gradle and you will find a *.user.js inside /build/distributions.

Add this file to your wanted userscript browser addon and you are done.

## 📜 License

This project is licensed under the Apache License, Version 2.0 - see the [LICENSE.md](https://github.com/Foso/gtvmonkey-scripts/blob/master/LICENSE) file for details

-------

    Copyright 2020 Jens Klingenberg

    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.