here
This commit is contained in:
poncethecat
parent
65f9e84a61
commit
c7da820b5d
3
docs/Gemfile
Normal file
3
docs/Gemfile
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
source 'https://rubygems.org'
|
||||||
|
|
||||||
|
gem "github-pages", group: :jekyll_plugins
|
||||||
216
docs/Gemfile.lock
Normal file
216
docs/Gemfile.lock
Normal file
@ -0,0 +1,216 @@
|
|||||||
|
GEM
|
||||||
|
remote: https://rubygems.org/
|
||||||
|
specs:
|
||||||
|
activesupport (4.2.8)
|
||||||
|
i18n (~> 0.7)
|
||||||
|
minitest (~> 5.1)
|
||||||
|
thread_safe (~> 0.3, >= 0.3.4)
|
||||||
|
tzinfo (~> 1.1)
|
||||||
|
addressable (2.5.1)
|
||||||
|
public_suffix (~> 2.0, >= 2.0.2)
|
||||||
|
coffee-script (2.4.1)
|
||||||
|
coffee-script-source
|
||||||
|
execjs
|
||||||
|
coffee-script-source (1.12.2)
|
||||||
|
colorator (1.1.0)
|
||||||
|
ethon (0.10.1)
|
||||||
|
ffi (>= 1.3.0)
|
||||||
|
execjs (2.7.0)
|
||||||
|
faraday (0.13.0)
|
||||||
|
multipart-post (>= 1.2, < 3)
|
||||||
|
ffi (1.9.18)
|
||||||
|
forwardable-extended (2.6.0)
|
||||||
|
gemoji (3.0.0)
|
||||||
|
github-pages (155)
|
||||||
|
activesupport (= 4.2.8)
|
||||||
|
github-pages-health-check (= 1.3.5)
|
||||||
|
jekyll (= 3.5.2)
|
||||||
|
jekyll-avatar (= 0.4.2)
|
||||||
|
jekyll-coffeescript (= 1.0.1)
|
||||||
|
jekyll-default-layout (= 0.1.4)
|
||||||
|
jekyll-feed (= 0.9.2)
|
||||||
|
jekyll-gist (= 1.4.1)
|
||||||
|
jekyll-github-metadata (= 2.8.0)
|
||||||
|
jekyll-mentions (= 1.2.0)
|
||||||
|
jekyll-optional-front-matter (= 0.2.0)
|
||||||
|
jekyll-paginate (= 1.1.0)
|
||||||
|
jekyll-readme-index (= 0.1.0)
|
||||||
|
jekyll-redirect-from (= 0.12.1)
|
||||||
|
jekyll-relative-links (= 0.4.1)
|
||||||
|
jekyll-sass-converter (= 1.5.0)
|
||||||
|
jekyll-seo-tag (= 2.2.3)
|
||||||
|
jekyll-sitemap (= 1.0.0)
|
||||||
|
jekyll-swiss (= 0.4.0)
|
||||||
|
jekyll-theme-architect (= 0.1.0)
|
||||||
|
jekyll-theme-cayman (= 0.1.0)
|
||||||
|
jekyll-theme-dinky (= 0.1.0)
|
||||||
|
jekyll-theme-hacker (= 0.1.0)
|
||||||
|
jekyll-theme-leap-day (= 0.1.0)
|
||||||
|
jekyll-theme-merlot (= 0.1.0)
|
||||||
|
jekyll-theme-midnight (= 0.1.0)
|
||||||
|
jekyll-theme-minimal (= 0.1.0)
|
||||||
|
jekyll-theme-modernist (= 0.1.0)
|
||||||
|
jekyll-theme-primer (= 0.5.0)
|
||||||
|
jekyll-theme-slate (= 0.1.0)
|
||||||
|
jekyll-theme-tactile (= 0.1.0)
|
||||||
|
jekyll-theme-time-machine (= 0.1.0)
|
||||||
|
jekyll-titles-from-headings (= 0.4.0)
|
||||||
|
jemoji (= 0.8.0)
|
||||||
|
kramdown (= 1.13.2)
|
||||||
|
liquid (= 4.0.0)
|
||||||
|
listen (= 3.0.6)
|
||||||
|
mercenary (~> 0.3)
|
||||||
|
minima (= 2.1.1)
|
||||||
|
rouge (= 1.11.1)
|
||||||
|
terminal-table (~> 1.4)
|
||||||
|
github-pages-health-check (1.3.5)
|
||||||
|
addressable (~> 2.3)
|
||||||
|
net-dns (~> 0.8)
|
||||||
|
octokit (~> 4.0)
|
||||||
|
public_suffix (~> 2.0)
|
||||||
|
typhoeus (~> 0.7)
|
||||||
|
html-pipeline (2.7.0)
|
||||||
|
activesupport (>= 2)
|
||||||
|
nokogiri (>= 1.4)
|
||||||
|
i18n (0.8.6)
|
||||||
|
jekyll (3.5.2)
|
||||||
|
addressable (~> 2.4)
|
||||||
|
colorator (~> 1.0)
|
||||||
|
jekyll-sass-converter (~> 1.0)
|
||||||
|
jekyll-watch (~> 1.1)
|
||||||
|
kramdown (~> 1.3)
|
||||||
|
liquid (~> 4.0)
|
||||||
|
mercenary (~> 0.3.3)
|
||||||
|
pathutil (~> 0.9)
|
||||||
|
rouge (~> 1.7)
|
||||||
|
safe_yaml (~> 1.0)
|
||||||
|
jekyll-avatar (0.4.2)
|
||||||
|
jekyll (~> 3.0)
|
||||||
|
jekyll-coffeescript (1.0.1)
|
||||||
|
coffee-script (~> 2.2)
|
||||||
|
jekyll-default-layout (0.1.4)
|
||||||
|
jekyll (~> 3.0)
|
||||||
|
jekyll-feed (0.9.2)
|
||||||
|
jekyll (~> 3.3)
|
||||||
|
jekyll-gist (1.4.1)
|
||||||
|
octokit (~> 4.2)
|
||||||
|
jekyll-github-metadata (2.8.0)
|
||||||
|
jekyll (~> 3.1)
|
||||||
|
octokit (~> 4.0, != 4.4.0)
|
||||||
|
jekyll-mentions (1.2.0)
|
||||||
|
activesupport (~> 4.0)
|
||||||
|
html-pipeline (~> 2.3)
|
||||||
|
jekyll (~> 3.0)
|
||||||
|
jekyll-optional-front-matter (0.2.0)
|
||||||
|
jekyll (~> 3.0)
|
||||||
|
jekyll-paginate (1.1.0)
|
||||||
|
jekyll-readme-index (0.1.0)
|
||||||
|
jekyll (~> 3.0)
|
||||||
|
jekyll-redirect-from (0.12.1)
|
||||||
|
jekyll (~> 3.3)
|
||||||
|
jekyll-relative-links (0.4.1)
|
||||||
|
jekyll (~> 3.3)
|
||||||
|
jekyll-sass-converter (1.5.0)
|
||||||
|
sass (~> 3.4)
|
||||||
|
jekyll-seo-tag (2.2.3)
|
||||||
|
jekyll (~> 3.3)
|
||||||
|
jekyll-sitemap (1.0.0)
|
||||||
|
jekyll (~> 3.3)
|
||||||
|
jekyll-swiss (0.4.0)
|
||||||
|
jekyll-theme-architect (0.1.0)
|
||||||
|
jekyll (~> 3.5)
|
||||||
|
jekyll-seo-tag (~> 2.0)
|
||||||
|
jekyll-theme-cayman (0.1.0)
|
||||||
|
jekyll (~> 3.5)
|
||||||
|
jekyll-seo-tag (~> 2.0)
|
||||||
|
jekyll-theme-dinky (0.1.0)
|
||||||
|
jekyll (~> 3.5)
|
||||||
|
jekyll-seo-tag (~> 2.0)
|
||||||
|
jekyll-theme-hacker (0.1.0)
|
||||||
|
jekyll (~> 3.5)
|
||||||
|
jekyll-seo-tag (~> 2.0)
|
||||||
|
jekyll-theme-leap-day (0.1.0)
|
||||||
|
jekyll (~> 3.5)
|
||||||
|
jekyll-seo-tag (~> 2.0)
|
||||||
|
jekyll-theme-merlot (0.1.0)
|
||||||
|
jekyll (~> 3.5)
|
||||||
|
jekyll-seo-tag (~> 2.0)
|
||||||
|
jekyll-theme-midnight (0.1.0)
|
||||||
|
jekyll (~> 3.5)
|
||||||
|
jekyll-seo-tag (~> 2.0)
|
||||||
|
jekyll-theme-minimal (0.1.0)
|
||||||
|
jekyll (~> 3.5)
|
||||||
|
jekyll-seo-tag (~> 2.0)
|
||||||
|
jekyll-theme-modernist (0.1.0)
|
||||||
|
jekyll (~> 3.5)
|
||||||
|
jekyll-seo-tag (~> 2.0)
|
||||||
|
jekyll-theme-primer (0.5.0)
|
||||||
|
jekyll (~> 3.5)
|
||||||
|
jekyll-seo-tag (~> 2.2)
|
||||||
|
jekyll-theme-slate (0.1.0)
|
||||||
|
jekyll (~> 3.5)
|
||||||
|
jekyll-seo-tag (~> 2.0)
|
||||||
|
jekyll-theme-tactile (0.1.0)
|
||||||
|
jekyll (~> 3.5)
|
||||||
|
jekyll-seo-tag (~> 2.0)
|
||||||
|
jekyll-theme-time-machine (0.1.0)
|
||||||
|
jekyll (~> 3.5)
|
||||||
|
jekyll-seo-tag (~> 2.0)
|
||||||
|
jekyll-titles-from-headings (0.4.0)
|
||||||
|
jekyll (~> 3.3)
|
||||||
|
jekyll-watch (1.5.0)
|
||||||
|
listen (~> 3.0, < 3.1)
|
||||||
|
jemoji (0.8.0)
|
||||||
|
activesupport (~> 4.0)
|
||||||
|
gemoji (~> 3.0)
|
||||||
|
html-pipeline (~> 2.2)
|
||||||
|
jekyll (>= 3.0)
|
||||||
|
kramdown (1.13.2)
|
||||||
|
liquid (4.0.0)
|
||||||
|
listen (3.0.6)
|
||||||
|
rb-fsevent (>= 0.9.3)
|
||||||
|
rb-inotify (>= 0.9.7)
|
||||||
|
mercenary (0.3.6)
|
||||||
|
mini_portile2 (2.2.0)
|
||||||
|
minima (2.1.1)
|
||||||
|
jekyll (~> 3.3)
|
||||||
|
minitest (5.10.3)
|
||||||
|
multipart-post (2.0.0)
|
||||||
|
net-dns (0.8.0)
|
||||||
|
nokogiri (1.8.0)
|
||||||
|
mini_portile2 (~> 2.2.0)
|
||||||
|
octokit (4.7.0)
|
||||||
|
sawyer (~> 0.8.0, >= 0.5.3)
|
||||||
|
pathutil (0.14.0)
|
||||||
|
forwardable-extended (~> 2.6)
|
||||||
|
public_suffix (2.0.5)
|
||||||
|
rb-fsevent (0.10.2)
|
||||||
|
rb-inotify (0.9.10)
|
||||||
|
ffi (>= 0.5.0, < 2)
|
||||||
|
rouge (1.11.1)
|
||||||
|
safe_yaml (1.0.4)
|
||||||
|
sass (3.5.1)
|
||||||
|
sass-listen (~> 4.0.0)
|
||||||
|
sass-listen (4.0.0)
|
||||||
|
rb-fsevent (~> 0.9, >= 0.9.4)
|
||||||
|
rb-inotify (~> 0.9, >= 0.9.7)
|
||||||
|
sawyer (0.8.1)
|
||||||
|
addressable (>= 2.3.5, < 2.6)
|
||||||
|
faraday (~> 0.8, < 1.0)
|
||||||
|
terminal-table (1.8.0)
|
||||||
|
unicode-display_width (~> 1.1, >= 1.1.1)
|
||||||
|
thread_safe (0.3.6)
|
||||||
|
typhoeus (0.8.0)
|
||||||
|
ethon (>= 0.8.0)
|
||||||
|
tzinfo (1.2.3)
|
||||||
|
thread_safe (~> 0.1)
|
||||||
|
unicode-display_width (1.3.0)
|
||||||
|
|
||||||
|
PLATFORMS
|
||||||
|
ruby
|
||||||
|
|
||||||
|
DEPENDENCIES
|
||||||
|
github-pages
|
||||||
|
|
||||||
|
BUNDLED WITH
|
||||||
|
1.15.3
|
||||||
@ -1 +1,2 @@
|
|||||||
theme: jekyll-theme-minimal
|
theme: jekyll-theme-minimal
|
||||||
|
categories: [wiki]
|
||||||
|
|||||||
66
docs/_layouts/layout.html
Normal file
66
docs/_layouts/layout.html
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="{{ site.lang | default: "en-US" }}">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||||
|
|
||||||
|
{% seo %}
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
|
||||||
|
<meta name="viewport" content="width=device-width">
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div class="wrapper">
|
||||||
|
<header>
|
||||||
|
<h1>{{ site.title | default: site.github.repository_name }}</h1>
|
||||||
|
<p>{{ site.description | default: site.github.project_tagline }}</p>
|
||||||
|
<p><a href="/wiki">Click here to visit the wiki</a></p>
|
||||||
|
|
||||||
|
{% if site.github.is_project_page %}
|
||||||
|
<p class="view"><a href="{{ site.github.repository_url }}">View the Project on GitHub <small>{{ github_name }}</small></a></p>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if site.github.is_user_page %}
|
||||||
|
<p class="view"><a href="{{ site.github.owner_url }}">View My GitHub Profile</a></p>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if site.show_downloads %}
|
||||||
|
<ul>
|
||||||
|
<li><a href="{{ site.github.zip_url }}">Download <strong>ZIP File</strong></a></li>
|
||||||
|
<li><a href="{{ site.github.tar_url }}">Download <strong>TAR Ball</strong></a></li>
|
||||||
|
<li><a href="{{ site.github.repository_url }}">View On <strong>GitHub</strong></a></li>
|
||||||
|
</ul>
|
||||||
|
{% endif %}
|
||||||
|
</header>
|
||||||
|
<section>
|
||||||
|
|
||||||
|
{{ content }}
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<footer>
|
||||||
|
<p>Copyright (c) ArsenArsen 2017</p>
|
||||||
|
{% if site.github.is_project_page %}
|
||||||
|
<p>This project is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p>
|
||||||
|
{% endif %}
|
||||||
|
<p><small>Hosted on GitHub Pages — Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
|
||||||
|
</footer>
|
||||||
|
</div>
|
||||||
|
<script src="{{ '/assets/js/scale.fix.js' | relative_url }}"></script>
|
||||||
|
|
||||||
|
|
||||||
|
{% if site.google_analytics %}
|
||||||
|
<script>
|
||||||
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||||
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||||
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||||
|
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||||
|
|
||||||
|
ga('create', '{{ site.google_analytics }}', 'auto');
|
||||||
|
ga('send', 'pageview');
|
||||||
|
</script>
|
||||||
|
{% endif %}
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
77
docs/_layouts/wikipage.html
Normal file
77
docs/_layouts/wikipage.html
Normal file
@ -0,0 +1,77 @@
|
|||||||
|
<!doctype html>
|
||||||
|
<html lang="{{ site.lang | default: "en-US" }}">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
||||||
|
|
||||||
|
{% seo %}
|
||||||
|
|
||||||
|
<link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
|
||||||
|
<meta name="viewport" content="width=device-width">
|
||||||
|
<!--[if lt IE 9]>
|
||||||
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||||
|
<![endif]-->
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div class="wrapper">
|
||||||
|
<header>
|
||||||
|
<h1>{{ site.title | default: site.github.repository_name }}</h1>
|
||||||
|
<p>{{ site.description | default: site.github.project_tagline }}</p>
|
||||||
|
<p><a href="/">Click here to go back to the homepage</a></p>
|
||||||
|
<p>Wiki Pages:</p>
|
||||||
|
<ul>
|
||||||
|
{% for page in site.pages %}
|
||||||
|
{% if page.categories contains 'wiki' %}
|
||||||
|
<li><a href="{{ page.url }}">{{ page.title }}</a></li>
|
||||||
|
{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
|
||||||
|
<br>
|
||||||
|
<br>
|
||||||
|
{% if site.github.is_project_page %}
|
||||||
|
<p class="view"><a href="{{ site.github.repository_url }}">View the Project on GitHub <small>{{ github_name }}</small></a></p>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if site.github.is_user_page %}
|
||||||
|
<p class="view"><a href="{{ site.github.owner_url }}">View My GitHub Profile</a></p>
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
{% if site.show_downloads %}
|
||||||
|
<ul>
|
||||||
|
<li><a href="{{ site.github.zip_url }}">Download <strong>ZIP File</strong></a></li>
|
||||||
|
<li><a href="{{ site.github.tar_url }}">Download <strong>TAR Ball</strong></a></li>
|
||||||
|
<li><a href="{{ site.github.repository_url }}">View On <strong>GitHub</strong></a></li>
|
||||||
|
</ul>
|
||||||
|
{% endif %}
|
||||||
|
</header>
|
||||||
|
<section>
|
||||||
|
|
||||||
|
{{ content }}
|
||||||
|
|
||||||
|
</section>
|
||||||
|
<footer>
|
||||||
|
<p>Copyright (c) ArsenArsen 2017</p>
|
||||||
|
{% if site.github.is_project_page %}
|
||||||
|
<p>This project is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a></p>
|
||||||
|
{% endif %}
|
||||||
|
<p><small>Hosted on GitHub Pages — Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
|
||||||
|
</footer>
|
||||||
|
</div>
|
||||||
|
<script src="{{ '/assets/js/scale.fix.js' | relative_url }}"></script>
|
||||||
|
|
||||||
|
|
||||||
|
{% if site.google_analytics %}
|
||||||
|
<script>
|
||||||
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||||
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||||
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||||
|
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||||
|
|
||||||
|
ga('create', '{{ site.google_analytics }}', 'auto');
|
||||||
|
ga('send', 'pageview');
|
||||||
|
</script>
|
||||||
|
{% endif %}
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
13
docs/assets/css/style.scss
Normal file
13
docs/assets/css/style.scss
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
---
|
||||||
|
---
|
||||||
|
|
||||||
|
@import "{{ site.theme }}";
|
||||||
|
|
||||||
|
/* stupid css killed the cat */
|
||||||
|
header ul {
|
||||||
|
background: none;
|
||||||
|
border-radius: 0px;
|
||||||
|
border: 0px solid #e0e0e0;
|
||||||
|
|
||||||
|
|
||||||
|
}
|
||||||
@ -1,3 +1,8 @@
|
|||||||
|
---
|
||||||
|
layout: layout
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
# **KShare**
|
# **KShare**
|
||||||
## The free open source and cross platform screen sharing software
|
## The free open source and cross platform screen sharing software
|
||||||
###### Inspired by [ShareX](https://getsharex.com)
|
###### Inspired by [ShareX](https://getsharex.com)
|
||||||
42
docs/wiki/Basic-usage.md
Normal file
42
docs/wiki/Basic-usage.md
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
---
|
||||||
|
title: Basic Usage
|
||||||
|
categories: [wiki]
|
||||||
|
layout: wikipage
|
||||||
|
---
|
||||||
|
# Basic usage
|
||||||
|
When you start the app (with no arguments, discussed later) a window is popped up, and a tray icon is made.
|
||||||
|
|
||||||
|
## The window
|
||||||
|
|
||||||
|
|
||||||
|
The main window is a log window with a settings button.
|
||||||
|
|
||||||
|
The menu bar has a `File` menu. It has two options, `Quit`, which exits ~~no need to press it :^)~~, and `About`, which contains licensing information:
|
||||||
|
|
||||||
|
|
||||||
|
There is a second menu, namely `Screenshot`. It has two options, area, and fullscreen capture. See below.
|
||||||
|
|
||||||
|
The third, `Utility`, menu has the color picker in it.
|
||||||
|
|
||||||
|
The third and final menu, `Recording`, has a start and stop recording button.
|
||||||
|
|
||||||
|
## The tray
|
||||||
|
|
||||||
|
|
||||||
|
The tray consists of a small, but nice, icon made by @BriannaFoxwell. Upon right clicking it you get the context menu shown above. The menu is rather simple, containing basic controls, and screenshotting options.
|
||||||
|
These options will be explained below.
|
||||||
|
|
||||||
|
## Screenshotting options
|
||||||
|
### Area capture
|
||||||
|
Area capture takes a snapshot of the screen, and shows you a fullscreen editor for you to select a region in. This editor is explained in a section below.
|
||||||
|
|
||||||
|
### Fullscreen capture
|
||||||
|
Fullscreen capture takes a snapshot of the entire screen and skips the editor part. Straight to the destination (explained later as well).
|
||||||
|
|
||||||
|
### Active window capture
|
||||||
|
Takes the active window and uploads it straight to your destination of choice
|
||||||
|
|
||||||
|
## Crop Editor
|
||||||
|
Crop Editor is a window you can use to select the area of the screen to upload. It consists of a grey overlay and a re-sizable rectangle. The rectangle is resized by holding the mouse buttons. When you let go of the button, a new selection will start replacing the old one. On the first press the same thing happens.
|
||||||
|
Press `Escape` to cancel, and `Return`, or `Enter` to submit.
|
||||||
|
Oh. And you can draw with right click.
|
||||||
44
docs/wiki/Destinations.md
Normal file
44
docs/wiki/Destinations.md
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
---
|
||||||
|
title: Destinations
|
||||||
|
categories: [wiki]
|
||||||
|
layout: wikipage
|
||||||
|
---
|
||||||
|
# Destinations
|
||||||
|
Destinations determine where your image goes
|
||||||
|
|
||||||
|
There is a set of default uploaders, two, to be exact.
|
||||||
|
## Default uploaders:
|
||||||
|
### imgur
|
||||||
|
Uploads your image to imgur.
|
||||||
|
### clipboard
|
||||||
|
Copies your image to clipboard.
|
||||||
|
|
||||||
|
## Custom uploaders
|
||||||
|
Placed into `CONFIG PATH/KShare/uploaders`
|
||||||
|
Eg: `$HOME/.config/KShare/uploaders`
|
||||||
|
All uploaders have to be `.uploader` files!
|
||||||
|
Custom uploaders can be added, and are made with JSON, and follow this template:
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
"name": "", // String, required
|
||||||
|
"desc": "", // String, optional
|
||||||
|
"method": "", // String, default: "POST", for now, just POST. Request more if you need them
|
||||||
|
"target": "", // URL, required
|
||||||
|
"format": "", // String, default: "json", can be `x-www-form-urlencoded` or `json` or `multipart-form-data`. Setting to `PLAIN` will make the body ignored and only the image sent.
|
||||||
|
"base64": false, // Optional, makes the data base64
|
||||||
|
"body": {}, // A JSON object, where one of the nodes can be a string in the format `/ANYTHING/`. In `ANYTHING`, `%contenttype` is replaced with the image type and `%imagedata` is replaced with the image encoded with `imageformat`. Unless you use multipart, see below
|
||||||
|
"return": "" // Return pathspec. `|` copies the entire body, `.path.to.node` copies the value of the node. The dot IS IMPORTANT. Without it, nothing happens. If one of the nodes is not a string, the string is copied, if one is an object, recursion continues, if one is null, nothing is copied, otherwise the node is JSON stringified. Only supports JSON for now.
|
||||||
|
}
|
||||||
|
```
|
||||||
|
Note that QJson does not support comments.
|
||||||
|
### Multipart
|
||||||
|
Multipart is obviously made out of multiple parts. The way you define a multipart body is:
|
||||||
|
```js
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"__HeaderName": "HeaderValue", // No limit here. Must start with __, which is removed later.
|
||||||
|
"body": { /* same way you define it for anything json */ } // Can be string. Strings matching `/.../` are processed same way as in a json field.
|
||||||
|
}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
This would go in the `body` field of the above JSON.
|
||||||
29
docs/wiki/Encoder-settings.md
Normal file
29
docs/wiki/Encoder-settings.md
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
---
|
||||||
|
title: Encoder Settings
|
||||||
|
categories: [wiki]
|
||||||
|
layout: wikipage
|
||||||
|
---
|
||||||
|
# Encoder settings
|
||||||
|
The encoders used can be customized to a high degree. Every encoder besides GIF has some settings.
|
||||||
|
|
||||||
|
|
||||||
|
## Image encoder settings
|
||||||
|
The only option here is quality, by default it uses the default for the format you use. You can change it by unticking format default. [More info](http://doc.qt.io/qt-5/qpixmap.html#save)
|
||||||
|
|
||||||
|
## Video encoder settings
|
||||||
|
The common settings are bitrate and GOP size.
|
||||||
|
|
||||||
|
GOP Size is the size of a group of pictures.
|
||||||
|
Bitrate is the target bitrate.
|
||||||
|
|
||||||
|
### h264/h265
|
||||||
|
The H.26[45] MP4 codec has a few presets to choose. The recommended is to choose the slowest one you can cope with.
|
||||||
|
I recommend medium.
|
||||||
|
|
||||||
|
CRF is the constant rate factor of this video stream, and again I recommend leaving the default value, `23`.
|
||||||
|
|
||||||
|
### VP9
|
||||||
|
VP9 is the WebP codec. Only option it has is lossless encoding, and you want it off, trust me.
|
||||||
|
|
||||||
|
### GIF
|
||||||
|
GIF has no options.
|
||||||
23
docs/wiki/Hotkeys.md
Normal file
23
docs/wiki/Hotkeys.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
---
|
||||||
|
title: Hotkeys
|
||||||
|
categories: [wiki]
|
||||||
|
layout: wikipage
|
||||||
|
---
|
||||||
|
# Hotkeys
|
||||||
|
Hotkeys are configured in the settings UI.
|
||||||
|
|
||||||
|
Currently available hotkeys are:
|
||||||
|
## Fullscreen image
|
||||||
|
This bind lets you take a fullscreen image and upload it instantly.
|
||||||
|
## Area image
|
||||||
|
Equivalent to `Take area shot` and `Screenshot -> Area`. Takes a snapshot and opens the crop editor.
|
||||||
|
## Active window
|
||||||
|
Equivalent to `Active window` and `Screenshot -> Active window`. Takes a snapshot of the active window and sends it.
|
||||||
|
## Color picker
|
||||||
|
Opens the color picker
|
||||||
|
## Recording start/stop
|
||||||
|
Starts and stops recording
|
||||||
|
|
||||||
|
## Editing hotkeys
|
||||||
|
All binds can be modified using by double clicking the hotkey name.
|
||||||
|
You can either type the hotkey in or press record and press the key combination you want on your keyboard
|
||||||
23
docs/wiki/Settings.md
Normal file
23
docs/wiki/Settings.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
---
|
||||||
|
title: Settings
|
||||||
|
categories: [wiki]
|
||||||
|
layout: wikipage
|
||||||
|
---
|
||||||
|
# Settings
|
||||||
|
## Destination
|
||||||
|
|
||||||
|
Select the active destination. Adding more is possible and explained it Custom Uploaders
|
||||||
|
**Default:** `imgur`
|
||||||
|
## Filename scheme
|
||||||
|
|
||||||
|
Used to generate filenames. Extensions are placed in place of `%ext`. `%(DATE FORMAT)date` can be used to replace the date format with a format as specified by [this documentation page](http://doc.qt.io/qt-5/qdatetime.html#toString)
|
||||||
|
**Default:** `Screenshot %(yyyy-MM-dd HH:mm:ss)date.%ext`
|
||||||
|
## Delay before taking a screenshot
|
||||||
|
|
||||||
|
Applies only to the buttons in menus. Hotkeys do not follow this rule. In seconds. Mostly used to let animations fade.
|
||||||
|
Min: `0.00`
|
||||||
|
Max: `99.99`
|
||||||
|
**Default:** `0.25`
|
||||||
|
|
||||||
|
## Hotkeys
|
||||||
|
**Explained on a separate page.**
|
||||||
34
docs/wiki/Tools.md
Normal file
34
docs/wiki/Tools.md
Normal file
@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
title: Tools
|
||||||
|
categories: [wiki]
|
||||||
|
layout: wikipage
|
||||||
|
---
|
||||||
|
# Drawing
|
||||||
|
|
||||||
|
On-screen drawing is pretty simple. Right click in the crop editor to show a pen selection tool. When you click on a pen it will stay selected until you press `Reset`.
|
||||||
|
|
||||||
|
You can move drawings around by Ctrl+Dragging them
|
||||||
|
|
||||||
|
## Available pens:
|
||||||
|
### Dot
|
||||||
|
Draws dots as you move your mouse
|
||||||
|
### Path
|
||||||
|
Makes a path where your mouse went.
|
||||||
|
### Blur
|
||||||
|
Allows you to set a rectangle to blur out. You'll get a settings popup upon selecting this pen.
|
||||||
|
### Straight line
|
||||||
|
A line between where you start and end dragging
|
||||||
|
### Text
|
||||||
|
Asks you to insert some text.
|
||||||
|
**WARNING:** Avoid pressing return and enter
|
||||||
|
### Rectangle
|
||||||
|
Drag to draw a rectangle
|
||||||
|
### Ellipse
|
||||||
|
Drag to draw an ellipse
|
||||||
|
### Eraser[](https://www.youtube.com/watch?v=OjGrcJ4lZCc)
|
||||||
|
Removes all items you drag your mouse over
|
||||||
|
|
||||||
|
### Clear all drawings
|
||||||
|
Removes all drawings
|
||||||
|
### Reset
|
||||||
|
Allows you to choose a region to cut for the final result.
|
||||||
11
docs/wiki/index.md
Normal file
11
docs/wiki/index.md
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
---
|
||||||
|
title: Index
|
||||||
|
categories: [wiki]
|
||||||
|
layout: wikipage
|
||||||
|
---
|
||||||
|
|
||||||
|
# Welcome to the KShare wiki!
|
||||||
|
The cross platform screenshotting utility
|
||||||
|
|
||||||
|
# Usage
|
||||||
|
See the [`Basic usage`](/wiki/Basic-Usage) page
|
||||||
Loading…
Reference in New Issue
Block a user