To initialize your first add-on, we will use the
addon-bootstrap utility which is provided by
addon-bootstrap utility will ask you a few questions about your add-on name, description and what it will provide. Don't worry - you can always change this later!
Deciding what your add-on will do
If you only intend to provide catalogs (content in Board/Discover), then you only need the
catalog resource. Similarly, if you only want to provide streams, just select the
Initialize the add-on
npm install --global stremio-addon-sdk # requires "sudo" if you're on Linux addon-bootstrap hello-world
Now, you will be asked various things about your add-on, such as name, description, resources it provides and types of content it will have.
After you've completed the steps, do:
cd hello-world npm install npm start -- --launch
Congratulations! You've created your first Stremio add-on. After the last step, the web version of Stremio will be opened in your browser with the add-on pre-installed!
The initialized add-on will have the following structure:
addon.js: this is the JS module that exports the
addonInterface, which is a generic interface to your add-on; it will end in
module.exports = builder.getInterface()
server.js: this is the executable JS file that will start an HTTP server and optionally launch/install your add-on if you pass
This pattern is useful and encouraged because it allows your add-on to be used locally by only requiring