mirror of
https://github.com/K3vinb5/Unyo.git
synced 2026-10-20 09:28:59 +00:00
fix: correct README and English translation grammar
This commit is contained in:
Rafael Filipe Silva Borges
83
README.md
83
README.md
@@ -3,7 +3,7 @@
|
||||
<h1 align="center">Unyo</h1>
|
||||
</p>
|
||||
|
||||
<p align="center">Simple and easy to use anime streaming and manga reader desktop app.</p>
|
||||
<p align="center">A simple desktop app for streaming anime and reading manga.</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://img.shields.io/github/license/K3vinb5/Unyo?style=for-the-badge"><img src="https://img.shields.io/github/license/K3vinb5/Unyo?style=for-the-badge&color=F48041"></a>
|
||||
@@ -26,73 +26,82 @@
|
||||
|
||||
## About Unyo
|
||||
|
||||
**Unyo** is a desktop application (inspired from [Dantotsu](https://github.com/rebelonion/dantotsu)) where you can watch and read your favourite animes and mangas, it is fully integrated with anilist so whatever content you consume will always be synced automatically. It has great UI and animations, and above all Ad-Free.
|
||||
**Unyo** is a desktop application inspired by [Dantotsu](https://github.com/rebelonion/dantotsu) where you can watch your favourite anime and read your favourite manga. It is fully integrated with AniList, so whatever content you consume will always be synced automatically. It has a great UI and animations, and above all, it's ad-free.
|
||||
|
||||
## Unyo's Future
|
||||
|
||||
As it is apparent by the commits Unyo has been stuck for quite a while and little to no development has been made, a lot of things have changed in my life lately but I'm finally getting back on track, in the future I will be more transparent and organized about Unyo's progress, for now I will start development slowly so I don't get burned out. Patiently for more news.
|
||||
As the commit history shows, Unyo has been stuck for quite a while, with little to no development. A lot of things have changed in my life lately, but I'm finally getting back on track. In the future, I will be more transparent and organized about Unyo's progress. For now, I will resume development slowly so I don't get burned out. Please be patient while you wait for more news.
|
||||
|
||||
### Some Updates!
|
||||
- A new backend is being made for unyo so more extensions come back and uptime gets much much better. It is coming along nice, expect more news in the future.
|
||||
- The backend is prety much done, I have decided to do a rewrite of the app so it can be more maintanable less buggy, the end user probablu doesn't notice but the way it was going it had started to show signs of weakness be it in performance and developer experience and new features were very very hard to add.
|
||||
|
||||
- A new backend is being developed for Unyo to bring back more extensions and improve uptime. It is coming along nicely. Expect more news in the future.
|
||||
- The backend is pretty much done. I have decided to rewrite the app so it can be more maintainable and less buggy. End users probably haven't noticed, but it had started to show signs of weakness in both performance and developer experience, and new features were very hard to add.
|
||||
|
||||
## Installation
|
||||
|
||||
You can download the latest version from the [releases](https://github.com/K3vinb5/Unyo/releases/latest) tab.
|
||||
|
||||
If you are on **Windows**, you can:
|
||||
- Download the .zip, extract it and run the executable "unyo.exe"
|
||||
- Download the installer .exe, run it and follow the instructions.
|
||||
|
||||
If you are on **Mac**, you can:
|
||||
- Download the .dmg, and install it just like any other mac application.
|
||||
- Download the .zip, extract it and run the .app (Not recommended, use the dmg)
|
||||
- Download the .zip file, extract it, and run the executable "unyo.exe".
|
||||
- Download the .exe installer, run it, and follow the instructions.
|
||||
|
||||
If you are on **macOS**, you can:
|
||||
|
||||
- Download the .dmg file and install it just like any other Mac application.
|
||||
- Download the .zip file, extract it, and run the .app (not recommended; use the .dmg file instead).
|
||||
|
||||
If you are on **Linux**, you can:
|
||||
- Install the app using the [AM package manager](https://github.com/ivan-hc/AM) by running "am -i unyo", you can also update it from here by running "am -u unyo" (Recommended option)
|
||||
- If you're on an Arch based distribution you can find unyo on the aur under the name unyo-bin
|
||||
- Download the .zip, extract it and run the executable "unyo"
|
||||
- Downlaod the .AppImage, and run it
|
||||
- Download the .deb, and install the package by running "sudo apt install ./package_name.deb" (Debian based distros only)
|
||||
|
||||
It is important when setting up Unyo that your Anilist profile is set to either public or semi-public. Currently Unyo won't be able to pull your anime and manga lists, if you have your account set to private.
|
||||
- Install the app using the [AM package manager](https://github.com/ivan-hc/AM) by running "am -i unyo" (recommended). You can also update it by running "am -u unyo".
|
||||
- If you're on an Arch-based distribution, find Unyo in the AUR under the name "unyo-bin".
|
||||
- Download the .zip file, extract it, and run the executable "unyo".
|
||||
- Download the .AppImage file and run it.
|
||||
- Download the .deb file and install the package by running "sudo apt install ./package_name.deb" (Debian-based distributions only).
|
||||
|
||||
When setting up Unyo, make sure your AniList profile is set to either public or semi-public. Currently, Unyo won't be able to pull your anime and manga lists if your account is set to private.
|
||||
|
||||
## Available Extensions
|
||||
|
||||
### Remote Extensions
|
||||
|
||||
The remote extensions for this app are from a custom made api that uses [Aniyomi](https://github.com/aniyomiorg/aniyomi) extensions, this means that if you wish to have a source added you can open a issue saying the name of the extension and I'll try to integrate it. Note that because the orinal project was for android I had to translate a lot of the codebase to work on pc, this means that not all extensions will be working (most likely a skill issue to be honest -_-)
|
||||
The remote extensions for this app come from a custom API that uses [Aniyomi](https://github.com/aniyomiorg/aniyomi) extensions. If you wish to have a source added, you can open an issue with the name of the extension, and I'll try to integrate it. Because the original project was for Android, I had to adapt a lot of the codebase to work on PCs. This means that not all extensions will work (most likely a skill issue, to be honest -_-).
|
||||
|
||||
### Local Extensions
|
||||
|
||||
The local extensions are basically the same as remote extensions but the api runs on your computer and it uses a modular system, the extensions are based of [Aniyomi](https://github.com/aniyomiorg/aniyomi) extensions, You can download them from the app itself (if you wish to use local extensions obviosly) from my extensions repository [Unyo-Extensions](https://github.com/K3vinb5/Unyo-Extensions), later I will post some guides and tools to encourage others to contribute with extensions. Here are some advantages and disadvantages of using local extensions so you can decide for yourself if it is worth it:
|
||||
Local extensions are basically the same as remote extensions, but the API runs on your computer and uses a modular system. The extensions are based on [Aniyomi](https://github.com/aniyomiorg/aniyomi) extensions. If you wish to use local extensions, you can download them through the app from my extensions repository, [Unyo-Extensions](https://github.com/K3vinb5/Unyo-Extensions). Later, I will post some guides and tools to encourage others to contribute extensions. Here are some advantages and disadvantages of using local extensions so you can decide for yourself whether they are worth it:
|
||||
|
||||
#### Advantages
|
||||
- Faster response times
|
||||
- More extensions, since A lot of them work locally and not on the server because of the server's location
|
||||
- You don't depend on the server
|
||||
#### Disadvantages
|
||||
- You need java 17 or later installed one your machine
|
||||
- The app will consume more ram (around 100 to 200mb)
|
||||
|
||||
#### Local Extensions dependencies
|
||||
You need java 17 or later installed on your machine to run the local extensions, I imagine most people have it, but if you don't here is the download links:
|
||||
- Faster response times
|
||||
- More extensions, since many work locally but not on the server because of the server's location
|
||||
- You don't depend on the server
|
||||
|
||||
#### Disadvantages
|
||||
|
||||
- You need Java 17 or later installed on your machine
|
||||
- The app will consume more RAM (around 100 to 200 MB)
|
||||
|
||||
#### Local Extension Dependencies
|
||||
|
||||
You need Java 17 or later installed on your machine to run local extensions. I imagine most people have it, but if you don't, here are the download links:
|
||||
|
||||
- Linux: [https://www.oracle.com/java/technologies/downloads/#jdk17-linux](https://www.oracle.com/java/technologies/downloads/#jdk17-linux)
|
||||
- Macos: [https://www.oracle.com/java/technologies/downloads/#jdk17-mac](https://www.oracle.com/java/technologies/downloads/#jdk17-mac)
|
||||
- macOS: [https://www.oracle.com/java/technologies/downloads/#jdk17-mac](https://www.oracle.com/java/technologies/downloads/#jdk17-mac)
|
||||
- Windows: [https://www.oracle.com/java/technologies/downloads/#jdk17-windows](https://www.oracle.com/java/technologies/downloads/#jdk17-windows)
|
||||
|
||||
## Known Issues
|
||||
|
||||
- App is crashing sometimes in this last version, the reason as to why is still being determined but I know why, it should be better next version, anyway if it does crash just relaunch it. (It should only crash when leaving videos, so no worry youn't be waiting a lot of time, and it is not common at all, the issue has been diagnosed and it is already in the todo list now available under the projects tab).
|
||||
- DLL Hijacking Vulnerability, find more details [here](https://github.com/K3vinb5/Unyo/issues/58)
|
||||
- The app occasionally crashes in the latest version. These crashes should only occur when leaving videos. If it crashes, relaunch it; you should be able to get back to using it quickly. The issue has been diagnosed and is already on the to-do list under the Projects tab. This should improve in the next version.
|
||||
- DLL hijacking vulnerability: find more details [here](https://github.com/K3vinb5/Unyo/issues/58).
|
||||
|
||||
## Contributors
|
||||
|
||||
[](https://github.com/K3vinb5/Unyo/graphs/contributors)
|
||||
|
||||
Contributions are always welcome! If you have any ideas or changes that you want to see in the app, submit a pull request. If you have suggestions or issues, feel free to open a issue!
|
||||
Contributions are always welcome! If you have any ideas or changes that you want to see in the app, submit a pull request. If you have suggestions or issues, feel free to open an issue!
|
||||
|
||||
Because this has happened before, I will explicitly write it, Contributing to the project means doing a pull request, opening an issue with suggestions etc. not proposing a big project which essentially is rebranding my app on another repo under your name :D.
|
||||
Because this has happened before, I will state it explicitly: contributing to the project means submitting a pull request, opening an issue with suggestions, etc. It does not mean proposing a big project that essentially rebrands my app in another repository under your name :D.
|
||||
|
||||
## Contributing
|
||||
|
||||
@@ -103,18 +112,18 @@ Thank you for considering contributing to **Unyo**! Here’s how you can help:
|
||||
3. **Create a Branch**: Use `git checkout -b your-branch-name` to create a new branch for your changes.
|
||||
4. **Make Changes**: Implement your feature or fix and commit your changes with a descriptive message.
|
||||
5. **Push to Your Branch**: Push your changes using `git push origin your-branch-name`.
|
||||
6. **Open a Pull Request**: Go to the original repository and submit a new Pull Request from your branch.
|
||||
6. **Open a Pull Request**: Go to the original repository and submit a new pull request from your branch.
|
||||
|
||||
We appreciate your contributions! 😊
|
||||
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the **GNU Public License version 3.0**, one extra clause was added that states you must mention this project if you use any portion of its code.
|
||||
This project has 2 very small portions of code from [mangayomi](https://github.com/kodjodevf/mangayomi), the torrent server and an audio slider. A big shout out to the developer!
|
||||
This project is licensed under the **GNU Public License version 3.0**. An extra clause states that you must mention this project if you use any portion of its code.
|
||||
This project contains two very small portions of code from [mangayomi](https://github.com/kodjodevf/mangayomi): the torrent server and an audio slider. A big shout-out to the developer!
|
||||
|
||||
## Disclaimer
|
||||
|
||||
- By using this app, you agree that the developer(s) of Unyo is not responsible for any content within the app and won't be legally responsible for any violations.
|
||||
- All the contents in Unyo are hosted by 3rd parties, and the developer(s) is not accountable for their nature or legality. Users are advised to use the application responsibly and in compliance with relevant laws and regulations in their countries.
|
||||
- Unyo or its developer(s) are not responsible for the misuse of any content within or outside the app and shall not be responsible for dissemination of any content within the app.
|
||||
- By using this app, you agree that Unyo's developers are not responsible for any content within the app and won't be legally responsible for any violations.
|
||||
- All content in Unyo is hosted by third parties, and the developers are not accountable for its nature or legality. Users are advised to use the application responsibly and in compliance with relevant laws and regulations in their countries.
|
||||
- Unyo or its developers are not responsible for the misuse of any content within or outside the app and shall not be responsible for the dissemination of any content within the app.
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
"recently_released" : "Recently Released",
|
||||
"search": "Search...",
|
||||
"trending" : "Trending",
|
||||
"season_popular" : "Season Popular",
|
||||
"season_popular" : "Popular This Season",
|
||||
"advanced_search" : "Advanced Search",
|
||||
"select_format" : "Select Format",
|
||||
"select_season" : "Select Season",
|
||||
@@ -39,8 +39,8 @@
|
||||
"cancel" : "Cancel",
|
||||
"list_editor" : "List Editor",
|
||||
"select_title" : "Select Title",
|
||||
"select_new_title_text" : "Please Select for new title or search for new one",
|
||||
"yearly_popular" : "Yearly Popular",
|
||||
"select_new_title_text" : "Please select a new title or search for one.",
|
||||
"yearly_popular" : "Popular This Year",
|
||||
"monday" : "Monday",
|
||||
"tuesday" : "Tuesday",
|
||||
"wednesday" : "Wednesday",
|
||||
@@ -50,11 +50,11 @@
|
||||
"sunday" : "Sunday",
|
||||
"not_yet_released" : "Not yet released",
|
||||
"show_adult_content" : "Show Adult Content",
|
||||
"please_wait_text" : "Please wait, this can take some seconds...",
|
||||
"please_wait_text" : "Please wait. This may take a few seconds...",
|
||||
"select_quality" : "Select quality",
|
||||
"error_occured_video_title" : "An error occured D:",
|
||||
"error_occured_video_text" : "An error occured, try using another source or server/quality",
|
||||
"quality_no_results" : "The source returned no results, please try another source or server/quality :D",
|
||||
"error_occured_video_title" : "An error occurred D:",
|
||||
"error_occured_video_text" : "An error occurred. Try another source, server or quality setting.",
|
||||
"quality_no_results" : "The source returned no results. Please try another source, server or quality setting :D",
|
||||
"released" : "Released",
|
||||
"episode" : "Episode",
|
||||
"chapter" : "Chapter",
|
||||
@@ -64,14 +64,14 @@
|
||||
"extension" : "extension",
|
||||
"extensions" : "Extensions",
|
||||
"change_repo" : "Change repo",
|
||||
"change_repo_message" : "Please paste on the textfield the new repo link and confirm if you wish to use another repository",
|
||||
"change_repo_message" : "To use another repository, paste its link into the text field and confirm.",
|
||||
"need_help" : "Need help?",
|
||||
"need_help_title" : "Here is some help and information you're probably needing :D",
|
||||
"need_help_title" : "Here is some help and information you might need :D",
|
||||
"need_help_message" : "Some of you are probably wondering, what are this local extensions? Basically instead of the sources being hosted online on Unyo's server you have them on you computer. What are the advantages you ask, because the server is located in germany some extensions don't work, while if you use local extensions they will work fine dependending on your country, other advantages are, if you have local extensions enable you don't have to see a long list with all the remote extensions, here you can have just the extensions you use and need, you can also code your extenions yourself, but don't worry, the main repo is activelly developed and more extensions will be added with time. Now go ahead and install some extensions in the Local Extensions page :D",
|
||||
"no_extensions_title" : "You have no installed extensions",
|
||||
"no_extensions_message" : "If you're seeing this it means you have turned on the local extensions but you have no installed extensions, you can install some in the Local Extensions page :D",
|
||||
"unyo2gether_message" : "Please paste your buddys peerId, or all of you come up with a new one!",
|
||||
"extensions_not_enabled_message" : "Local Extensions are not enabled, you can enable them on the settings",
|
||||
"no_extensions_message" : "Local extensions are enabled, but you haven't installed any. You can install some on the Local Extensions page :D",
|
||||
"unyo2gether_message" : "Please paste your buddy's peerId, or agree on a new one together!",
|
||||
"extensions_not_enabled_message" : "Local extensions are not enabled. You can enable them in Settings.",
|
||||
"installed" : "Installed",
|
||||
"console" : "Extensions Server Console",
|
||||
"previous_episode" : "Previous Episode",
|
||||
@@ -88,7 +88,7 @@
|
||||
"download" : "Download",
|
||||
"exit_fullscreen_on_video_exit" : "Exit fullscreen on video exit",
|
||||
"resume_from" : "Resume from",
|
||||
"search_from_website" : "Search your title from the website here",
|
||||
"search_from_website" : "Search for your title on the website here",
|
||||
"current_selection" : "Current selection",
|
||||
"skip_opening_automatically" : "Skip opening automatically (when available)",
|
||||
"select_intro_skip_time" : "Select default manual intro skip time",
|
||||
@@ -97,7 +97,7 @@
|
||||
"select_episode_completed_percentage" : "Select percentage at which an episode is marked as completed",
|
||||
"select_chapter_completed_percentage" : "Select percentage at which a chapter is marked as completed",
|
||||
"enable_open_subtitles" : "Enable opensubtitles.org subtitles (when available/found)",
|
||||
"no_title_found_dialog" : "No title was found, try the Wrong/No Title menu or another source",
|
||||
"no_title_found_dialog" : "No title was found. Try the Wrong/No Title menu or another source.",
|
||||
"page" : "Page",
|
||||
"show_chapters" : "Show chapters",
|
||||
"single_page" : "Single Page",
|
||||
@@ -109,20 +109,20 @@
|
||||
"dark_mode" : "Dark Mode",
|
||||
"fit_height" : "Fit Height",
|
||||
"fit_width" : "Fit Width",
|
||||
"logout_title" : "Do you wanna log out?",
|
||||
"logout_title" : "Do you want to log out?",
|
||||
"logout_text" : "Are you sure you want to log out?",
|
||||
"select_user" : "Who's Watching?",
|
||||
"restore_default" : "Restore default",
|
||||
"create_local_account" : "Create Local Account",
|
||||
"create_local_account_title" : "New Account",
|
||||
"add_account" : "Add Account",
|
||||
"insert_new_name" : "Insert username",
|
||||
"insert_new_name" : "Enter username",
|
||||
"sign_in_title" : "Add a new account",
|
||||
"previous_chapter" : "Previous Chapter",
|
||||
"next_chapter" : "Next Chapter",
|
||||
"next_page" : "Next Page",
|
||||
"previous_page" : "Previous Page",
|
||||
"video_loading" : "Please wait, the video is loading",
|
||||
"video_loading" : "Please wait. The video is loading.",
|
||||
"cast_to_tv" : "Cast to TV",
|
||||
"enable_discord_rpc": "Discord RPC"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user