Setting up

Setting up nekocord development

To get started, clone the nekocord repository by running the following command:

# Clone via SSH
git clone git@github.com:nekocord-mod/nekocord.git
# or if you prefer HTTPS
git clone https://github.com/nekocord-mod/nekocord.git

After cloning, you’ll want to cd into the nekocord directory and run the following command to install the dependencies:

pnpm install

Now you can run the following command to build nekocord:

pnpm build

And to install nekocord, run

pnpm inject

Afterwards, fully close Discord (check Task Manager / Activity Monitor / System Monitor and your system tray!) and reopen it. Then, check DevTools to check if nekocord is running as a dev build. You’ll see a message similar to the follwing:

welcome to
             _                           _
            | |                         | |
  _ __   ___| | _____   ___ ___  _ __ __| |
 | '_ \ / _ \ |/ / _ \ / __/ _ \| '__/ _` |
 | | | |  __/   < (_) | (_| (_) | | | (_| |
 |_| |_|\___|_|\_\___/ \___\___/|_|  \__,_|

by nekohaxx and contributors >w<

Version v0.1.0-main+66e41b1, built 2024-05-22T06:01:34.737Z.
Development Build

You can also check the nekocord section in Discord settings.

If you see this message, you’re all set!