cobalt/README.md

65 lines
2.3 KiB
Markdown
Raw Normal View History

2022-07-08 19:17:56 +01:00
# cobalt
Sleek and easy to use social media downloader built on JavaScript. Try it out live: [co.wukko.me](https://co.wukko.me/)!
![cobalt logo](https://raw.githubusercontent.com/wukko/cobalt/current/src/static/icons/wide.png "cobalt logo")
2022-07-08 19:17:56 +01:00
## What is cobalt?
Everyone is annoyed by the mess video downloaders are on the web, and cobalt aims to be the ultimate social media downloader, that is efficient, pretty, and doesn't bother you with ads or privacy invasion agreement popups.
2022-07-08 19:17:56 +01:00
cobalt doesn't remux any videos, so you get videos of max quality available (unless you change that in settings).
2022-07-08 19:17:56 +01:00
## What's supported?
- Twitter
- YouTube and YouTube Music
- bilibili.com
- Reddit
- VK
2022-07-08 19:18:29 +01:00
## What still has to be done
2022-07-08 19:17:56 +01:00
- [ ] Quality switching for bilibili and Twitter
- [ ] Language picker in settings
- [x] Clean up the mess that localisation is right now
- [x] Sort contents of .json files
- [x] Rename each entry key to be less linked to specific service (entries like youtubeBroke are awful, I'm sorry)
- [x] Add support for more languages when localisation clean up is done
2022-07-08 19:17:56 +01:00
- [ ] Use esmbuild to minify frontend css and js
- [ ] Make switch buttons in settings selectable with keyboard
- [ ] Do something about changelog because the way it is right now is not really great
- [ ] Remake page rendering module to be more versatile
- [ ] Matching could be redone, I'll see what I can do
- [ ] Facebook and Instagram support
- [ ] TikTok support (?)
- [ ] Support for bilibili.tv (?)
## Disclaimer
This is my passion project, so update scheduele depends on my motivation. Don't expect any consistency in that.
## Host an instance yourself
2022-07-08 19:17:56 +01:00
Code might be a little messy, but I promise to improve it over time.
### Requirements
2022-07-08 19:18:52 +01:00
- Node.js 14.16 or above
2022-07-08 19:17:56 +01:00
- git
### npm modules
- express
- cors
2022-07-08 19:17:56 +01:00
- got
- url-pattern
- xml-js
- dotenv
- express-rate-limit
- ffmpeg-static
- node-cache
- ytdl-core
Setup script installs all needed **npm** dependencies, but you have to install Node.js and git yourself, if you don't have those already.
1. Clone the repo: `git clone https://github.com/wukko/cobalt`
2. Run setup script and follow instructions: `npm run setup`
3. Run cobalt via `npm start`
2022-07-08 19:17:56 +01:00
4. Done.
## License
cobalt is under [GPL-3.0 license](https://github.com/wukko/cobalt/blob/current/LICENSE), please keep that in mind.