doupkg / lapcord-server

๐ŸŒบ A language server protocol written in TypeScript to interact with Discord IPC. Lapcord required add-on.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

lapcord-server

Discord GitHub Workflow Status npm GitHub contributors (via allcontributors.org) GitHub

Table of Contents

Getting Started

To begin using Lapcord you will have to install its extension in Lapce, which can be found at plugins.lapce.dev.

Installing Lapcord

Package Manager Command
NPM $ npm install -g lapcord
Yarn $ yarn global add lapcord
PNPM $ pnpm add -g lapcord
Ensure that you have the package manager binaries installed in your path.

Now, Lapcord binaries should be installed globally.

To verify the installation, run lapcord. If the command is recognized, it means Lapcord is installed correctly; otherwise, it is not.

Using Lapcord

Open Lapce in a folder. Your Discord profile should now display a presence like this:

Preview
discord-rpc
If you don't have Discord open on your computer, Lapcord will notify you that an error occurred

Lapcord logs

Lapcord logs initialization events and errors in Lapce's logs. It stores its cache in the .cache directory within the module folder to avoid excessive requests to the npm API for registering the latest version and to prevent ratelimit.

Configuration

Lapcord configuration is split into two sections: editing and idle configuration. Each section has templates with keywords for internal property usage.

Editing syntax

Keyword Description Output
{{file_name} File name index.ts
{{file_ext}} File extension .ts
{{language_asset}} Language asset typescript
{{language_capital}} Language capital TYPESCRIPT
{{language_id}} Language ID TypeScript
{{workspace_name}} Workspace name project
{{workspace_path}} Workspace path /home/usr/project/

Idle syntax

Keyword Description Output
{{workspace_name}} Workspace name project
{{workspace_path}} Workspace path /home/usr/project/

Contributing

See CONTRIBUTING.md.

Contributors

Thanks goes to these wonderful people (emoji key):

DexSlender
DexSlender

๐Ÿ’ป ๐Ÿค” โš ๏ธ
Paulo
Paulo

๐Ÿ’ป ๐Ÿšง ๐Ÿค”
Jesus Alejandro
Jesus Alejandro

๐Ÿ’ป ๐ŸŽจ โš ๏ธ

Credits

About

๐ŸŒบ A language server protocol written in TypeScript to interact with Discord IPC. Lapcord required add-on.

License:MIT License


Languages

Language:TypeScript 93.3%Language:JavaScript 6.7%