76 lines
4.0 KiB
Markdown
76 lines
4.0 KiB
Markdown
# Prepare everything
|
|
|
|
Welcome to the NewPipeExtractor documentation. This tutorial will guide you through the process of creating your own Extractor
|
|
service with which NewPipe will gain support for a dedicated streaming service like YouTube, Vimeo or SoundCloud.
|
|
The whole documentation consists of this page, which explains the general concept of the NewPipeExtractor, as well as our
|
|
[Jdoc](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/) setup.
|
|
|
|
__IMPORTANT!!!__ this is likely to be the worst documentation you have ever read, so do not hesitate to
|
|
[report](https://github.com/teamnewpipe/documentation/issues) if
|
|
you find any spelling errors, incomplete parts or you simply don't understand something. We are an open community
|
|
and are open for everyone to help :)
|
|
|
|
## Setup your dev environment
|
|
|
|
First and foremost you need to meet certain conditions in order to write your own service.
|
|
|
|
### What you need to know
|
|
|
|
- Basic understanding of __[git](https://try.github.io)__
|
|
- Good __[Java](https://whatpixel.com/best-java-books/)__ knowledge
|
|
- Good understanding of __[web technology](https://www.w3schools.com/)__
|
|
- Basic understanding of __[unit testing](https://www.vogella.com/tutorials/JUnit/article.html)__ and __[JUnit](https://junit.org/)__
|
|
- Flawless understanding of how to [contribute](https://github.com/TeamNewPipe/NewPipe/blob/dev/.github/CONTRIBUTING.md#code-contribution) to the __NewPipe project__
|
|
|
|
### What you need to have
|
|
|
|
- A dev environment/ide that supports:
|
|
- __[git](https://git-scm.com/downloads/guis)__
|
|
- __[java 8](https://www.java.com/en/download/faq/java8.xml)__
|
|
- __[gradle](https://gradle.org/)__
|
|
- __[unit testing](https://junit.org/junit5/)__
|
|
- I highly recommend [IDEA Community](https://www.jetbrains.com/idea/) since it has everything we need.
|
|
- A __[Github](https://github.com/)__ account
|
|
- A lot of patience and excitement ;D
|
|
|
|
After making sure all these conditions are provided fork the [NewPipeExtractor](https://github.com/TeamNewPipe/NewPipeExtractor),
|
|
using the [fork button](https://github.com/TeamNewPipe/NewPipeExtractor#fork-destination-box).
|
|
This way you have your own working repository. Now clone this repository into your local folder in which you want to work in.
|
|
Next import the cloned project into your [IDE](https://www.jetbrains.com/help/idea/configuring-projects.html#importing-project)
|
|
and [run](https://www.jetbrains.com/help/idea/performing-tests.html) it.
|
|
If all the checks are green you did everything right, and you are good to go to move on to the next chapter.
|
|
|
|
#### Running test in Android Studio
|
|
|
|
Go to _run_ > _edit configurations_ > _add new configuration_ and select "Gradle".
|
|
As Gradle Project, select NewPipeExtractor. As task add "test". Now save and you should be able to run.
|
|
|
|
|
|
|
|
# Inclusion criteria for services
|
|
|
|
After creating you own service you will need to submit it to our [NewPipeExtractor](https://github.com/teamnewpipe/newpipeextractor)
|
|
repository. However in order to include your changes you need to follow these rules:
|
|
|
|
1. Stick to our [Code contribution guidelines](https://github.com/TeamNewPipe/NewPipe/blob/dev/.github/CONTRIBUTING.md#code-contribution)
|
|
2. Do not send services that present content we [don't allow](#not-allowed-content) on NewPipe.
|
|
3. You need to be willing to keep on maintaining your service after submission.
|
|
4. Be patient and do the requested changes when one of our maintainers rejects your code.
|
|
|
|
## Allowed Content
|
|
|
|
- Basically anything except [NOT allowed content](#not-allowed-content).
|
|
- Any kind of porn/NSFW that is allowed according to the [US Porn act](https://www.justice.gov/archive/opa/pr/2003/April/03_ag_266.htm).
|
|
- Advertisement (may be handled specially though)
|
|
|
|
## NOT allowed Content
|
|
|
|
- NSFL (Not Safe For Life)
|
|
- Porn that is not allowed according to [US Porn act](https://www.justice.gov/archive/opa/pr/2003/April/03_ag_266.htm).
|
|
- Any form of violence
|
|
- Child pornography
|
|
- Media that harms others
|
|
- Media that violates human rights
|
|
- Copyright infringement/pirated media
|
|
|