All of the endpoints are paths that point to http://localhost:10769, we've observed that sometimes using 127.0.0.1 when IPv4 is disabled (don't do that btw) tends to break and not connect. We're not fixing this as it's user error for turning off IPv4, but if you cannot do anything about it, try using [::1]:10769.

GET /active

This will respond as quickly as possible with an empty 204: No Content response, it can be used to quickly check that the RPC is still active.

GET /currentPlayingSong

This will respond with an Apple Music API Response for the currently playing song, the following is an example response.

{
  "info": {
    "albumName": "Skin",
    "artistName": "Flume",
    "artwork": {
      "bgColor": "aa96c7",
      "height": 600,
      "textColor1": "040a06",
      "textColor2": "1b1937",
      "textColor3": "25262c",
      "url": "https://is1-ssl.mzstatic.com/image/thumb/Music122/v4/20/84/1b/20841bcf-a7c1-8048-08ba-ea03e33dbdce/3614598524069.png/{w}x{h}bb.jpg",
      "width": 600
    },
    "audioLocale": "en-US",
    "audioTraits": ["atmos", "lossless", "lossy-stereo", "spatial"],
    "composerName": "Harley Streten, Amanda Warner & Peter Wade Keusch",
    "currentPlaybackProgress": 0.63,
    "currentPlaybackTime": 123.059955,
    "discNumber": 1,
    "durationInMillis": 193633,
    "endTime": 1686069277080,
    "genreNames": ["Electronic"],
    "hasLyrics": true,
    "hasTimeSyncedLyrics": true,
    "isAppleDigitalMaster": false,
    "isMasteredForItunes": false,
    "isPlaying": true,
    "isVocalAttenuationAllowed": true,
    "isrc": "MtheoryLLCAUFF01600807",
    "kind": "song",
    "name": "Like Water (feat. MNDR)",
    "playParams": {
      "id": "1481729389",
      "kind": "song"
    },
    "previews": [
      {
        "url": "https://audio-ssl.itunes.apple.com/itunes-assets/AudioPreview112/v4/9d/12/c3/9d12c393-bc10-14ba-b70b-a8ad27fb21b7/mzaf_1376031537628674471.plus.aac.ep.m4a"
      }
    ],
    "releaseDate": "2016-05-27T12:00:00Z",
    "remainingTime": 70573.04500000001,
    "songId": "1481729389",
    "startTime": 1686069083447.045,
    "status": "playing",
    "trackNumber": 14,
    "url": {
      "appleMusic": "https://music.apple.com/au/song/1481729389",
      "cider": "https://cider.sh/link?play/s/1481729389",
      "songLink": "https://song.link/i/1481729389"
    }
  }
}

GET /addToLibrary

This will save the currently playing track to the user's library. If no music is playing, this will do nothing.

GET /isPlaying

This will return a JSON string stating if the player is currently actively playing a song or not.

These are the only 2 potential responses to this request, if it is anything else, it's safe to assume something broke.

{/*

IMO the next 3 endpoints should be PUT or POST but they're GET because why not. (playPause, play, pause -Amaru8)

-d3rpp

*/}

GET /toggleAutoplay

This will change the autoplay setting to its opposite value and return the updated value in a JSON string.

These are the only 2 potential responses to this request, if it is anything else, it's safe to assume something broke.

GET /playPause

This is functionally equivalent to clicking the play/pause button within the application.

GET /play

This is functionally equivalent to clicking the play button within the application, if music is already playing, this will do nothing.

GET /pause

This is functionally equivalent to clicking the pause button within the application, if music is already paused, this will do nothing.

GET /stop

This is functionally equivalent to clicking the STOP button within the application, if nothing is happening, this will do nothing

GET /next

This will skip to the next song, behaviour is identical to clicking the button within the application.

GET /previous

This will skip to the previous song, behaviour is identical to clicking the button within the application.

GET /seekto/{t}

Where

• t is the time you'd like to skip to in seconds

Set the playhead to this time in the song, you can use /currentPlayingSong to get the time, (using the durationInMillis property divided by 1,000 to get the duration in seconds).

