nCore addon

A self-hostable Stremio addon that lets you stream content straight from nCore.

IMPORTANT: This project is very much in its alpha phase. The setup is still a bit rough and even a full rewrite is not out of the picture. It's the early days of the project, so don't expect stability yet, but feel free to experiment with it.

IMPORTANT: I maintain this project in my free time as a hobby. Feel free to leave suggestions or feedback in the form of issues, but don't expect free labor. Rude and entitled issues will be deleted without explanation.

FAQ

What is Stremio?

View answer

Stremio is a media hub for your Smart TV, phone, or computer, just like Netflix, Disney+, or other services.

The differe is that Stremio doesn't provide any media sources by default, you have to use addons for that.

Learn more about Stremio here, or download the apps here.

What is this addon?

View answer

This project is an addon that connects your nCore account to Stremio. Without an addon, stremio will show no "streams" for any media.

Once you configure this addon, you will be able to click on any movie/show and you will see a list of all torrents for that particular media from nCore.

The addon will even rank them based on your configured preferences (language + resolution).

What do I need to get started?

View answer

Most importantly, you need a working (not banned) nCore account that can download torrents.

You will need a computer/server to host this addon. The addon will run on your computer and search nCore for you. Once you start playing something, the addon will download the torrent to the computer and start seeding it.

You will need Node.js and NPM (Node Package Manager) installed on your machine.

Make sure that the computer you are using has enough free space to accommodate your downloads.

Since nCore requires you to seed content, the computer should ideally be turned on for as long as possible.

For watching the content, you will need a smart TV, Android TV box, Chromecast, or something similar. Using a PC or Mac will also work great. Stremio can work well on mobile devices, but for iOS, it might require some extra setup. You will need to download Stremio to your device and create an account.

When you are running the addon, you are essentially running a server on your computer. Your device needs to be able to access this server somehow. The easiest solution is to have the server and the client (the smart TV for example) on the same network (they need to be connected to the same router). This way, you will be able to add the addon through its local address.

You will also need to install Node.js and some sort of manager to run it continuously (pm2 is recommended).

If you do not own an Android TV / Chromecast / Firestick / Android phone or similar device, then you will need to set up HTTPS on the server's URL. This might be difficult for beginners. I'm working on an easier solution for this.

Features

• Self-hostable. The downloading machine can be anywhere and you can stream remotely.
• Seeds torrents after download.
• Saves torrent files and downloads to disk. If you come back the next day, the files will already be downloaded, so you won't have to wait too long.
• Configurable to delete torrents when you no longer have to seed them. (Hit'n'run checker)
• Multiple users without having to tell your nCore password to anyone.
• Recommendations and torrent ordering based on user preferences (Language + Resolution).

Setup

Server: the computer where you will host this addon.

Client: the device where you will watch the content through the Stremio app.

Using docker

Example docker run command:

docker run -d \
    --name=stremio-ncore-addon \
    -e ADDON_URL=https://subdomain.example.com \
    -e APP_SECRET=changeme \
    -e NCORE_USERNAME=ncore_username \
    -e NCORE_PASSWORD=ncore_password \
    -e DELETE_AFTER_HITNRUN=true \
    -e ADMIN_USERNAME=admin \
    -e ADMIN_PASSWORD=changeme \
    -e ADMIN_FIRST_PREFERRED_LANGUAGE=Hungarian \
    -e ADMIN_SECOND_PREFERRED_LANGUAGE=English \
    -e ADMIN_PREFERRED_RESOLUTIONS=720P,1080P \
    -p 3000:3000 \
    -v /path/to/downloads:/downloads \
    -v /path/to/torrents:/torrents \
    --restart unless-stopped \
    detarkende/stremio-ncore-addon:latest

Example docker compose:

---
services:
    stremio-ncore-addon:
        image: detarkende/stremio-ncore-addon:latest
        container_name: stremio-ncore-addon
        environment:
            - ADDON_URL=https://subdomain.example.com
            - APP_SECRET=changeme
            - NCORE_USERNAME=ncore_username
            - NCORE_PASSWORD=ncore_password
            - DELETE_AFTER_HITNRUN=true
            - ADMIN_USERNAME=admin
            - ADMIN_PASSWORD=changeme
            - ADMIN_FIRST_PREFERRED_LANGUAGE=Hungarian
            - ADMIN_SECOND_PREFERRED_LANGUAGE=English
            - ADMIN_PREFERRED_RESOLUTIONS=720P,1080P
        volumes:
            - /path/to/downloads:/downloads
            - /path/to/torrents:/torrents
        ports:
            - 3000:3000
        restart: unless-stopped

