Getting Started

Installation

Prerequisites

• Git.
• Node.js version 18 or higher, includes Corepack by default.
• Terminal for accessing PreMiD's Developer Tools via its command-line interface (CLI).
• Text Editor with TypeScript syntax highlighting support.
  • Visual Studio Code is recommended, as it includes TypeScript support out-of-the-box.

Clone the Repository

• Open your terminal and run the following command:

  git clone https://github.com/PreMiD/Presences.git

• Change your working directory to the repository:

  cd Presences

Install Dependencies

• Ensure you have Node.js installed by running:

  node -v

  If you see a version number, Node.js is installed. Make sure you have Node.js version 18 or higher.
• Enable Corepack by running:

  corepack enable

• Install the project dependencies:

  pnpm install

Coding your Presence

Follow the Creating a Presence guide to get started with coding your own Presence.

Submitting your Presence

Once you've finished coding your Presence, you can submit it to the PreMiD Store for others to use. Follow the Submitting a Presence guide to learn how to submit your Presence.

A member of the PreMiD Team will review your submission and if it meets the guidelines, it will be added to the PreMiD Store for everyone to use. If your submission is rejected, you will receive feedback on how to improve it.

Please note that all submissions are subject to review and approval by the PreMiD Team. We reserve the right to reject any submission that does not meet our guidelines or quality standards. Reviews may take up to 7 days to complete.