You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-32Lines changed: 26 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,22 +8,23 @@ The free and privacy-friendly screen recorder with no limits 🎥
8
8
9
9
Screenity is a powerful privacy-friendly screen recorder and annotation tool to make better videos for work, education, and more. You can create stunning product demos, tutorials, presentations, or share feedback with your team - all for free.
10
10
11
-
> You can support this project (and many others) through [GitHub Sponsors](https://github.com/sponsors/alyssaxuu)! ❤️
12
-
13
-
Made by [Alyssa X](https://alyssax.com)
14
-
15
-
<ahref="https://www.producthunt.com/posts/screenity?utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-screenity"target="_blank"><imgsrc="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=275308&theme=light&period=daily"alt="Screenity - The most powerful screen recorder for Chrome | Product Hunt"style="width: 250px; height: 54px;"width="250"height="54" /></a>
11
+
<ahref="https://www.producthunt.com/posts/screenity?utm_source=badge-top-post-badge&utm_medium=badge&utm_source=badge-screenity"target="_blank"><imgsrc="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=275308&theme=light&period=daily"alt="Screenity - The most powerful screen recorder for Chrome | Product Hunt"style="width: 250px; height: 54px;"width="250"height="54" /></a>
16
12
<ahref="https://news.ycombinator.com/item?id=25150804"target="_blank"><imgheight=53src="https://hackerbadge.now.sh/api?id=25150804&type=orange"alt="Featured on HackerNews"></a>
17
13
18
-
> ❗️ Screenity has been rebuilt from the ground up, and updated to MV3. [Click here](https://help.screenity.io/getting-started/77KizPC8MHVGfpKpqdux9D/what%E2%80%99s-changed-in-the-new-version-of-screenity/bDtvcwAtw9PPesQeNH4zjE) to here to learn more about why, and what's changed in the new version. Also note that **the license has changed to [GPLv3](https://github.com/alyssaxuu/screenity/blob/master/LICENSE)**, but the older MV2 version remains MIT licensed. Make sure you read the license and the [Terms of Service](https://screenity.io/en/terms/) regarding intellectual property.
14
+
> Want to support the project (and the solo developer behind it)?
15
+
>
16
+
> Check out [**Screenity Pro**](https://screenity.io/pro): a privacy-friendly, EU-hosted platform with link sharing, multi-scene editing, zoom keyframes, captions, and more ❤️
- [Creating a development version](#creating-a-development-version)
26
+
- [Enabling Save to Google Drive](#enabling-save-to-google-drive)
27
+
- [Acknowledgements](#acknowledgements)
27
28
28
29
## Features
29
30
@@ -42,6 +43,9 @@ Made by [Alyssa X](https://alyssax.com)
42
43
💙 No limits, make as many videos as you want, for as long as you want<br> …and much more - all for free & no sign in needed!
43
44
44
45
## Self-hosting Screenity
46
+
> 🛠️ Note: When self-hosted, the extension runs entirely in local-only mode.
47
+
> No API calls, sign-in flows, or platform features are enabled, nothing is sent anywhere.
48
+
> Some internal code paths connect to [Screenity Pro](https://screenity.io/pro), but these are only active in the official Chrome Store version.
45
49
46
50
You can run Screenity locally without having to install it from the Chrome Store. Here's how:
47
51
@@ -50,41 +54,31 @@ You can run Screenity locally without having to install it from the Chrome Store
50
54
3. Drag the folder that contains the code (make sure it's a folder and not a ZIP file, so unzip first), or click on the "Load unpacked" button and locate the folder.
51
55
4. That's it, you should now be able to use Screenity locally. [Follow these instructions](#enabling-save-to-google-drive) to set up the Google Drive integration.
52
56
57
+
<small>Self-hosting is totally fine for personal, educational, or internal use.
58
+
If you’re thinking of building a commercial product from this, feel free to [reach out](mailto:[email protected]), I’m open to chatting 💜</small>
59
+
53
60
## Creating a development version
54
61
55
62
> ❗️ Note that the license has changed to [GPLv3](https://github.com/alyssaxuu/screenity/blob/master/LICENSE) for the current MV3 version (Screenity version 3.0.0 and higher). Make sure to read the license and the [Terms of Service](https://screenity.io/en/terms/) regarding intellectual property.
56
63
57
64
1. Check if your [Node.js](https://nodejs.org/) version is >= **14**.
58
65
2. Clone this repository.
59
-
3. Run `npm install` to install the dependencies.
60
-
4. Run `npm start`.
61
-
5. Load the extension by going to `chrome://extensions/` , and [enabling developer mode](https://developer.chrome.com/docs/extensions/mv2/faq/#:~:text=You%20can%20start%20by%20turning,a%20packaged%20extension%2C%20and%20more.).
62
-
6. Click on `Load unpacked extension`.
63
-
7. Select the `build` folder.
66
+
3. Run `npm install` to install dependencies.
67
+
4. Run `npm start` to start the local development server.
68
+
5. Open `chrome://extensions/` in your browser and [enable developer mode](https://developer.chrome.com/docs/extensions/mv2/faq/#:~:text=You%20can%20start%20by%20turning,a%20packaged%20extension%2C%20and%20more.).
69
+
6. Click **Load unpacked** and select the `build` folder.
70
+
7. The extension should now be available locally.
71
+
To rebuild after code changes, run `npm run build`.
64
72
65
73
### Enabling Save to Google Drive
66
74
67
75
To enable the Google Drive Upload (authorization consent screen) you must change the client_id in the manifest.json file with your linked extension key.
68
76
69
77
You can create it accessing [Google Cloud Console](https://console.cloud.google.com/apis/credentials) and selecting Create Credential > OAuth Client ID > Chrome App. To create a persistent extension key, you can follow the steps detailed [here](https://developer.chrome.com/docs/extensions/reference/manifest/key).
70
78
71
-
## Libraries used
72
-
73
-
-[FFmpeg WASM](https://ffmpegwasm.netlify.app/) for editing and encoding videos
74
-
-[Tensorflow](https://github.com/tensorflow/tfjs) with the [Selfie Segmentation](https://blog.tensorflow.org/2022/01/body-segmentation.html) model
75
-
-[Fabric.js](https://github.com/fabricjs/fabric.js) for drawing and annotating
76
-
-[Radix Primitives](https://www.radix-ui.com/primitives) for the UI components
77
-
-[react-color](https://uiwjs.github.io/react-color/) for the color wheel
78
-
-[localForage](https://github.com/localForage/localForage) to help store videos offline with IndexedDB
79
-
-[Wavesurfer.js](https://wavesurfer.xyz/) to create audio waveforms in the popup and the editor
80
-
-[React Advanced Cropper](https://advanced-cropper.github.io/react-advanced-cropper/) for the cropping UI in the editor
81
-
-[fix-webm-duration](https://github.com/yusitnikov/fix-webm-duration) to add missing metadata to WEBM files
82
-
83
79
## Acknowledgements
84
80
85
81
- Thanks to [HelpKit](https://www.helpkit.so/) for sponsoring this project by hosting the [Screenity Help Center](https://help.screenity.io/).
86
82
- Thanks to [Mei Xuan](https://www.behance.net/meixuanloo) for helping with the Chinese translation of the extension.
87
83
88
-
If you need any help, or want to become a Screenity expert, you can browse articles and guides in the [help center](https://help.screenity.io). You can also submit any feedback or ideas in this [form](https://tally.so/r/3ElpXq), or contact through [this page](https://help.screenity.io/contact)
89
-
90
-
Feel free to reach out to me through email at [email protected] or [on Twitter](https://twitter.com/alyssaxuu) if you have any questions or feedback! Hope you find this useful 💜
84
+
If you need any help, or want to become a Screenity expert, you can browse articles and guides in the [help center](https://help.screenity.io). You can also submit any feedback or ideas in this [form](https://tally.so/r/3ElpXq), or contact through [this page](https://help.screenity.io/contact)
0 commit comments