Manual install

1. Clone the repository to the server.

   git clone https://github.com/detarkende/stremio-ncore-addon.git && cd stremio-ncore-addon

2. Install the dependencies

   npm install

3. Create the environment variable file in the base of the project.

   touch .env

   See environment variable reference

4. Run the start command to test if everything is good to go.

   npm run start

   If everything looks good, you can stop the program with Ctrl^ + C.

5. Setup the program to run in the background. (Recommended way: using pm2)

   1. Install pm2:

      npm i -g pm2

   2. Setup pm2 to run on startup.

      pm2 startup

   3. Start the addon with pm2.

      pm2 start "npm start"

      After this, you can check the logs from the server with the pm2 logs command.

6. Finally, install the plugin

   I don't have an Android TV / Chromecast or similar.

   1. Make sure that the config URL can be reached with HTTPS: https://<ADDON-URL>/configure. (Example: https://stremio-addon.example.com/configure)
   2. Open Stremio on the web, and log in.
   3. Go to the configuration URL, log in to the addon with one of the users, then click on "Configure on the web".
   4. Click on "Install".
   5. Now you can log in on any device and the plugin will work. (Note: you might have to sync your addons first on some Smart TVs.)
   I have an Android TV / Chromecast or similar.

   6. Open the app and log in.
   7. Go to addons.
   8. Click on the "Add addon" button.
   9. Type in your server's address. If you have this set up to a certain URL, type that. Otherwise, just replace the parts in this: http://<SERVER_IP_ADDRESS>:<PORT>/manifest.json. (Example: https://192.168.0.110:3000/manifest.json)
   10. Click "Configure" and wait for the configuration window to open.
   11. Log in with one of the users you saved in your config file.
   12. Click on "Configure".
   13. You should be redirected to the Stremio Addons screen. Click "Install" to finish the installation.

Environment variable reference

Variable name	Required / Optional	Description
PORT	Optional (default = 3000)	The port where the addon will run. If you are running this from docker, don't change this, change the exposed port instead.
ADDON_URL	Required	The https URL where the addon will be reachable. This should be available from outside your local network.
APP_SECRET	Required	A random string that will be used to sign the JWTs for authentication. You can generate on here.
DOWNLOADS_DIR	Required	Directory path where the video files will be downloaded to. Should be an empty directory. If the given path doesn't exist, it will be created.
TORRENTS_DIR	Required	Directory path where the torrent files will be downloaded to. Should be an empty directory. If the given path doesn't exist, it will be created.
NCORE_URL	Optional (default = https://ncore.pro)	URL of the nCore website. This is only here in case the URL changes. Otherwise, you don't need to provide this.
NCORE_USERNAME	Required	Your username for nCore.
NCORE_PASSWORD	Required	Your password for nCore.
DELETE_AFTER_HITNRUN	Optional (default = false)	Enable automatic deletion of torrents that are not mandatory to seed anymore.
DELETE_AFTER_HITNRUN_CRON	Optional (default = '0 2 * * *')	Cron expression for running the hitnrun table check. Defaults to "Once every day at 2:00 AM"
ADMIN_USERNAME	Required	Username for the admin user.
ADMIN_PASSWORD	Required	Password for the admin user.
ADMIN_FIRST_PREFERRED_LANGUAGE	Required	Preferred language of the admin user of the addon. This setting will be used to rank and order the found torrents and for giving recommendations.
ADMIN_SECOND_PREFERRED_LANGUAGE	Optional	Second preferred language (preferred if the first isn't available) of the admin user of the addon. This setting will be used to rank and order the found torrents and for giving recommendations.
ADMIN_PREFERRED_RESOLUTIONS	Required	A comma separated list of resolutions that the admin user prefers in preferential order. This setting will be used to rank and order the found torrents and for giving recommendations.
USERS	Optional	A JSON array of users as a string. Check the .env.example file here for an example.