Cyberpunk-Neon/README.md

154 lines
5.8 KiB
Markdown
Raw Normal View History

2019-01-11 23:15:25 +01:00
# Cyberpunk-Neon
2019-09-11 18:17:30 +02:00
[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/Z8Z1139QA)
[![Donate](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/roboron/donate)
2019-06-02 00:15:21 +02:00
![Cyberpunk Neon theme in action 1](https://raw.githubusercontent.com/Roboron3042/Cyberpunk-Neon/master/Resources/Screenshots/screenshot-1.png)
![Cyberpunk Neon theme in action 2](https://raw.githubusercontent.com/Roboron3042/Cyberpunk-Neon/master/Resources/Screenshots/screenshot-2.png)
![Cyberpunk Neon theme in action 3](https://raw.githubusercontent.com/Roboron3042/Cyberpunk-Neon/master/Resources/Screenshots/screenshot-3.png)
2019-09-11 18:17:30 +02:00
## Table of contents
- [Description](#description)
- [How to apply](#how-to-apply)
2020-01-21 19:55:04 +01:00
- [Desktop](#desktop)
2019-09-11 18:17:30 +02:00
- [Firefox](#firefox)
- [GTK](#gtk)
2020-01-21 19:55:04 +01:00
- [KDE Plasma](#kde)
2019-09-11 18:17:30 +02:00
- [Icons](#icons)
2020-01-21 19:55:04 +01:00
- [Tabletop Simulator](#tabletop-simulator)
2019-09-11 18:17:30 +02:00
- [Telegram](#telegram)
2020-01-21 19:55:04 +01:00
- [Zim](#zim)
- [Terminal]
- [Konsole](#konsole)
2019-09-11 18:17:30 +02:00
- [Tilix](#tilix)
2020-01-21 19:55:04 +01:00
- [Other](#other)
2019-09-11 18:17:30 +02:00
- [Vim](#vim)
- [ZSH](#zsh)
- [CSS Themes](#css-themes)
- [Mastodon](#css-themes)
- [Discord](#discord)
- [License](#license)
2019-01-13 13:34:57 +01:00
## Description
2019-08-25 02:23:59 +02:00
Cyberpunk Neon color scheme is a cyberpunk/outrun color scheme based on the [Cyberpunk Neon Color Palette](https://www.color-hex.com/color-palette/61235). This repository contains Cyberpunk Neon themes and icons for KDE Plasma, GTK, Telegram, Tilix, ZSH, Vim, Zim, Firefox, and some websites like Mastodon and Discord.
2019-06-02 00:15:21 +02:00
* **Wallpaper:** [Highway 4k by AxiomDesign](https://www.deviantart.com/axiomdesign/art/Highway-4k-696620104)
2019-01-13 13:34:57 +01:00
## How to apply
First, clone this repository with git
`git clone https://www.github.com/Roboron3042/Cyberpunk-Neon`
And cd into the directory
`cd Cyberpunk-Neon`
2020-01-21 19:55:04 +01:00
## Desktop
2019-09-11 18:17:30 +02:00
### Firefox
The official theme of Cyberpunk Neon is available in [Firefox Addons](https://addons.mozilla.org/es/firefox/addon/cyberpunk-neon/) (by Thomas Leon Highbaugh).
### GTK
2019-03-15 18:46:46 +01:00
There are 3 GTK variants inside the gtk folder. The one originally made for this theme was the Materia variant, but you can also install the Numix variant or the Arc Variant.
2019-03-15 18:46:46 +01:00
Extract Materia-Cyberpunk-Neon.tar.gz into ~/.themes/
2019-04-25 11:25:04 +02:00
`tar xzf gtk/Materia-Cyberpunk-Neon.tar.gz -C ~/.themes/`
An apply the theme via settings (in KDE = Settings -> Appearance - Application Style)
2019-03-15 18:46:46 +01:00
Note: You can also edit the theme with oomox with the oomox configuration file provided in this repository.
### KDE
2019-08-25 02:23:59 +02:00
You can use the KDE color scheme with any theme, as long as they are **not kvantum themes**. For consistency is better to install [Materia-Dark for KDE](https://github.com/PapirusDevelopmentTeam/materia-kde) (or any of the QT versions of the GTK variants) to fit with gtk theme.
2019-01-13 13:34:57 +01:00
Next you have to copy CyberpunkNeon.colors to ~/.local/share/color-schemes
2019-01-13 13:34:57 +01:00
`cp CyberpunkNeon.colors ~/.local/share/color-schemes`
Now change the color scheme in Settings -> Appearance -> Color. Don't forget to also change Workspace Theme to Breeze if you want the system to follow the Color Scheme.
2019-01-13 13:34:57 +01:00
### Icons
I recommend to use gusbemacbe's [Suru++ icons](https://github.com/gusbemacbe/suru-plus) (papirus-like) or [Suru++ Asprómauros](https://github.com/gusbemacbe/suru-plus-aspromauros) (monochrome, gradient if wished) which includes a Cyberpunk-Neon variant. Refer to the [Suru++ Wiki](https://github.com/gusbemacbe/suru-plus/wiki) for more info.
Alternatively you can use the papirus-kolorizer.sh script included in this repository **WARNING**: It will replace your existing Papirus icons, if any. Refer to [Papirus Kolorizer repo](https://github.com/DarthWound/papirus-kolorizer) for more info.
2019-01-13 15:28:30 +01:00
```
chmod +x papirus-kolorizer.sh
./papirus-kolorizer.sh
```
Apply the icons (Papirus-Dark) in system settings (KDE = Settings -> Appearance- Icons. Apply icons for GTK applications too in Settings -> Appearance - Application Style).
2020-01-21 19:55:04 +01:00
### Tabletop Simulator
Open the game. Got con Configuration -> Interface -> Theme Editor and click "Import/Export". Now copy the content of TabletopSimulator_Cyberpunk-Neon.txt
2019-09-11 18:17:30 +02:00
### Telegram
2019-09-11 18:17:30 +02:00
Just drop the cyberpunk-neon.tdesktop-theme into the chat and open it.
2019-04-29 14:07:49 +02:00
2020-01-21 19:55:04 +01:00
### Zim
If you use Zim you can copy my style.conf into ~./config/zim
`cp style.conf ~./config/zim/`
## Terminal
In the terminal folder you will find colorschemes for different terminal emulators and applications.
`cd terminal`
### Konsole
Copy Cyberpunk-Neon.colorscheme into ~~/.local/share/konsole/
`cp Cyberpunk-Neon.colorscheme ~/.local/share/konsole/`
### Tilix
2020-01-21 19:55:04 +01:00
Copy Cyberpunk-Neon.json into ~/.config/tilix/schemes
2019-02-06 17:51:22 +01:00
`cp Cyberpunk-Neon.json ~/.config/tilix/schemes`
Select it in Settings -> Profile -> Color
2020-01-21 19:55:04 +01:00
### Other
See terminal-palette file
### Vim
2020-01-21 19:55:04 +01:00
Although you can use Vim with the default terminal colors, I've created a Vim theme to better fit my needs. You need to copy cyberpunkneon.vim to ~/.vim/colors
`cp cyberpunkneon.vim ~/.vim/colors`
And then apply the theme in your .vimrc
`colorscheme cyberpunkneon`
You can also modify and generate the theme easily with the [rnb.erb](https://github.com/romainl/vim-rnb/) file in the Resources folder.
2019-09-11 18:17:30 +02:00
### ZSH
2020-01-21 19:55:04 +01:00
Those cool prompts I have are a ZSH theme. Assuming you already installed ZSH and the [powerlevel9K](https://github.com/bhilburn/powerlevel9k) theme for it, you only have to copy the contents of the powerlevel9k file into your ~/.zsh
2019-02-27 12:12:25 +01:00
## CSS Themes
2019-08-25 02:23:59 +02:00
I've applied the Cyberpunk-Neon color scheme to some websites. You cand find the CSS files to be used with Stylus in the CSS folder. Currently available websites are:
* Mastodon (classic) - [userstyles.org page](https://userstyles.org/styles/174594/mastodon-cyberpunk-neon)
2019-02-27 12:12:25 +01:00
2019-09-11 18:17:30 +02:00
### Discord
Please go to [CSS/discord](https://github.com/Roboron3042/Cyberpunk-Neon/tree/master/CSS/discord) for more info and screenshots.
2019-01-16 02:08:52 +01:00
2019-01-13 13:34:57 +01:00
## License
2019-09-11 18:17:30 +02:00
Everything in this repository is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html), except papirus-kolorizer script licensed under MIT.