Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/performanc/coglink
Coglink, the C Lavalink client, with the most performance above all Lavalink wrappers.
https://github.com/performanc/coglink
discord lavalink lavalink-client music player-audio
Last synced: 3 months ago
JSON representation
Coglink, the C Lavalink client, with the most performance above all Lavalink wrappers.
- Host: GitHub
- URL: https://github.com/performanc/coglink
- Owner: PerformanC
- License: bsd-2-clause
- Created: 2022-10-26T21:09:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-17T05:58:23.000Z (9 months ago)
- Last Synced: 2024-05-17T10:32:53.792Z (9 months ago)
- Topics: discord, lavalink, lavalink-client, music, player-audio
- Language: C
- Homepage:
- Size: 331 KB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CogLink
A Concord (C99) LavaLink/NodeLink client.
## Features
- C99 compatible
- Low memory usage (> 5MB of RAM a working bot)
- Portable
## Dependencies
- [`Concord`](https://github.com/Cogmasters/Concord)
> [!NOTE]
> CogLink only relies on dependencies already included in Concord.
## Installation
### 1. Install Concord
The installation guide for Concord can be found [in their repository](https://github.com/Cogmasters/concord?tab=readme-ov-file#build-instructions).
### 2. Clone the repository
```shell
$ git clone https://github.com/PerformanC/CogLink
```
### 3. Compile
```shell
$ cd CogLink
$ make -j4
```
> [!NOTE]
> The `-j4` flag is optional, but it will speed up the compilation process. The number after `-j` is the number of threads to use for compilation.
### 4. Install
```shell
$ sudo make install
```
## Usage
... TODO
## Documentation
[CogLink documentation](https://performanc.github.io/CoglinDocs/) is made with Doxygen, hosted on GitHub Pages.
The documentation can be built with the following command:
```shell
$ make gen_docs
```
> [!NOTE]
> Doxygen is required to build the documentation.
## Support
Any question or issue related to CogLink or other PerformanC projects can be can be made in [PerformanC's Discord server](https://discord.gg/uPveNfTuCJ).
For verified issues, please also create a GitHub issue for tracking the issue.
## Contributing
CogLink follows the PerformanC's [contribution guidelines](https://github.com/PerformanC/contributing). It is necessary to follow the guidelines to contribute to CogLink and other PerformanC projects.
## Projects using CogLink
None known yet, but if you are using CogLink, please let us know in [PerformanC's Discord server](https://discord.gg/uPveNfTuCJ) and we will add your project here.
## License
CogLink is licensed under [BSD 2-Clause License](LICENSE). You can read more about it on [Open Source Initiative](https://opensource.org/licenses/BSD-2-Clause).
* This project uses the latest standards of The PerformanC Organization.