English | 한국어
A new era of YouTube Video Player with a focus on design and creativity.
Some resources(samples) in this app are using ppy/osu-resources.
| Windows 10+ (x64) |
|---|
The YouTube API Daily Quota fills up very fast (Google has a hard limit of 10,000 units). Please do not ask about this.
Please make sure you have the following prerequisites:
- A desktop platform with the .NET 10.0 SDK installed.
- When running on linux, please have a system-wide ffmpeg installation available to support video decoding.
When working with the codebase, we recommend using an IDE with intelligent code completion and syntax highlighting, such as the latest version of Visual Studio, Visual Studio Code with the EditorConfig and C# Dev Kit plugin installed.
Clone the repository including submodules:
git clone --recurse-submodules https://github.com/ZeroMayo/NekoPlayer
cd NekoPlayerTo update the source code to the latest commit, run the following command inside the NekoPlayer directory:
git pull --recurse-submodulesYou should load the solution via one of the platform-specific .slnf files, rather than the main .sln. This will reduce dependencies and hide platforms that you don't care about. Valid .slnf files are:
NekoPlayer.Desktop.Windows.slnf(Windows platform with WinRT extensions, most common)NekoPlayer.Desktop.slnf(Linux and other platform)
Run configurations for the recommended IDEs (listed above) are included. You should use the provided Build/Run functionality of your IDE to get things going. When testing or building new components, it's highly encouraged you use the NekoPlayer (Tests) project/configuration. More information on this is provided below.
You can also build and run NekoPlayer from the command-line with a single command:
dotnet run --project NekoPlayer.Desktop.Windows (for Windows)
dotnet run --project NekoPlayer.Desktop (for Linux and other platform)When running locally to do any kind of performance testing, make sure to add -c Release to the build command, as the overhead of running with the default Debug configuration can be large (especially when testing with local framework modifications as below).
If the build fails, try to restore NuGet packages with dotnet restore.
When it comes to contributing to the project, the two main things you can do to help out are reporting issues and submitting pull requests. Please refer to the contributing guidelines to understand how to help in the most effective way possible.
NekoPlayer's codes are licensed under the MIT licence. Please see the licence file for more information. tl;dr you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source.
Note: FFmpeg binaries are distributed under their original licenses (GPL/LGPL) from the source. Please refer to FFmpeg License for details.
Please also note that app resources are covered by a separate licence. Please see the licence file for more information.