tilera/nyxx
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

New interactions example and readme update

Browse source
This commit is contained in:
Szymon Uglis 2021-04-06 09:45:59 +02:00
parent dd5355b0f2
commit 0585fff0a5
No known key found for this signature in database
GPG key ID: A8D86F91E9093D69
6 changed files with 158 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -1,20 +1,19 @@
<div align="center">
<br />
<p> <img width="600" src="https://l7ssha.github.io/nyxx0.png" />
<br />
# nyxx
[![Build Status](https://travis-ci.org/l7ssha/nyxx.svg?branch=master)](https://travis-ci.org/l7ssha/nyxx)
[![Pub](https://img.shields.io/pub/v/nyxx.svg)](https://pub.dartlang.org/packages/nyxx)
[![pub](https://img.shields.io/pub/v/nyxx.svg)](https://pub.dartlang.org/packages/nyxx)
[![documentation](https://img.shields.io/badge/Documentation-nyxx-yellow.svg)](https://www.dartdocs.org/documentation/nyxx/latest/)
[![documentation](https://img.shields.io/badge/Documentation-nyxx.commander-yellow.svg)](https://www.dartdocs.org/documentation/nyxx.commander/latest/)
[![documentation](https://img.shields.io/badge/Documentation-nyxx.interactions-yellow.svg)](https://www.dartdocs.org/documentation/nyxx.interactions/latest/)
[![documentation](https://img.shields.io/badge/Documentation-nyxx.extentions-yellow.svg)](https://www.dartdocs.org/documentation/nyxx.extensions/latest/)
Simple, robust framework for creating discord bots for Dart language.
<hr />
</div>
### Features
- **Slash commands support** <br>
Supports and provides easy API for creating and handling slash commands
- **Commands framework included** <br>
A fast way to create a bot with command support. Implementing the framework is simple - and everything is done automatically.
- **Cross Platform** <br>
@ -30,20 +29,34 @@ Simple, robust framework for creating discord bots for Dart language.
Basic usage:
```dart
void main() {
var bot = Nyxx("TOKEN");
final bot = Nyxx("TOKEN", GatewayIntents.allUnprivileged);
bot.onMessageReceived.listen((event) {
if (event.message.content == "!ping") {
event.message.channel.send(content: "Pong!");
(event.message.channel.getOrDownload() as TextChannel).sendMessage(content: "Pong!");
}
});
}
```
Slash commands:
```dart
void main() {
final bot = Nyxx("<%TOKEN%>", GatewayIntents.all);
final interactions = Interactions(bot);
interactions
..registerHandler("test", "This is test comamnd", [], handler: (event) async {
await event.acknowledge(showSource: true);
await event.reply(content: "This is example message result");
});
}
```
Commands:
```dart
void main() {
final bot = Nyxx("TOKEN");
final bot = Nyxx("TOKEN", GatewayIntents.allUnprivileged);
Commander(bot, prefix: "!!!")
..registerCommand("ping", (context, message) => context.reply(content: "Pong!"));
@ -52,9 +65,11 @@ void main() {
## More examples
Nyxx examples can be found [here](https://github.com/l7ssha/nyxx/tree/development/nyxx/example).
Nyxx examples can be found [here](https://github.com/l7ssha/nyxx/tree/dev/nyxx/example).
Commander examples can be found [here](https://github.com/l7ssha/nyxx/tree/development/nyxx.commander/example)
Commander examples can be found [here](https://github.com/l7ssha/nyxx/tree/dev/nyxx.commander/example)
Slash commands (interactions) examples can be found [here](https://github.com/l7ssha/nyxx/tree/dev/nyxx.interactions/example)
### Example bots
- [Running on Dart](https://github.com/l7ssha/running_on_dart)

41
nyxx.commander/README.md
View file

@ -1,20 +1,19 @@
<div align="center">
<br />
<p> <img width="600" src="https://l7ssha.github.io/nyxx0.png" />
<br />
# nyxx.commander
[![Build Status](https://travis-ci.org/l7ssha/nyxx.svg?branch=master)](https://travis-ci.org/l7ssha/nyxx)
[![Pub](https://img.shields.io/pub/v/nyxx.svg)](https://pub.dartlang.org/packages/nyxx)
[![pub](https://img.shields.io/pub/v/nyxx.svg)](https://pub.dartlang.org/packages/nyxx)
[![documentation](https://img.shields.io/badge/Documentation-nyxx-yellow.svg)](https://www.dartdocs.org/documentation/nyxx/latest/)
[![documentation](https://img.shields.io/badge/Documentation-nyxx.commander-yellow.svg)](https://www.dartdocs.org/documentation/nyxx.commander/latest/)
[![documentation](https://img.shields.io/badge/Documentation-nyxx.interactions-yellow.svg)](https://www.dartdocs.org/documentation/nyxx.interactions/latest/)
[![documentation](https://img.shields.io/badge/Documentation-nyxx.extentions-yellow.svg)](https://www.dartdocs.org/documentation/nyxx.extensions/latest/)
Simple, robust framework for creating discord bots for Dart language.
<hr />
</div>
### Features
- **Slash commands support** <br>
Supports and provides easy API for creating and handling slash commands
- **Commands framework included** <br>
A fast way to create a bot with command support. Implementing the framework is simple - and everything is done automatically.
- **Cross Platform** <br>
@ -30,20 +29,34 @@ Simple, robust framework for creating discord bots for Dart language.
Basic usage:
```dart
void main() {
var bot = Nyxx("TOKEN");
final bot = Nyxx("TOKEN", GatewayIntents.allUnprivileged);
bot.onMessageReceived.listen((event) {
if (event.message.content == "!ping") {
event.message.channel.send(content: "Pong!");
(event.message.channel.getOrDownload() as TextChannel).sendMessage(content: "Pong!");
}
});
}
```
Slash commands:
```dart
void main() {
final bot = Nyxx("<%TOKEN%>", GatewayIntents.all);
final interactions = Interactions(bot);
interactions
..registerHandler("test", "This is test comamnd", [], handler: (event) async {
await event.acknowledge(showSource: true);
await event.reply(content: "This is example message result");
});
}
```
Commands:
```dart
void main() {
final bot = Nyxx("TOKEN");
final bot = Nyxx("TOKEN", GatewayIntents.allUnprivileged);
Commander(bot, prefix: "!!!")
..registerCommand("ping", (context, message) => context.reply(content: "Pong!"));
@ -52,9 +65,11 @@ void main() {
## More examples
Nyxx examples can be found [here](https://github.com/l7ssha/nyxx/tree/development/nyxx/example).
Nyxx examples can be found [here](https://github.com/l7ssha/nyxx/tree/dev/nyxx/example).
Commander examples can be found [here](https://github.com/l7ssha/nyxx/tree/development/nyxx.commander/example)
Commander examples can be found [here](https://github.com/l7ssha/nyxx/tree/dev/nyxx.commander/example)
Slash commands (interactions) examples can be found [here](https://github.com/l7ssha/nyxx/tree/dev/nyxx.interactions/example)
### Example bots
- [Running on Dart](https://github.com/l7ssha/running_on_dart)

41
nyxx.extensions/README.md
View file

@ -1,20 +1,19 @@
<div align="center">
<br />
<p> <img width="600" src="https://l7ssha.github.io/nyxx0.png" />
<br />
# nyxx.extensions
[![Build Status](https://travis-ci.org/l7ssha/nyxx.svg?branch=master)](https://travis-ci.org/l7ssha/nyxx)
[![Pub](https://img.shields.io/pub/v/nyxx.svg)](https://pub.dartlang.org/packages/nyxx)
[![pub](https://img.shields.io/pub/v/nyxx.svg)](https://pub.dartlang.org/packages/nyxx)
[![documentation](https://img.shields.io/badge/Documentation-nyxx-yellow.svg)](https://www.dartdocs.org/documentation/nyxx/latest/)
[![documentation](https://img.shields.io/badge/Documentation-nyxx.commander-yellow.svg)](https://www.dartdocs.org/documentation/nyxx.commander/latest/)
[![documentation](https://img.shields.io/badge/Documentation-nyxx.interactions-yellow.svg)](https://www.dartdocs.org/documentation/nyxx.interactions/latest/)
[![documentation](https://img.shields.io/badge/Documentation-nyxx.extentions-yellow.svg)](https://www.dartdocs.org/documentation/nyxx.extensions/latest/)
Simple, robust framework for creating discord bots for Dart language.
<hr />
</div>
### Features
- **Slash commands support** <br>
Supports and provides easy API for creating and handling slash commands
- **Commands framework included** <br>
A fast way to create a bot with command support. Implementing the framework is simple - and everything is done automatically.
- **Cross Platform** <br>
@ -30,20 +29,34 @@ Simple, robust framework for creating discord bots for Dart language.
Basic usage:
```dart
void main() {
var bot = Nyxx("TOKEN");
final bot = Nyxx("TOKEN", GatewayIntents.allUnprivileged);
bot.onMessageReceived.listen((event) {
if (event.message.content == "!ping") {
event.message.channel.send(content: "Pong!");
(event.message.channel.getOrDownload() as TextChannel).sendMessage(content: "Pong!");
}
});
}
```
Slash commands:
```dart
void main() {
final bot = Nyxx("<%TOKEN%>", GatewayIntents.all);
final interactions = Interactions(bot);
interactions
..registerHandler("test", "This is test comamnd", [], handler: (event) async {
await event.acknowledge(showSource: true);
await event.reply(content: "This is example message result");
});
}
```
Commands:
```dart
void main() {
final bot = Nyxx("TOKEN");
final bot = Nyxx("TOKEN", GatewayIntents.allUnprivileged);
Commander(bot, prefix: "!!!")
..registerCommand("ping", (context, message) => context.reply(content: "Pong!"));
@ -52,9 +65,11 @@ void main() {
## More examples
Nyxx examples can be found [here](https://github.com/l7ssha/nyxx/tree/development/nyxx/example).
Nyxx examples can be found [here](https://github.com/l7ssha/nyxx/tree/dev/nyxx/example).
Commander examples can be found [here](https://github.com/l7ssha/nyxx/tree/development/nyxx.commander/example)
Commander examples can be found [here](https://github.com/l7ssha/nyxx/tree/dev/nyxx.commander/example)
Slash commands (interactions) examples can be found [here](https://github.com/l7ssha/nyxx/tree/dev/nyxx.interactions/example)
### Example bots
- [Running on Dart](https://github.com/l7ssha/running_on_dart)

43
nyxx.interactions/README.md
View file

@ -1,20 +1,19 @@
<div align="center">
<br />
<p> <img width="600" src="https://l7ssha.github.io/nyxx0.png" />
<br />
# nyxx.interactions
[![Build Status](https://travis-ci.org/l7ssha/nyxx.svg?branch=master)](https://travis-ci.org/l7ssha/nyxx)
[![Pub](https://img.shields.io/pub/v/nyxx.svg)](https://pub.dartlang.org/packages/nyxx)
[![pub](https://img.shields.io/pub/v/nyxx.svg)](https://pub.dartlang.org/packages/nyxx)
[![documentation](https://img.shields.io/badge/Documentation-nyxx-yellow.svg)](https://www.dartdocs.org/documentation/nyxx/latest/)
[![documentation](https://img.shields.io/badge/Documentation-nyxx.commander-yellow.svg)](https://www.dartdocs.org/documentation/nyxx.commander/latest/)
[![documentation](https://img.shields.io/badge/Documentation-nyxx.interactions-yellow.svg)](https://www.dartdocs.org/documentation/nyxx.interactions/latest/)
[![documentation](https://img.shields.io/badge/Documentation-nyxx.extentions-yellow.svg)](https://www.dartdocs.org/documentation/nyxx.extensions/latest/)
Simple, robust framework for creating discord bots for Dart language.
<hr />
</div>
### Features
- **Slash commands support** <br>
Supports and provides easy API for creating and handling slash commands
- **Commands framework included** <br>
A fast way to create a bot with command support. Implementing the framework is simple - and everything is done automatically.
- **Cross Platform** <br>
@ -30,20 +29,34 @@ Simple, robust framework for creating discord bots for Dart language.
Basic usage:
```dart
void main() {
var bot = Nyxx("TOKEN");
final bot = Nyxx("TOKEN", GatewayIntents.allUnprivileged);
bot.onMessageReceived.listen((event) {
if (event.message.content == "!ping") {
event.message.channel.send(content: "Pong!");
(event.message.channel.getOrDownload() as TextChannel).sendMessage(content: "Pong!");
}
});
}
```
Slash commands:
```dart
void main() {
final bot = Nyxx("<%TOKEN%>", GatewayIntents.all);
final interactions = Interactions(bot);
interactions
..registerHandler("test", "This is test comamnd", [], handler: (event) async {
await event.acknowledge(showSource: true);
await event.reply(content: "This is example message result");
});
}
```
Commands:
```dart
void main() {
final bot = Nyxx("TOKEN");
final bot = Nyxx("TOKEN", GatewayIntents.allUnprivileged);
Commander(bot, prefix: "!!!")
..registerCommand("ping", (context, message) => context.reply(content: "Pong!"));
@ -52,9 +65,11 @@ void main() {
## More examples
Nyxx examples can be found [here](https://github.com/l7ssha/nyxx/tree/development/nyxx/example).
Nyxx examples can be found [here](https://github.com/l7ssha/nyxx/tree/dev/nyxx/example).
Commander examples can be found [here](https://github.com/l7ssha/nyxx/tree/development/nyxx.commander/example)
Commander examples can be found [here](https://github.com/l7ssha/nyxx/tree/dev/nyxx.commander/example)
Slash commands (interactions) examples can be found [here](https://github.com/l7ssha/nyxx/tree/dev/nyxx.interactions/example)
### Example bots
- [Running on Dart](https://github.com/l7ssha/running_on_dart)
@ -85,4 +100,4 @@ Read [contributing document](https://github.com/l7ssha/nyxx/blob/development/CON
## Credits
* [Hackzzila's](https://github.com/Hackzzila) for [nyx](https://github.com/Hackzzila/nyx).
* [Hackzzila's](https://github.com/Hackzzila) for [nyx](https://github.com/Hackzzila/nyx).

17
nyxx.interactions/interactions.dart Normal file
View file

@ -0,0 +1,17 @@
import "package:nyxx/nyxx.dart";
import "package:nyxx_interactions/interactions.dart";
void main() {
final bot = Nyxx("<%TOKEN%>", GatewayIntents.all);
final interactions = Interactions(bot);
interactions
..registerHandler("test", "This is test comamnd", [], handler: (event) async {
// Acknowledge about event so you can send reply later. You have 3 second to either ack command
// or send response
await event.acknowledge(showSource: true);
// After long running task, send response
await event.reply(content: "This is example message result");
});
}

41
nyxx/README.md
View file

@ -1,20 +1,19 @@
<div align="center">
<br />
<p> <img width="600" src="https://l7ssha.github.io/nyxx0.png" />
<br />
# nyxx
[![Build Status](https://travis-ci.org/l7ssha/nyxx.svg?branch=master)](https://travis-ci.org/l7ssha/nyxx)
[![Pub](https://img.shields.io/pub/v/nyxx.svg)](https://pub.dartlang.org/packages/nyxx)
[![pub](https://img.shields.io/pub/v/nyxx.svg)](https://pub.dartlang.org/packages/nyxx)
[![documentation](https://img.shields.io/badge/Documentation-nyxx-yellow.svg)](https://www.dartdocs.org/documentation/nyxx/latest/)
[![documentation](https://img.shields.io/badge/Documentation-nyxx.commander-yellow.svg)](https://www.dartdocs.org/documentation/nyxx.commander/latest/)
[![documentation](https://img.shields.io/badge/Documentation-nyxx.interactions-yellow.svg)](https://www.dartdocs.org/documentation/nyxx.interactions/latest/)
[![documentation](https://img.shields.io/badge/Documentation-nyxx.extentions-yellow.svg)](https://www.dartdocs.org/documentation/nyxx.extensions/latest/)
Simple, robust framework for creating discord bots for Dart language.
<hr />
</div>
### Features
- **Slash commands support** <br>
Supports and provides easy API for creating and handling slash commands
- **Commands framework included** <br>
A fast way to create a bot with command support. Implementing the framework is simple - and everything is done automatically.
- **Cross Platform** <br>
@ -30,20 +29,34 @@ Simple, robust framework for creating discord bots for Dart language.
Basic usage:
```dart
void main() {
var bot = Nyxx("TOKEN");
final bot = Nyxx("TOKEN", GatewayIntents.allUnprivileged);
bot.onMessageReceived.listen((event) {
if (event.message.content == "!ping") {
event.message.channel.send(content: "Pong!");
(event.message.channel.getOrDownload() as TextChannel).sendMessage(content: "Pong!");
}
});
}
```
Slash commands:
```dart
void main() {
final bot = Nyxx("<%TOKEN%>", GatewayIntents.all);
final interactions = Interactions(bot);
interactions
..registerHandler("test", "This is test comamnd", [], handler: (event) async {
await event.acknowledge(showSource: true);
await event.reply(content: "This is example message result");
});
}
```
Commands:
```dart
void main() {
final bot = Nyxx("TOKEN");
final bot = Nyxx("TOKEN", GatewayIntents.allUnprivileged);
Commander(bot, prefix: "!!!")
..registerCommand("ping", (context, message) => context.reply(content: "Pong!"));
@ -52,9 +65,11 @@ void main() {
## More examples
Nyxx examples can be found [here](https://github.com/l7ssha/nyxx/tree/development/nyxx/example).
Nyxx examples can be found [here](https://github.com/l7ssha/nyxx/tree/dev/nyxx/example).
Commander examples can be found [here](https://github.com/l7ssha/nyxx/tree/development/nyxx.commander/example)
Commander examples can be found [here](https://github.com/l7ssha/nyxx/tree/dev/nyxx.commander/example)
Slash commands (interactions) examples can be found [here](https://github.com/l7ssha/nyxx/tree/dev/nyxx.interactions/example)
### Example bots
- [Running on Dart](https://github.com/l7ssha/running_on_dart)