From 161e52717f702d9f2afaae8ac2e29f3289a42e35 Mon Sep 17 00:00:00 2001 From: Ethan Chapman Date: Sun, 18 Feb 2024 17:45:53 -0500 Subject: [PATCH] Update README.md --- README.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5fcadb7..ebd01a9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![Chokistream](banner.svg) -[![Codacy Badge](https://app.codacy.com/project/badge/Grade/19617caaedb14f799e8d0c3595119386)](https://app.codacy.com/gh/Eiim/Chokistream/dashboard) +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/19617caaedb14f799e8d0c3595119386)](https://app.codacy.com/gh/Eiim/Chokistream/dashboard)![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Eiim/Chokistream/gradle.yml) ![GitHub commits since latest release](https://img.shields.io/github/commits-since/Eiim/Chokistream/latest) Nintendo 3DS wireless video capture software, compatible with [ChirunoMod](https://github.com/ChainSwordCS/ChirunoMod), [BootNTR](https://github.com/44670/BootNTR) and [HzMod](https://chainswordcs.com/horizon-by-sono.html) and the only cross-platform video capture software to support HzMod. @@ -12,12 +12,10 @@ Notable features: * Versions < 2.0 support Windows, Linux, and Mac, with OS-specific builds. Builds may not be available for all platforms for all releases. * TGA (lossless compression) support for HzMod, the only application other than HorizonScreen with such! * Dual-Screen HzMod support for version 2017-05-05 (one of two dual-screen versions) - * Various display output options to get it looking just right on your monitor + * Various display output options to get it looking just right * Chokistream can also run entirely headless and stream straight to a video file, or output frames to image files. Plus even more planned: - * Better controls and control options (coming in 2.1) - * Better video file streaming and image sequences (coming in 2.1) * Better NTR support * Fullscreen support * [And more!](https://github.com/users/Eiim/projects/7) @@ -26,7 +24,7 @@ Currently under development by [Eiim](https://github.com/Eiim) and [ChainSwordCS ## Getting Started -Make sure NTR, HzMod, or ChirunoMod is installed and running on the 3DS. NTR only supports the New 3DS family. +Make sure NTR, NTR-HR, HzMod, or ChirunoMod is installed and running on the 3DS. NTR and NTR-HR only support the New 3DS family. See the [basic usage](https://github.com/Eiim/Chokistream/wiki/Basic-Chokistream-usage) wiki page. See [Options](https://github.com/Eiim/Chokistream/wiki/Options) for more comprehensive documentation. @@ -45,12 +43,10 @@ No other requirements. Run `gradlew build` in Windows Command Prompt or `./gradl ## Known issues Besides GitHub issues: - * Layout doesn't work for file streaming or image sequence * Error "The muxer track has finished muxing" when ending file streaming. This is perfectly safe. - * Similarly, "Socket closed" error when closing NTR is perfectly safe. # Licensing NTRClient.java and NTRUDPThread.java include work derived from [NTRClient](https://github.com/Nanquitas/NTRClient), which is licensed under GPLv2. Therefore, those files are licensed under GPLv2-only. All other files are licensed under GPLv2-or-later. -Prior to commit [5ac6e58](https://github.com/Eiim/Chokistream/commit/5ac6e585446b7e2bd3d652351066ad1fe421b70e), HzModClient.java (and at times other files) contained work derived from [Snickerstream](https://github.com/RattletraPM/Snickerstream), which is licensed under GPLv3-only, and so the entire repository was licensed under GPLv3-only. However, this is not the case. As such, the repository as a whole is now licensed under GPLv2, and the repository excluding NTRClient.java and NTRUDPThread.java is licensed under GPLv2-or-later. The GPLv2-licensed additions from NTRClient were added after the removal of GPLv3-licensed code from Snickstream. +Prior to commit [5ac6e58](https://github.com/Eiim/Chokistream/commit/5ac6e585446b7e2bd3d652351066ad1fe421b70e), HzModClient.java (and at times other files) contained work derived from [Snickerstream](https://github.com/RattletraPM/Snickerstream), which is licensed under GPLv3-only, and so the entire repository was licensed under GPLv3-only. However, this is no longer the case. As such, the repository as a whole is now licensed under GPLv2, and the repository excluding NTRClient.java and NTRUDPThread.java is licensed under GPLv2-or-later. The GPLv2-licensed additions from NTRClient were added after the removal of GPLv3-licensed code from Snickstream.