Merge branch 'master' of https://github.com/NathanDagDane/Clickett

NathanDagDane · Sep 30, 2024 · 658ea2b · 658ea2b
2 parents 31343cf + f7129c8
commit 658ea2b
Show file tree

Hide file tree

Showing 3 changed files with 301 additions and 26 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1,15 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: nathandane
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+polar: # Replace with a single Polar username
+buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
+thanks_dev: # Replace with a single thanks.dev username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,38 @@
+name: Bug Report
+description: File a bug report.
+title: "[Bug]:"
+labels: ["bug", "user"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details
+      description: How can we get in touch with you if we need more info?
+      placeholder: ex. [email protected]
+    validations:
+      required: false
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: A bug happened!
+    validations:
+      required: true
+  - type: dropdown
+    id: version
+    attributes:
+      label: Version
+      description: What version of Clickett are you running? You can check your version at the top of settings
+      options:
+        - 0.8.0
+        - 0.7.4
+        - Older
+        - "Can't check"
+      default: 0
+    validations:
+      required: true
diff --git a/README.md b/README.md
@@ -1,26 +1,248 @@
- [<img src="https://user-images.githubusercontent.com/93830135/151047902-40103e8a-5044-47bb-9ee2-92df1e33fac3.png" alt="Clickett" width="300"/>](https://nathandagdane.github.io/Clickett/)
-
-## A lightweight yet feature-packed auto clicker
-
-### Features
-- Customise clicking speed
-    - Choose clicks per second
-    - Type milliseconds, seconds and minutes interval
-- 3 autoclick modes
-    - Hold *(Clicking when the hotkey is pressed)*
-    - Toggle *(Starts and stops clicking when the hotkey is pressed)*
-    - Burst *(Clicks a specified number of times each time the hotkey is pressed)*
-- *(Actually)* Modern UI *(If I do say so myself)*
-- UI scaling and animations
-- Theme switching!
-- Choose screen location
-- Choose left, middle or right clicks
-- Always on top option
-- Choose autoclick hotkey
-- Hotkey active toggle
-- System startup and tray options
-- App cannot click on itself!
-
- [<img alt="Get from Microsoft store" width="200px" src="https://www.sharp-sbs.com/portals/0/assets/images/microsoft-badge.png" border-radius="101px"/>](https://www.microsoft.com/store/productId/9NW55MH6VMHG)
-
- [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/L4L0K0358)
+<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
+<a id="readme-top"></a>
+<!--
+*** Thanks for checking out the Best-README-Template. If you have a suggestion
+*** that would make this better, please fork the repo and create a pull request
+*** or simply open an issue with the tag "enhancement".
+*** Don't forget to give the project a star!
+*** Thanks again! Now go create something AMAZING! :D
+-->
+
+
+
+<!-- PROJECT SHIELDS -->
+<!--
+*** I'm using markdown "reference style" links for readability.
+*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
+*** See the bottom of this document for the declaration of the reference variables
+*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
+*** https://www.markdownguide.org/basic-syntax/#reference-style-links
+-->
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![LinkedIn][linkedin-shield]][linkedin-url]
+
+
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://clickett.app">
+    <img src="https://raw.githubusercontent.com/NathanDagDane/Clickett/refs/heads/master/res/iconround.png" alt="Logo" width="120" height="120">
+  </a>
+
+  <h3 align="center">Clickett</h3>
+
+  <p align="center">
+    The Next-Gen Auto Clicker
+    <br />
+    <a href="clickett.app"><strong>Go to Website »</strong></a>
+    <br />
+    <br />
+    <a href="https://ko-fi.com/L4L0K0358">
+      <img src="https://cdn.prod.website-files.com/5c14e387dab576fe667689cf/64f1a9ddd0246590df69ea1a_kofi_short_button_dark%25402x-p-500.png" alt="Support on Ko-fi" height="50">
+    </a>
+    <a href="https://www.microsoft.com/store/productId/9NW55MH6VMHG">
+      <img src="https://raw.githubusercontent.com/microsoft/app-store-badge/refs/heads/main/src/images/en-US%20dark.svg" alt="Download from Microsoft Store" height="50">
+    </a>
+    <br />
+    <br />
+    <a href="https://clickett.notion.site/10d6a3a1c22b80f6ad0ff5e1f4d90313?v=10d6a3a1c22b80e6a075000cd90e017c&pvs=4">Help Page</a>
+    ·
+    <a href="https://github.com/NathanDagDane/Clickett/issues/new?assignees=&labels=bug%2Cuser&projects=&template=bug_report.yml&title=%5BBug%5D%3A">Report Bug</a>
+  </p>
+</div>
+
+<br />
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+        <li><a href="#usage">Usage</a></li>
+      </ul>
+    </li>
+    <li><a href="#roadmap">Roadmap</a></li>
+    <li><a href="#contributing">Contributing</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+  </ol>
+</details>
+
+<br />
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+<br />
+<br />
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/NathanDagDane/Clickett/refs/heads/resources/screenshots/Clickett%20Enabled.png" alt="Clickett Screenshot" width="700">
+</div>
+
+<br />
+<br />
+
+**Clickett** is the **next-generation** auto clicker designed to automate repetitive clicking tasks with ease.
+
+* Click at a **specific speed**.
+* Set custom **hotkeys**.
+* Choose between different **clicking modes** (Hold, Toggle, Burst).
+* Utilize **multithreading** to click as fast as your computer can handle!
+
+Its intuitive interface allows for easy customization of click intervals and cursor locations.
+
+Ideal for gaming, productivity, and more.
+
+Clickett also includes advanced safety features and a sleek, modern UI for a seamless user experience.
+
+<br />
+
+### Built With
+
+Major frameworks/libraries used in this project.
+
+**Application**
+* [![WPF (Windows Presentation Foundation)](https://img.shields.io/badge/WPF-7f55e1?style=for-the-badge&logo=dotnet&link=https://github.com/dotnet/wpf)](https://github.com/dotnet/wpf)
+* [![Cs](https://img.shields.io/badge/sharp-007bff?style=for-the-badge&logo=c&logoColor=fff&link=https://learn.microsoft.com/en-us/dotnet/csharp/tour-of-csharp/)](https://learn.microsoft.com/en-us/dotnet/csharp/tour-of-csharp/)
+
+**Website**
+* [![Web Studio](https://img.shields.io/badge/Web%20Studio-11181c?style=for-the-badge&logo=webtrees&logoColor=fff&link=https://webstudio.is/)](https://webstudio.is/)
+* [![React][React.js]][React-url]
+* [![GSAP](https://img.shields.io/badge/GSAP-0ae448?style=for-the-badge&link=https://gsap.com/)](https://gsap.com/)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+Simple steps to get up and running with the Clickett auto clicker.
+
+### Prerequisites
+
+Clickett is a **Windows only** app. Ensure you have Windows 10/11 (or later). There are currently no MacOS, Linux, or mobile versions.
+
+### Installation
+
+> Clickett can be installed from the [Microsoft Store](https://www.microsoft.com/store/productId/9NW55MH6VMHG) or the [Clickett website](https://clickett.app).
+
+**Microsoft Store:**
+
+* Simply add to your account and install as usual.
+
+**Clickett website:**
+
+* Select your system version (arm or x64) if it is not automatically selected.
+* Click Download and downloading should begin automatically.
+* Run the downloaded file: `Clickett Setup.exe` and Clickett will launch automatically
+> If you selected the *portable* version before downloading, simply extract the `.zip` file and run the executable inside. This version of clickett still supports *auto-updating*.
+
+### Usage
+
+Clickett is **disabled** each time it is launched. Before you can click, you need to **enable** Clickett using the large button at the bottom. 
+
+Once Clickett is enabled, you can press the *hotkey* and it will start clicking.
+
+_For further steps, please refer to the [help page](https://clickett.app/help)_
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- ROADMAP -->
+## Roadmap
+
+- [x] Standalone Installer
+- [x] Auto-updater
+- [x] UI Remake/Refactor
+- [ ] Option Description on Hover
+- [ ] Implement MVVM for Multiple Models **(Important)**
+- [ ] Mouse-Button-Down Trigger
+- [ ] Add Themes
+- [ ] Optimise Pages
+    - [ ] Delete Settings View when Hidden
+    - [ ] Delete Tutorial/Intro View when Hidden
+
+See the [open issues](https://github.com/NathanDagDane/Clickett/issues) for a full list of proposed features (and known issues).
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- CONTRIBUTING -->
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+Don't forget to give the project a star! Thanks again!
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+### Top contributors:
+
+<a href="https://github.com/othneildrew/Best-README-Template/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=NathanDagDane/Clickett" alt="contrib.rocks image" />
+</a>
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- LICENSE -->
+## License
+
+Distributed under the GPL-3.0 License. See `LICENSE.txt` for more information.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- CONTACT -->
+## Contact
+
+Nathan Dane - [email protected]
+
+Project Link: [github.com/NathanDagDane/Clickett](https://github.com/NathanDagDane/Clickett)
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[contributors-shield]: https://img.shields.io/github/contributors/NathanDagDane/Clickett.svg?style=for-the-badge
+[contributors-url]: https://github.com/NathanDagDane/Clickett/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/NathanDagDane/Clickett.svg?style=for-the-badge
+[forks-url]: https://github.com/NathanDagDane/Clickett/network/members
+[stars-shield]: https://img.shields.io/github/stars/NathanDagDane/Clickett.svg?style=for-the-badge
+[stars-url]: https://github.com/NathanDagDane/Clickett/stargazers
+[issues-shield]: https://img.shields.io/github/issues/NathanDagDane/Clickett.svg?style=for-the-badge
+[issues-url]: https://github.com/NathanDagDane/Clickett/issues
+[license-shield]: https://img.shields.io/github/license/NathanDagDane/Clickett.svg?style=for-the-badge
+[license-url]: https://github.com/NathanDagDane/Clickett/blob/master/LICENSE.txt
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+[linkedin-url]: https://www.linkedin.com/in/nathan-dane/
+[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
+[React-url]: https://reactjs.org/