Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/termermc/node-ircd-base
A Node.js library for implementing IRC servers using a simple API
https://github.com/termermc/node-ircd-base
Last synced: about 2 months ago
JSON representation
A Node.js library for implementing IRC servers using a simple API
- Host: GitHub
- URL: https://github.com/termermc/node-ircd-base
- Owner: termermc
- License: mit
- Created: 2022-07-24T02:25:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-26T10:14:31.000Z (3 months ago)
- Last Synced: 2024-10-27T06:53:30.871Z (3 months ago)
- Language: TypeScript
- Size: 106 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-ircd-base
A dependency-free, typesafe Node.js library for implementing IRC servers using a simple API.
Supports Node.js, Deno and Bun.
[](https://www.npmjs.com/package/ircd-base)
# Install
To install it in your project, run `npm install ircd-base`.
# What is it?
This library is a set of building blocks to create your own IRC server (IRCd).
This can be used for a variety of purposes, including creating IRC gateways to other protocols, creating custom chat servers, and integrating IRC into existing Node.js projects.
To show the capabilities of the library check out the following example:
```typescript
import { Ircd } from 'ircd-base'
// Start a basic development server that displays the capabilities of the library
// The server's cosmetic hostname will be 'my-network' (doesn't affect where the server listens)
const ircd = new Ircd('my.network')
ircd.onConnect(async function (client) {
console.log('Client connected')
await client.sendNotice('You are about to login')
client.onLoginAttempt(async function (userInfo, password, accept, deny) {
if (password === 'test') {
await accept()
} else {
await deny()
}
})
client.onSuccessfulLogin(async function () {
console.log(`User ${client.nick} authenticated`)
await client.sendMotd('Hello world!\nThis is my test MotD!\nWelcome to my IRCd!')
await client.setMode('+Zi')
})
client.onFailedLogin(async function (userInfo, password) {
console.log(`User ${userInfo.nick} tried to login with password "${password}", but it wasn't correct`)
await client.disconnect('Wrong username or password')
})
client.onDisconnect(function () {
if (client.isAuthenticated) {
console.log(`User ${client.nick} disconnected`)
} else {
console.log('Unauthenticated client disconnected')
}
})
})
ircd.listen(6667, 'localhost').then(function () {
console.log(`Listening at ${ircd.host}:${ircd.port}`)
})
```
An IRC server running on port 6667 that allows users to login only using the password "test", after which a MotD is sent.
All that was required was 38 lines of clean code.
Because all the library provides is an interface for receiving events and interacting with clients, all logic is left to the programmer.
This provides the programmer with freedom to script their IRC server however they want without having to worry about IRC protocol specifics.
# Support/Contact
If you have any questions or need any help, join #node-ircd-base on irc.rizon.net.
If you spot a bug or are requesting a feature, please open an issue on this repository.
To contact the library author, you can message "termer" on irc.rizon.net, or see my [GitHub profile](https://github.com/termermc) for my email.