Elementum Documentation

Elementum relies on external 'providers' to find media streams.

• Definition: Providers are standard Kodi add-ons that search for media and return a list of BitTorrent links.
• Workflow: When a user selects media (via a TMDB ID), Elementum enumerates all installed providers, calls them in parallel, de-duplicates the returned links, and then uses its internal engine to stream the best match.
• Development: Providers are lightweight and can be written in as little as ~20 lines of Python code. They function as independent Kodi add-ons with their own configuration.

The elementum-web package is built using Create React App. To ensure a successful build, you must use Node.js 12.

To start the development server, run npm start. The application will be available at http://localhost:3000. The server supports hot reloading, meaning the page will automatically reload when you make edits, and linting errors will be displayed in the console.

If you need full control over the underlying build tools (Webpack, Babel, ESLint, etc.), you can run npm run eject.

WARNING: This is a one-way operation. Once you eject, you cannot go back.

Executing this command will remove the single build dependency and copy all configuration files and transitive dependencies directly into your project directory. After ejecting, you are responsible for managing the configuration and dependencies yourself.

To create a production-ready version of the application, run npm run build. This command:

• Bundles React in production mode.
• Optimizes the build for performance.
• Minifies the output.
• Generates filenames with hashes for cache busting.

The resulting production files will be located in the build folder.

To build the elementum daemon from source, you must work within the elementum directory. This process uses Docker images containing the necessary compilers and libtorrent-go libraries.

1. Pull required Docker images:

   make pull-all

2. Compile for a specific platform:

   • For Android ARM64 shared library: make android-arm64-shared
   • For Android x86: make android-x86

3. Compile for all supported platforms:

   make all

Compiled binary files are placed in the /build folder.

# Pull all docker images
make pull-all

# Compile for specific platform
make android-arm64-shared
make android-x86

# Compile for all platforms
make all

To ensure Elementum functions correctly within Kodi, you must enable specific service settings before installation:

1. Go to Settings > Service settings > Control.
2. Enable both Application control options.
3. Restart Kodi if you had to enable these options.
4. Install the Elementum add-on as you would any other Kodi add-on.

Use createserver() to instantiate a bjsonrpc.server.Server object bound to a specific host and port. This server listens for incoming TCP connections. By default, it binds to 127.0.0.1 on port 10123 for security. To allow connections from any interface, use 0.0.0.0 as the host.

To define which remote functions are available to clients, pass a class to the handler_factory parameter. This class will be instantiated to handle incoming RPC requests.

import bjsonrpc

# Create a server listening on all interfaces
server = bjsonrpc.createserver("0.0.0.0")

# Start the server loop
server.serve()

Use connect() to instantiate a bjsonrpc.connection.Connection object that establishes a TCP connection to a remote bjsonrpc server.

Once connected, you can invoke remote methods on the server using the conn.call attribute. By default, the handler_factory is set to bjsonrpc.handlers.NullHandler, which means no functions are executable by the server unless a custom handler is provided.

import bjsonrpc

# Connect to a remote server
conn = bjsonrpc.connect("rpc.host.net")

# Call a method available on the server side
result = conn.call.some_method_in_server_side()
print(result)