Lightcord/README.md

89 lines
5.3 KiB
Markdown
Raw Normal View History

2020-06-13 18:36:08 +02:00
[![Discord](https://img.shields.io/discord/705908350218666117?logo=discord&style=flat-square&color=%237289DA)](https://discord.gg/7eFff2A)
![JS](https://img.shields.io/badge/--yellow?logo=javascript&style=flat-square)
![TS](https://img.shields.io/badge/--blue?logo=typescript&style=flat-square)
[![HitCount](http://hits.dwyl.com/Lightcord/Lightcord.svg)](http://hits.dwyl.com/Lightcord/Lightcord)
2020-06-13 18:36:24 +02:00
<br />
[![PayPal](https://img.shields.io/badge/donate-PayPal-blue?logo=PayPal&style=flat-square)](https://paypal.me/jenwina)
2021-03-22 08:17:13 +01:00
[![BTC](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/papycochon/cryptodonate/master/badges/bitcoin.json&style=flat-square)](https://papycochon.github.io/cryptodonate/btc.html?address=14hL2fPS2ASoe8Hcif87EqCS5AGHrepGKp&note=https://github.com/Lightcord/Lightcord)
[![CDN](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/papycochon/cryptodonate/master/badges/cdn.json&style=flat-square)](https://papycochon.github.io/cryptodonate/cdn.html?address=CbdW3pR4HBWJ6wyc1JeNXP4L2fh8QiL85v&note=https://github.com/Lightcord/Lightcord)
[![BCH](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/papycochon/cryptodonate/master/badges/bitcoincash.json&style=flat-square)](https://papycochon.github.io/cryptodonate/bch.html?address=qzqwhfyvkl324fue86r55q656nftfmxkhsn6qugenq&note=https://github.com/Lightcord/Lightcord)
[![XMR](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/papycochon/cryptodonate/master/badges/monero.json&style=flat-square)](https://papycochon.github.io/cryptodonate/xmr.html?address=42pGf1KHHpqaifJd3TtWSdcTmhGVwFp24cGxDoqaYLQJ6rH4pM7KqtUdTpoyxHScDTSJpPA2Bnv19b1bs2uPXgSMH2KYkwj&note=https://github.com/Lightcord/Lightcord)
[![ETH](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/papycochon/cryptodonate/master/badges/ethereum.json&style=flat-square)](https://papycochon.github.io/cryptodonate/eth.html?address=0xEFE45F22Ee844bf2Ba0E4d853FA0bC8c028fAfFe&note=https://github.com/Lightcord/Lightcord)
[![LTC](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/papycochob/cryptodonate/master/badges/litecoin.json&style=flat-square)](https://papycochon.github.io/cryptodonate/ltc.html?address=LNTmfMjHJgTHaB7rj8ZuWWuU1XkP2YeGCA&note=https://github.com/Lightcord/Lightcord)
---
2021-03-30 16:40:00 +02:00
# About
2020-05-16 23:24:51 +02:00
2020-10-06 13:15:30 +02:00
[Lightcord](https://lightcord.org) is a simple and customizable client for Discord.
It includes [BandagedBD](https://github.com/rauenzi/BetterDiscordApp), [Glasstron](https://github.com/AryToNeX/Glasstron) and a [discord.js-like api](https://github.com/Lightcord/Lightcord/tree/master/DiscordJS).
2020-05-16 23:24:51 +02:00
2021-03-30 16:40:00 +02:00
# Features
2021-03-30 16:38:43 +02:00
* **Standalone client** - Lightcord is built to be standalone i.e. it will not break on Discord updates!
* **BetterDiscord built in** - Use almost any BetterDiscord plugin or theme!
* **Easy custom rich presence** - Our method of doing this ensures you won't get banned!
* **Made for Privacy** - Lightcord automatically blocks Discord's trackers and blurs your email, keeping your data safe!
* **Free Emotes** - Send any emote to other Lightcord users!
* **Token Login** - (user/bot) [Make **server** calls with bots]
* **AdBlock** - Automatically block bots and ads in your DMs!
* **Always On Top** - Lightcord will always be shown in front of any other windows!
* **Experiments** - Access Discord's hidden experiments with a single click!
* **Tabs** - Have multiple tabs open to do more!
* **HypeSquad Housing** - Easily change your HypeSquad house, no test required!
* **Badges** - Important people like the developers have special badges to make sure you know who is who!
2021-03-30 16:40:00 +02:00
## Planned Features
2021-03-30 16:38:43 +02:00
* **Username History** - Keep track of your past usernames!
* **New Plugin Directory** - Easily install or edit themes and plugins!
2020-05-16 23:24:51 +02:00
2021-03-30 16:40:00 +02:00
# Installing
2020-05-16 23:24:51 +02:00
2021-03-30 16:40:00 +02:00
## Windows
You can install Lightcord with [scoop](https://github.com/lukesampson/scoop).
```powershell
scoop bucket add extras
scoop install lightcord
```
2020-07-26 13:05:33 +02:00
2021-03-30 16:38:43 +02:00
alternatively, download the installer from the [releases tab](https://github.com/Lightcord/Lightcord/releases).
2021-03-30 16:40:00 +02:00
## Linux
2021-03-30 16:38:43 +02:00
2021-03-30 16:40:00 +02:00
### Arch Linux (or Arch-based)
2020-10-18 06:11:42 +02:00
You need to install the `base-devel` and `git` packages first
2021-03-30 16:38:43 +02:00
[Latest git version](https://aur.archlinux.org/packages/lightcord-git/)
2020-10-18 06:17:54 +02:00
2020-10-18 06:11:42 +02:00
`git clone https://aur.archlinux.org/lightcord-git.git && cd lightcord-git && makepkg -si`
2021-03-30 16:38:43 +02:00
[Precompiled binaries](https://aur.archlinux.org/packages/lightcord-bin/)
2020-10-18 06:17:54 +02:00
2020-10-18 06:11:42 +02:00
`git clone https://aur.archlinux.org/lightcord-bin.git && cd lightcord-bin && makepkg -si`
2021-03-30 16:38:43 +02:00
*AUR helper such as `yay` and `pacaur` can also be used*
2020-11-05 18:03:21 +01:00
2021-03-30 16:40:00 +02:00
### Other Linux Distributions
2020-11-05 18:03:21 +01:00
2021-03-30 16:38:43 +02:00
**Warning: This installation method bypasses the package manager!** You should use this script to uninstall Lightcord!
2021-03-30 16:38:43 +02:00
To install, paste `bash -c "$(curl -s https://raw.githubusercontent.com/Lightcord/Lightcord/master/LULI.sh)"` in terminal and press enter. The installer will guide you through the rest.
2020-10-15 17:49:59 +02:00
2021-03-30 16:40:00 +02:00
# Running From Source
Prerequisites: [Node.js](https://nodejs.org/en/) and NPM
To run from source, follow these instructions:
```bash
git clone https://github.com/Lightcord/Lightcord
cd Lightcord
npm run devInstall
npm test
```
*You will have to do that every time you pull/clone*
<br/>
Lightcord will then launch. If you see the Lightcord icon, you're good to go!
![icon](https://github.com/Lightcord/Lightcord/blob/master/imagery/68747470733a2f2f692e696d6775722e636f6d2f72486e73504e4f2e706e67.png?raw=true)
<br />
Any time you want to launch, just run:
```bash
npm run run
2021-03-30 16:38:43 +02:00
```