This will always return 204 and if the call fails or the song is too long, it will silently fail, it is recommended that you check the song's actual length before running this function.

GET /show

Will show the window and demand user attention on the screen

GET /hide

Will hide the window, if enabled this will minise it to the system tray as well.

GET /album/{id}

Where

• id is the ID of the album you'd like to lookup

This will run a query of the Apple Music API using the signed in user's account and will pipe the response back to here.

This will always return a 200 but with a different JSON Structure

For More information on the structure of this response, consult the Apple Music API Docs

PUT /rating/{type}/{id}/{rating}

Since Cider version 2.1.3

Where

• type is the type of content you're submitting a rating for, this can be song, music-video, album, or playlist

• id is the ID of the content in question, you can get it from /currentPlayingSong

• rating is the rating you'd like to push

  • -1 is a dislike

  • 0 resets the rating

  • 1 is a like

GET /audio

Get the current volume, this will return plain-text as a floating point number between 0 and 1 inclusive

GET /audio/{volume}

Set the volume slider, will set the in-app volume, not the system volume.

requires a floating point value between 0 and 1, (e.g. /audio/0.8).

GET /rating/{type}/{id}

Since Cider version 2.1.3

Where

• type is the type of content you're submitting a rating for, this can be song, music-video, album, or playlist

• id is the ID of the content in question, you can get it from /currentPlayingSong

Step 1:

Download & Install NodeJS & NPM at https://nodejs.org

Step 2:

Download & Install Git at https://git-scm.com

Step 3:

Install pnpm using the following command

npm install --global pnpm

Step 3:

Open up command prompt and use the following command to clone vencord

git clone https://github.com/Vendicated/Vencord

Step 4:

