Skip to content

Commit

Permalink
feat(plugins): enable_web_tools
Browse files Browse the repository at this point in the history
chore: general upkeeping
  • Loading branch information
GeopJr committed Nov 6, 2022
1 parent 5443a8b commit 84bf91d
Show file tree
Hide file tree
Showing 11 changed files with 222 additions and 64 deletions.
132 changes: 132 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
at [https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
36 changes: 19 additions & 17 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
The MIT License (MIT)
Copyright (c) 2022, Evangelos "GeopJr" Paterakis
All rights reserved.

Copyright (c) 2020 GeopJr
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
58 changes: 23 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,16 @@ You can download the *statically* linked build from the releases page!
## Usage

```
$ ./crycord -h
$ crycord -h
<== [Crycord] ==>
Crycord v1.3.2
Usage:
crycord [arguments]
Examples:
crycord -c ./Downloads/style.css
Arguments:
-v, --version Show version
-h, --help Show help
-l, --list Lists all available plugin groups & plugins
Expand All @@ -47,7 +54,7 @@ $ ./crycord -h
```

```
$ ./crycord -c ./Downloads/css.css
$ crycord -c ./Downloads/style.css
Flatpak Detected:
Make sure it has access to your CSS file
Expand All @@ -70,6 +77,7 @@ There's a GTK GUI for Crycord on [Crycord-GUI](https://github.com/GeopJr/Crycord
| enable_https | core | Disables CSP | GeopJr |
| enable_css | core | Enables css injection | GeopJr |
| unrestricted_resize | extra | Removes window size limits | GeopJr |
| enable_web_tools | extra | Enables web tools on Discord stable | GeopJr |

To enable groups of plugins use `$ crycord -g core,extra -c /path/to/css`

Expand All @@ -79,7 +87,7 @@ To enable groups of plugins use `$ crycord -g core,extra -c /path/to/css`

Crycord:
```
$ time ./crycord -c ~/Downloads/css.css
$ time crycord -c ~/Downloads/style.css
...
real 0m2,942s
Expand All @@ -89,7 +97,7 @@ sys 0m0,462s

BeautifulDiscord:
```
$ time python3 -m beautifuldiscord --css ~/Downloads/css.css
$ time python3 -m beautifuldiscord --css ~/Downloads/style.css
...
real 0m4,593s
Expand All @@ -110,39 +118,19 @@ sys 0m2,381s
- Using a client mod such as this (and all others), deactivates many electron security functions.
- If a Discord Staff happens to stumble upon this, I don't use this tool on my account and it's made for educational purposes.

## Goals

As I also wrote the shard that manages the asar pack/extract (these 2 functions at least),
my main goal is to achieve max speed and max compatibility. Using Crystal only tools like Path, File, Dir etc.
is one way to reach it. However, since I don't have access to a Mac and Windows doesn't have proper support, some
paths (Discord config) are made specifically for linux.

## How is it different to BeautifulDiscord?

First of all, it's written, well... in Crystal!

That alone makes it a lot faster!
## Sponsors

Crycord also has a plugin(?) system!

Lastly, it can patch the flatpak version.
<div align="center">

## TODO
[![GeopJr Sponsors](https://cdn.jsdelivr.net/gh/GeopJr/GeopJr@main/sponsors.svg)](https://github.com/sponsors/GeopJr)

- Use a cross-platform way to find Discord's pid
- Clean the module collector
- GitHub action using docker in an attempt to build static builds automatically
</div>

## Contributing

1. Fork it (<https://github.com/your-github-user/crycord/fork>)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## Contributors

- [GeopJr](https://github.com/GeopJr) - creator and maintainer
- [leovoel](https://github.com/leovoel) - CSS injector
- [Rapptz](https://github.com/Rapptz) - BeautifulDiscord Maintainer
1. Read the [Code of Conduct](https://github.com/GeopJr/Collision/blob/main/CODE_OF_CONDUCT.md)
2. Fork it (<https://github.com/GeopJr/crycord/fork>)
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request
6 changes: 6 additions & 0 deletions shard.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2.0
shards:
asar-cr:
git: https://github.com/geopjr/asar-cr.git
version: 1.2.0

6 changes: 3 additions & 3 deletions shard.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: crycord
version: 1.3.1
version: 1.3.2

authors:
- GeopJr <[email protected]>
Expand All @@ -12,6 +12,6 @@ dependencies:
asar-cr:
github: GeopJr/asar-cr

crystal: 1.0.0
crystal: 1.6.1

license: MIT
license: BSD-2-Clause
14 changes: 11 additions & 3 deletions src/crycord.cr
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,19 @@ module Crycord

# CLI options
OptionParser.parse do |parser|
parser.banner = "<== [Crycord] ==>"
parser.banner = <<-BANNER
#{"Crycord".colorize(:blue).bold} v#{VERSION}
#{"Usage:".colorize(:light_blue)}
crycord [arguments]
#{"Examples:".colorize(:light_blue)}
crycord -c ./Downloads/style.css
#{"Arguments:".colorize(:light_blue)}
BANNER

parser.on "-v", "--version", "Show version" do
STDOUT.puts "Crycord".colorize(:magenta)
STDOUT.puts "Made by: GeopJr".colorize(:cyan)
STDOUT.puts "Version: #{VERSION}".colorize(:yellow)
exit(1)
end
Expand All @@ -75,7 +83,7 @@ module Crycord
parser.on "-r", "--revert", "Reverts back to original asar" do
should_revert = true
end
parser.on "-p PLUGINS", "--plugins=PLUGINS", "Selects the plugin(s) to install. Split multiple groups with commas(,)." do |input|
parser.on "-p PLUGINS", "--plugins=PLUGINS", "Selects the plugin(s) to install. Split multiple plugins with commas(,)." do |input|
if input == "" || input.nil?
plugin_list
end
Expand Down
2 changes: 0 additions & 2 deletions src/functions/asar.cr
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
require "file_utils"

module Crycord
# extract and pack require a significant amount of RAM

# Asar to path
def extract(path : Path) : Path
parent = path.parent.join("core")
Expand Down
1 change: 1 addition & 0 deletions src/plugins/core/enable-https.cr
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ module Crycord
let header = csp[0].replace(/connect-src ([^;]+);/, "connect-src $1 https://*;");
header = header.replace(/style-src ([^;]+);/, "style-src $1 https://*;");
header = header.replace(/img-src ([^;]+);/, "img-src $1 https://*;");
header = header.replace(/font-src ([^;]+);/, "font-src $1 https://*;");
responseHeaders["content-security-policy"] = header;
done({ responseHeaders });
});
Expand Down
1 change: 0 additions & 1 deletion src/plugins/extra/enable-transparency.cr
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
require "http/client"
require "json"

# Disabled till mutter support (or I switch to kwin/compiz/whatever)
module Crycord
plugin = Plugin.new("enable_transparency", "extra", "Enables glasscord support", true)
Crycord::PLUGINS[plugin.name] = plugin unless plugin.disabled
Expand Down
26 changes: 26 additions & 0 deletions src/plugins/extra/enable_web_tools.cr
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
module Crycord
plugin = Plugin.new("enable_web_tools", "extra", "Enables web tools on Discord stable")
Crycord::PLUGINS[plugin.name] = plugin unless plugin.disabled

module Plugins
module ENABLE_WEB_TOOLS
extend self

def execute : Bool
settings_json = Path[""]
PATHS["asar"].each_parent do |parent|
settings_json = parent if parent.to_s.ends_with?("/config/discord")
end
settings_json = settings_json / "settings.json"

raise "settings.json doesn't exist" unless File.exists?(settings_json)

hash = JSON.parse(File.read(settings_json)).as_h
hash["DANGEROUS_ENABLE_DEVTOOLS_ONLY_ENABLE_IF_YOU_KNOW_WHAT_YOURE_DOING"] = JSON::Any.new(true)

File.write(settings_json, hash.to_json)
true
end
end
end
end
4 changes: 1 addition & 3 deletions src/version.cr
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
require "yaml"

module Crycord
VERSION = {{ `shards version #{__DIR__}`.chomp.stringify }}
VERSION = {{read_file("#{__DIR__}/../shard.yml").split("version: ")[1].split("\n")[0]}}
end

0 comments on commit 84bf91d

Please sign in to comment.