Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Konloch committed Dec 16, 2023
1 parent 87411d6 commit 7d503c7
Showing 1 changed file with 73 additions and 1 deletion.
74 changes: 73 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ channel1.send("Hello channel #1");
channel2.send("Hello channel #2");
```

4) You can define message listeners to receive and send messages.
4) You can define server message listeners to receive and send messages. *This uses the **server** object*
```java
//handle incoming channel messages
server.onChannelMessage(event -> {
Expand Down Expand Up @@ -81,6 +81,78 @@ server.onLeave(event -> {
});
```

5) You can define channel message listeners to receive and send messages. *This uses the **channel** object*
```java
//handle incoming channel messages
channel1.onMessage(event -> {
Channel channel = event.getChannel();
User user = event.getUser();
String msg = event.getMessage();

if(msg.toLowerCase().contains("hello")) {
channel.send("Hello, this is a channel message");
user.send("Hello, this is a private message");
}
});

//handle channel join updates
channel1.onJoin(event -> {
Channel channel = event.getChannel();
User user = event.getUser();

System.out.println("JOIN: " + channel.getName() + "[" + channel.getUsers().size() + "] " + user.getNickname());
});

//handle channel leave updates
channel1.onLeave(event -> {
Channel channel = event.getChannel();
User user = event.getUser();

System.out.println("QUIT: " + channel.getName() + "[" + channel.getUsers().size() + "] " + user.getNickname());
});
```

6) You can define global message listeners to receive and send messages. *This uses the **bot** object*
```java

//handle incoming channel messages
bot.onChannelMessage(event -> {
Channel channel = event.getChannel();
User user = event.getUser();
String msg = event.getMessage();

if(msg.toLowerCase().contains("hello")) {
channel.send("Hello, this is a channel message");
user.send("Hello, this is a private message");
}
});

//handle incoming private messages
bot.onPrivateMessage(event -> {
User user = event.getUser();
String msg = event.getMessage();

if(msg.toLowerCase().contains("hello"))
user.send("Hello, this is a private message");
});

//handle channel join updates
bot.onJoin(event -> {
Channel channel = event.getChannel();
User user = event.getUser();

System.out.println("JOIN: " + channel.getName() + "[" + channel.getUsers().size() + "] " + user.getNickname());
});

//handle channel leave updates
bot.onLeave(event -> {
Channel channel = event.getChannel();
User user = event.getUser();

System.out.println("QUIT: " + channel.getName() + "[" + channel.getUsers().size() + "] " + user.getNickname());
});
```

## 👨‍💻 Disclaimer
+ Still a work in progress / in development
+ Lacks most IRC features beyond the absolute basics

0 comments on commit 7d503c7

Please sign in to comment.