addons/godot_super-wakatime/README.md

   1
   2 <a id="readme-top"></a>
   3
   4 <!-- SHIELDS -->
   5 [![Contributors][contributors-shield]][contributors-url]
   6 [![Forks][forks-shield]][forks-url]
   7 [![Stargazers][stars-shield]][stars-url]
   8 [![Issues][issues-shield]][issues-url]
   9 [![MIT License][license-shield]][license-url]
  10
  11 <!-- HEADER -->
  12 <br />
  13 <div align="center">
  14     <a href="https://github.com/BudzioT/Godot_Super-Wakatime">
  15         <img src="https://cloud-bo1ln2br1-hack-club-bot.vercel.app/0godotwaka22.png"  alt="Godot Wakatime"/>
  16     </a>
  17     <h3 align="center"> Godot Super Wakatime </h3>
  18     <p align="center">
  19         Tool to measure time spent in loved by many people game engine - Godot
  20         <br />
  21         Officially approved to use in High Seas event created by Hack Club
  22         <br />
  23         <br />
  24         <a href="https://godotengine.org/asset-library/asset/3484">Get from Asset Lib</a>
  25         ·
  26         <a href="https://youtu.be/rqAc-YdVXyM">View Demo</a>
  27         ·
  28         <a href="https://github.com/BudzioT/Godot_Super-Wakatime/issues/new">Report Bug / Request Feature</a>
  29     </p>
  30 </div>
  31
  32 <!-- CONTENTS -->
  33 <details>
  34     <summary>Table of Contents</summary>
  35     <ol>
  36         <li>
  37             <a href="#about">About The Project</a>
  38             <ul>
  39                 <li><a href="#built-with">Built Using</a></li>
  40             </ul>
  41         </li>
  42         <li>
  43             <a href="#getting-started">Getting Started</a>
  44             <ul>
  45                 <li><a href="#installation">Installation</a></li>
  46             </ul>
  47         </li>
  48         <li><a href="#usage">Usage</a></li>
  49         <li><a href="#license">License</a></li>
  50     </ol>
  51 </details>
  52
  53
  54 <!-- ABOUT -->
  55 ## About The Project
  56 <br />
  57
  58 [![Product Screenshot][product-screenshot]](https://waka.hackclub.com)
  59
  60 This tool can successfully measure time spent building your games or apps in Godot.
  61 <br />
  62 Here's why:
  63 * It differentiates between switching a scene and script
  64 * It counts key presses as coding and mouse clicks as building scene
  65 * Changing scene structure results in a heartbeat sent
  66 * It correctly detects OS, machine name, language, editor, files
  67 * It can detect your cursor line and position
  68 * Time is split between: Building, Coding, Testing
  69 * In the future it will also detect testing your projects
  70
  71 It works on both Linux and Windows, it wasn't tested on macOS yet
  72 <br />
  73 You can also see your time spent in the editor itself:
  74 [![Time in editor][time-screenshot]]
  75
  76 <p align="right">(<a href="#readme-top">top</a>)</p>
  77
  78
  79 ### Built Using
  80 I used the Ouch! CLI tool for decompression of files <br />
  81 This project was built using one simple, yet powerful language.<br />
  82 It required a lot of workarounds, but it was a pleasure to use it
  83 * [![GDScript][Godot]][Godot-url]
  84 * [![Ouch!][Ouch-shield]][Ouch-url]
  85
  86 <p align="right">(<a href="#readme-top">top</a>)</p>
  87
  88 <!-- GETTING STARTED -->
  89 ## Getting Started
  90 How to install and use this software? It's easy!
  91
  92 ### Installation
  93 You can either download it from asset lib (will provide a link, once it gets accepted)
  94 <br />Or you can manually install it, here's how to do it!
  95 1. Clone the repository
  96     ```sh
  97     git clone https://github.com/BudzioT/Godot_Super-Wakatime.git
  98     ```
  99 2. Go into your project
 100 3. Insert the entire `./addons` folder into your project `res://` directory
 101
 102 <p align="right">(<a href="#readme-top">top</a>)</p>
 103
 104 <!-- USAGE -->
 105 ## Usage
 106 Don't know how to use this plugin? Here are the steps:
 107 1. Turn on the plugin in your plugins. In your `Project -> Project Settings -> Plugins -> `Click the `Enable` checkbox near this plugin
 108 2. If prompted for API key, provide it from Wakatime website
 109 3. if there is an issue with it, please manually create `~/.wakatime.cfg` file with these contents:
 110     ```sh
 111     [settings]
 112     api_key=xxxx
 113     ```
 114     Where xxxx is your api key
 115 <br /><br />
 116 If you are coming from High Seas used this:
 117     ```sh
 118     [settings]
 119     api_url = https://waka.hackclub.com/api
 120     api_key=xxxx
 121     ```
 122 4. Wakatime CLI should have been installed automatically along with Ouch! Decompression library
 123 5. Work on your project! You should see your results on either Wakatime or Hackatime!
 124 6. You can also see your time at the bottom panel
 125
 126 <p align="right">(<a href="#readme-top">top</a>)</p>
 127
 128 <!-- LICENSE -->
 129 ## License
 130
 131 Distributed under the MIT License. See `LICENSE` for more information.
 132
 133 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 134
 135
 136 <!-- URLS -->
 137 [contributors-shield]: https://img.shields.io/github/contributors/budziot/Godot_Super-Wakatime?style=for-the-badge
 138 [contributors-url]: https://github.com/BudzioT/Godot_Super-Wakatime/graphs/contributors
 139 [forks-shield]: https://img.shields.io/github/forks/budziot/Godot_Super-Wakatime?style=for-the-badge
 140 [forks-url]: https://github.com/BudzioT/Godot_Super-Wakatime/forks
 141 [stars-shield]: https://img.shields.io/github/stars/budziot/Godot_Super-Wakatime?style=for-the-badge
 142 [stars-url]: https://github.com/BudzioT/Godot_Super-Wakatime/stargazers
 143 [issues-shield]: https://img.shields.io/github/issues/budziot/Godot_Super-Wakatime?style=for-the-badge
 144 [issues-url]: https://github.com/BudzioT/Godot_Super-Wakatime/issues
 145 [license-shield]: https://img.shields.io/github/license/budziot/Godot_Super-Wakatime?style=for-the-badge
 146 [license-url]: https://github.com/BudzioT/Godot_Super-Wakatime/blob/master/addons/godot_super-wakatime/LICENSE
 147 [product-screenshot]: https://cloud-j4wibbzz7-hack-club-bot.vercel.app/0image.png
 148 [product-logo]: https://cloud-j4wibbzz7-hack-club-bot.vercel.app/2godotwaka2.png
 149 [Godot]: https://img.shields.io/badge/Godot%20Engine-478CBF?logo=godotengine&logoColor=fff&style=flat
 150 [Godot-url]: https://godotengine.org/
 151 [Ouch-shield]: https://img.shields.io/badge/Ouch!-tool-blue?label=Ouch!
 152 [Ouch-url]: https://github.com/ouch-org/ouch
 153 [time-screenshot]: https://cloud-l88kldf50-hack-club-bot.vercel.app/0image.png