83 lines
5.5 KiB
Markdown
83 lines
5.5 KiB
Markdown
# cobalt
|
|
Best way to save content you love.
|
|
|
|
Live: [co.wukko.me](https://co.wukko.me/)
|
|
|
|
![cobalt logo](https://raw.githubusercontent.com/wukko/cobalt/current/src/front/icons/wide.png "cobalt logo")
|
|
|
|
[![Crowdin](https://badges.crowdin.net/cobalt/localized.svg)](https://crowdin.com/project/cobalt) [![DeepSource](https://deepsource.io/gh/wukko/cobalt.svg/?label=active+issues&token=MsmsJ9zUOKwcQor0yaiFot84)](https://deepsource.io/gh/wukko/cobalt/?ref=repository-badge) [![DeepSource](https://deepsource.io/gh/wukko/cobalt.svg/?label=resolved+issues&token=MsmsJ9zUOKwcQor0yaiFot84)](https://deepsource.io/gh/wukko/cobalt/?ref=repository-badge)
|
|
|
|
## What's cobalt?
|
|
cobalt is a social media downloader with zero bullshit. It's friendly, efficient, and doesn't bother you with shock ads or privacy invasion "consent" popups.
|
|
|
|
It tries to preserve original media quality, and in most instances you get best downloads possible (you can set your preferences in settings).
|
|
|
|
## Supported services
|
|
| Service | Video + Audio | Only audio | Additional features |
|
|
| -------- | :---: | :---: | :----- |
|
|
| Twitter | ✅ | ✅ | Ability to save multiple videos/GIFs from a single tweet. |
|
|
| Twitter Spaces | ❌️ | ✅ | Audio metadata. |
|
|
| YouTube & Shorts | ✅ | ✅ | Support for 8K, 4K, HDR, and high FPS videos. |
|
|
| YouTube Music | ❌ | ✅ | Audio metadata. |
|
|
| Reddit | ✅ | ✅ | |
|
|
| TikTok & douyin | ✅ | ✅ | Video downloads with or without watermark; image slideshow downloads without watermark. |
|
|
| SoundCloud | ❌ | ✅ | Audio metadata, downloads from private links |
|
|
| bilibili.com | ✅ | ✅ | |
|
|
| Tumblr | ✅ | ✅ | |
|
|
| Vimeo | ✅ | ❌️ | |
|
|
| VK Videos & Clips | ✅ | ❌️ | |
|
|
|
|
## cobalt API
|
|
cobalt has an open API that you can use for free. It's pretty straightforward to use, [check out the docs](https://github.com/wukko/cobalt/blob/current/docs/API.md) and see for yourself.
|
|
|
|
## How to contribute translations
|
|
You can translate cobalt to any language you want on [cobalt's crowdin](https://crowdin-co.wukko.me/). Feel free to ignore QA errors if you think you know better. If you don't see a language you want to translate cobalt to, open an issue, and I'll add it to crowdin.
|
|
|
|
### Translation guidelines:
|
|
- Avoid formal language. Leave it for big and classy tech companies. Use informal language wherever possible.
|
|
- Strings are **ALWAYS** stylized as lowercase unless it's STRESSED LIKE THIS or is an internal value like `{ContactLink}`.
|
|
- Keep translations lively, friendly, and fun. Translate strings as if the user was your buddy.
|
|
- Automatic translations from original language are not valid, and will be ignored.
|
|
- You can (and should) rephrase sentences as long as they keep the same point, if you think it'd be better that way.
|
|
- You can add wordplays or puns if it feels natural to do so.
|
|
- Even though I love cursing, keep that to minimum in translations, and do **NOT** use any offensive words.
|
|
- Check if there are issues in UI with your localization, and optimize it accordingly, or open an issue.
|
|
- Add "(in english)" translated to your language at the end of `ChangelogLastCommit`, `ChangelogLastMajor`, and `ChangelogOlder`. Those are always kept exclusively in English (for now), due to how often changelog changes.
|
|
- Sample translation to Russian: `"ChangelogLastCommit": "последний коммит (на английском)"`
|
|
- Be nice.
|
|
|
|
## Host an instance yourself
|
|
You might find cobalt's source code a bit messy, but I do my best to improve it with every commit.
|
|
|
|
### Requirements
|
|
- Node.js 14.16 or above
|
|
- git
|
|
|
|
### npm modules
|
|
- cors
|
|
- dotenv
|
|
- esbuild
|
|
- express
|
|
- express-rate-limit
|
|
- ffmpeg-static
|
|
- got
|
|
- node-cache
|
|
- url-pattern
|
|
- xml-js
|
|
- better-ytdl-core
|
|
|
|
Setup script installs all needed `npm` dependencies, but you have to install `Node.js` and `git` yourself.
|
|
|
|
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`
|
|
4. Done.
|
|
|
|
## Disclaimer
|
|
cobalt is my passion project, so update release schedule depends solely on my motivation, free time, and mood. Don't expect any consistency in that.
|
|
|
|
## License
|
|
cobalt is under [AGPL-3.0](https://github.com/wukko/cobalt/blob/current/LICENSE) license.
|
|
|
|
[Fluent Emoji](https://github.com/microsoft/fluentui-emoji) used in the project is under [MIT](https://github.com/microsoft/fluentui-emoji/blob/main/LICENSE) license.
|