Create a file called richerCider.desktop.tsx in the src/plugins folder (Git created a folder called Vencord in wherever your terminal was (make sure it's not in system32)).

import { Link } from "@components/Link";
import definePlugin from "@utils/types";
import { Forms } from "@webpack/common";
const appIds = [
  "911790844204437504",
  "886578863147192350",
  "1020414178047041627",
  "1032800329332445255",
];
export default definePlugin({
  name: "richerCider",
  description:
    'Enhances Cider (More details in info button) by adding the "Listening to" type prefix to the user\'s rich presence when an applicable ID is found.',
  authors: [
    {
      id: 191621342473224192n,
      name: "cryptofyre",
    },
  ],
  patches: [
    {
      find: '.displayName="LocalActivityStore"',
      replacement: {
        match: /LOCAL_ACTIVITY_UPDATE:function\((\i)\)\{/,
        replace: "$&$self.patchActivity($1.activity);",
      },
    },
  ],
  settingsAboutComponent: () => (
    <>
      <Forms.FormTitle tag="h3">
        Install Cider to use this Plugin
      </Forms.FormTitle>
      <Forms.FormText>
        <Link href="https://cider.sh">Follow the link to our website</Link> to
        get Cider up and running, and then enable the plugin.
      </Forms.FormText>
      <br></br>
      <Forms.FormTitle tag="h3">What is Cider?</Forms.FormTitle>
      <Forms.FormText>
        Cider is an open-source and community oriented Apple Music client for
        Windows, macOS, and Linux.
      </Forms.FormText>
      <br></br>
      <Forms.FormTitle tag="h3">Recommended Optional Plugins</Forms.FormTitle>
      <Forms.FormText>
        I'd recommend using TimeBarAllActivities alongside this plugin to give
        off a much better visual to the eye (Keep in mind this only affects your
        client and will not show for other users)
      </Forms.FormText>
    </>
  ),
  patchActivity(activity: any) {
    if (appIds.includes(activity.application_id)) {
      activity.type = 2; /* LISTENING type */
    }
  },
});

Step 5: Move the terminal.

cd Vencord

Step 6: Install Depenencies

pnpm install

Step 7: Build with the plugin

pnpm build

Step 8: Open the Vencord Injector.

Discord needs to be closed before you do this ```bash pnpm inject ```

Step 9: Using the GUI

Patch Discord

Step 10: In Vencord Settings:

Enable the richerCider plugin

Step 11: Profit

You're no longer allowed to update Vencord, though in most cases Discord updates should be ok, if not just go back to Step 8

Getting Started

Recommended / Required Development Utilities

• (Optional, but highly recommended)

• Basic Command Line Knowledge

::alert{type="warning"} While not required, PNPM is recommended for compiling Cider, and you can install it by using:

npm install -g pnpm ::

Cloning the repository

Open a terminal window in the directory you'd like Git to clone to and enter the following command

Optionally, if you'd like to use the Development branch of Cider to test upcoming features switch your branch by moving your terminal into the directory and using git to checkout the branch by entering the following commands

::alert{type="note" title="Success"} If you'd like to update your repository in the future to keep up to date, use the command (Make sure you're in the directory, you originally cloned in)

git pull

Installing Dependencies

Now for the fun part, by using pnpm, npm or yarn (we'll be using pnpm in this case) enter the following command to automatically obtain all required dependencies for installation.

::alert{type="note"} This step could take a little while on some machines. ::

Compiling Cider

This step takes a little while on the first compilation so bear with it as it does what it needs to do.

Compiling Cider for specific CPU architectures is a smart thing to do and you can do it by adding switches to the dist argument as displayed.

::alert{type="warning"} On some low-end machines this process could take up to ~10 minutes. ::

::alert{type="warning"} This command would build three separate packages of Cider, AppImage, .deb, and .snap packages ::

Compiling Cider from AUR

If you are on an arch-based Linux distribution and have an AUR helper (pacman/yay/paru/etc.), then you are in luck. Cider has 2 PKGBUILD's in the Arch User Repository.

Assuming you already have access to the AUR and have a friendly AUR helper (we will use yay for this example) enter the following command to automatically obtain all required dependencies for installation.

::alert{type="warning"} Running this on Node.js 17 or later will fail. This is due to Node.js 17 no longer writing openssl_fips to config.gypi so it's not there in Node.js 17's process.config. It is suggested to downgrade to nodejs-lts-gallium to resolve this issue. ::

Installing Cider

Your new Cider installation setup file is ready for you! You can find your setup executable in your cloned folder directory on your system in the subfolder dist/ and from there you'll see your new Setup files. Choose the installer that best matches your distro.

::alert{type="note" title="Success"} Congrats! You've successfully compiled your own build of Cider! ::

Getting Started

Recommended / Required Development Utilities

• (Optional, but highly recommended)

• Basic Command Line Knowledge

::alert{type="warning"} While not required, PNPM is recommended for compiling Cider, and you can install it by using:

npm install -g pnpm ::

::alert{type="caution"} You need windows-build-tools to be able to compile the native modules Cider uses for Windows. It should be installed with Node.js through the chocolatey package manager. If the installation fails you can install it using pnpm/npm in an administrator powershell/cmd window and entering:

pnpm install -g windows-build-tools

or

npm install -g windows-build-tools ::

Cloning the repository

Open a command prompt window in the directory you'd like Git to clone to and enter the following command

Optionally, if you'd like to use the Development branch of Cider to test upcoming features switch your branch by moving your terminal into the directory and using git to checkout the branch by entering the following commands

::alert{type="tip"} If you'd like to update your repository in the future to keep up to date, use the command (Make sure you're in the directory, you originally cloned in)

git pull ::

Installing Dependencies

Now for the fun part, by using pnpm, npm or yarn (we'll be using pnpm in this case) enter the following command to automatically obtain all required dependencies for installation.

::alert{type="tip"} This step could take a little while on some machines. ::

Compiling Cider

This step takes a little while on the first compilation so bare with it as it does what it needs to do.

Compiling Cider for specific CPU architectures is a smart thing to do and you can do it by adding switches to the dist argument as displayed.

::alert{type="warning"} On some low-end machines this process could take up to ~5 minutes. ::

Installing Cider

Your new Cider installation setup file is ready for you! You can find your setup executable in your cloned folder directory on your system in the subfolder dist/ and from there you'll see your new Setup file.

::alert{type="note" title="Success"} Congrats! You've successfully compiled your own build of Cider! ::

Getting Started

Recommended / Required Development Utilities

• (Optional, but highly recommended)

• Have an Apple Developer Account and be a member of the . This is necessary to play music through the app.

• Basic Command Line Knowledge

::alert{type="warning"} While not required, PNPM is recommended for compiling Cider, and you can install it by using:

npm install -g pnpm ::

::alert{type="caution"} To remind you again, if you don't have an Apple Developer account to sign the Cider binary after building, it WILL NOT work. ::

Cloning the repository

Open a command prompt window in the directory you'd like Git to clone to and enter the following command

Optionally, if you'd like to use the Development branch of Cider to test upcoming features switch your branch by moving your terminal into the directory and using git to checkout the branch by entering the following commands

::alert{type="tip"} If you'd like to update your repository in the future to keep up to date, use the command (Make sure you're in the directory, you originally cloned in)

git pull ::

Installing Dependencies

Now for the fun part, by using pnpm, npm or yarn (we'll be using pnpm in this case) enter the following command to automatically obtain all required dependencies for installation.

::alert{type="note"} This step could take a little while on some machines. ::

Create an account to VMP-sign Cider.

What is this for? MacOS doesn't like development Widevine DRM keys for some reason. Therefore, we need to sign our own production keys here. This can be done as follows:

Remember your account name and password because you will need it later.

Once in a while, you may need to re-authenticate the VMP account. If that is the case:

Create Apple signing keys and app-specific password.

1. In Xcode: Under Xcode > Preferences (⌘,) > Accounts, you may add your Apple ID. With your team selected, the View Details... in the bottom right could find you the available certificates for generation/download.

2. After that, select all of the certificates in Keychain Access to generate as a .p12 file. Remember the file location and the .p12 password.

Setting up environment variables.

You can set the environment variables permanently by edit the ~/.bash-profile file and add the above lines at the bottom of the file.

Final fixes

Electron-Packager doesn't like MacOS notarization. You need to manually patch the files in order for it to work properly:

Compiling Cider

This step takes a little while on the first compilation so bear with it as it does what it needs to do.

This will generate a universal signed and notarized binary. (Don't mind the "not working" command line, it works)

::alert{type="warning"} On some low-end machines this process could take up to ~20-30 minutes. (It will look like it hangs at the notarization part, don't exit it). ::

Installing Cider

Your new Cider installation setup file is ready for you! You can find your setup executable in your cloned folder directory on your system in the subfolder dist/ and from there you'll see your new Setup file.

::alert{type="note" title="Success"} Congrats! You've successfully compiled your own build of Cider! ::

Cider Documentation

This repository contains the documentation of the Cider app. This serves as the central hub for all documentation related to the Cider Client, providing comprehensive guides, best practices, and reference materials for end-users and developers alike.

Support (Releases)

Support is fully provided to all releases made on any of our release platforms (Itch, Microsoft Store and Taproom). Please open an , and we will try and fix the issue ASAP. Upon issues being fixed, you will need to wait until the next release if you wish to experience the fixed version in a stable state.

Support (Early-Access Releases)

In early access releases the same applies as with normal releases: Support is fully provided and feel free to open an Issue on GitHub if you have problems. However, with these types of releases, you need to remember that they are non-stable releases and you may encounter issues. These builds of the application do not reflect the complete state of the app in any way.

::alert{type="note"} This is essential knowledge for the debugging process, please read these before creating an issue. ::

How to find the Application Data Directory

The location of your application data varies depending on your operating system, see your platforms path below:

• MS Store: %localappdata%\packages\27554FireDevElijahKlauman.CiderEA_270bejk4xgzqp\LocalCache\Roaming\C2Windows

• Windows (non-MS Store): %appdata%\C2Windows

• Linux: $HOME/.config/sh.cider.genten

• MacOS: /Library/Application Support/sh.cider.genten

Why is my DiscordRPC status not appearing?

Try the following if Discord Rich Presence is not appearing on Discord.

Cider is Skipping or Not Playing Explicit Songs

Make sure that Music is set to Explicit.

::alert{type="note"} It could potentially be a case where explicit playback is restricted in your country, in this case you may need to change your Apple Account region to resolve this. ::

Why do I keep getting 'localtunnel.me connection refused' on macOS?

This is a fairly rare case and can be resolved fairly easily. Follow the steps below and it should resolve your issue:

1. Disable any Antivirus and/or Firewall present on your device. These can conflict with the WebSocket API in the client and will cause this error. (ESET is a known offender for this.)

2. Ensure you do not have a VPN on or any policies enabled on your device that can affect network traffic. Company managed devices may also have policies blocking this.

3. Check that you do not have Cider running already - and that nothing is running on the same port that Cider operates under - 10767.

Cider Frontend API (CiderFrontAPI)

App Functions/Methods (app.*)

Cider Audio (CiderAudio)

These are some unsorted quirks and features about Cider that will be moved later

• Cider is built with the following frameworks and technologies

  • Electron

  • Vue 2

  • Express

  • EJS

  • MusicKit.js

  • Some components from Bootstrap 5 (mainly grids and modals)

  • Bootstrap Vue

  • Bootbox

  • Notyf

Resources in the theme can be accessed by their filenames in the theme folder.

Examples:

background: url("my_image.png")

@import url('another_less_file.less')

Backend Development

Frontend Development

Publishing to GitHub

Once you have completed your plugin its time to publish! Create a new repository for the plugin and upload the files.

To have the theme indexed into Cider's built in plugin explorer, add cidermusicplugin as a topic on the repository.

Plugins from GitHub in Cider will display the repos README.md file within the Explore Plugins on GitHub page, so be sure to include some screenshots showing off your plugins.

Resources

Cider offers a simple REST API to remotely control the app.

URL: http://localhost:9000/api/

Endpoints

Once you have completed your plugin its time to publish! Create a new repository for the plugin and upload the files.

To have the theme indexed into Cider's built in plugin explorer, add cidermusicplugin as a topic on the repository.

If one does not already exist, create a new theme directory in the user data folder.

• Windows: %appdata%/Cider/themes

• Mac: ~/Library/Application Support/Cider/themes

• Linux: ~/.config/Cider/themes

Create a new folder in the themes directory with the name of your theme.

• This folder needs to contain the following files:

  • index.less - The main theme file

  • theme.json - Contains several properties for your theme

• You can clone a starter template from here:

In Cider, select the theme in the settings.

Cider has automatic hot reloading for themes in the userdata folder.

Useful Resources

• The default styles.less can be found in:

Once you have completed your plugin its time to publish! Create a new repository for the theme and upload the files.

To have the theme indexed into Cider's built in theme explorer, add cidermusictheme as a topic on the repository.

Cider defaults to using port 9000 for the client frontend. If you need to change this port, you can do so by setting the PORT environment variable.

Note: This only works on Electron Clients. Setting the port on Sabiiro is currently not supported.

Setting the Port in the CLI

When running Cider from the CLI you can set the ports as follows:

PORT=1111 ./cider-2.4.1.appimage

This will start the client frontend on port 1111.

Setting the Port in a etc/environment File

In linux you can set the port in a etc/environment file. This file is read by the system on startup and sets the environment variables for all processes. MacOS users can use the ~/.bash_profile file.

theme.json files require the following properties:

• name: string - The name of the theme

• description: string - Brief description of the theme

• version: string - Version of the theme

• author: string - Theme authors

• github_repo: string - The source repository of the theme, this is required for Cider to automatically update the theme. Formatted <owner>/<repo_name>

• pack: array - (optional) Declare individual LESS files as styles within the package

  • Pack Object Format:

    • name: string - Name of the style

    • file: string - File name within the package / repo

    • description: string - Description of the style

Attributes are applied to elements to expose app state information to CSS