nyxx 0.22.1

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • new72


Build Status Pub documentation

Simple, robust framework for creating discord bots for Dart. <br /> Fork of Hackzzila's nyx - extended with new functionality, few bug fixes, applied pending pull requests.


Features

  • Commands framework <br> Faster way of creating commands for bot. You just have to implement one class, and initialize framework. Everything is done automatically.
  • Cross Platform <br> Nyxx works on the command line, browser, mobile, and can be transpiled to JavaScript.
  • Fine Control <br> Nyxx allows you to control every outgoing HTTP request or websocket messages.
  • Internal Sharding <br> Nyxx automatically spawns shards for your bot, but you can override this and spawn a custom number of shards. Internal sharding means that all of your bots servers are managed in one script, no need for communication between shards.
  • Complete <br> Nyxx support nearly all DiscordAPI endpoints.

Documentation and examples

Dartdocs

Latest docs for newest release.

Dev docs

My website has docs for latests commits - You can read about incoming changes

Wiki

Wiki docs are designed to match latest release.

Roadmap

  • Better dartdocs documentation
  • More examples at wiki/more tutorial/Video tutorial
  • Bigger bot written in nyxx for example
  • Fix lint errors from dartanalyzer
  • Annotation driver flow for CommandsFramework?
  • Recheck all code and fix styling/small logic bugs

0.22.1

Wed 11.07.2018

  • Bug fixes
    • Fixed bug with sending Emoji. toString() now return proper representation ready to send via message
  • New features
    • Searching in EmojisUnicode is now handled by future.
    • toString() in User, Channel, Role now returns mention instead of content, name etc.

0.22.0

Wed 11.07.2018

  • Bug fixes
    • Next serialization bug fixes
  • New features
    • Added support for audit logs
    • Searching in EmojisUnicode based on shortcode

0.21.5

Fri 09.07.2018

  • Bug fixes
    • Fixed embed serialization

0.21.4

Fri 09.07.2018

  • Bug fixes
    • Fixed embed serialization

0.21.3

Fri 08.07.2018

  • Bug fixes
    • Fixed embed serialization
  • Added few Docs

0.21.2

Fri 06.07.2018

  • Bug fixes
    • Added overrides
    • Implemented hashCode
    • Fixed return type for delay() in Command class

0.21.1

Fri 06.07.2018

  • Bug fixes
    • Fixed constructors in MessageChannel and TextChannel

0.21.0

Fri 06.07.2018

  • New features
    • Support for sending files, attaching files in embed
    • Added missing gateway events
    • Replaced String ids with Snowflake type
  • Bug fixes

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  nyxx: "^0.22.1"

2. Install it

You can install packages from the command line:

with pub:


$ pub get

Alternatively, your editor might support pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


      import 'package:nyxx/nyxx.dart';
  
Version Uploaded Documentation Archive
0.22.1 Jul 13, 2018 Go to the documentation of nyxx 0.22.1 Download nyxx 0.22.1 archive
0.22.0 Jul 11, 2018 Go to the documentation of nyxx 0.22.0 Download nyxx 0.22.0 archive
0.21.5 Jul 9, 2018 Go to the documentation of nyxx 0.21.5 Download nyxx 0.21.5 archive
0.21.4 Jul 9, 2018 Go to the documentation of nyxx 0.21.4 Download nyxx 0.21.4 archive
0.21.3 Jul 8, 2018 Go to the documentation of nyxx 0.21.3 Download nyxx 0.21.3 archive
0.21.2 Jul 6, 2018 Go to the documentation of nyxx 0.21.2 Download nyxx 0.21.2 archive
0.21.1 Jul 6, 2018 Go to the documentation of nyxx 0.21.1 Download nyxx 0.21.1 archive
0.21.0 Jul 6, 2018 Go to the documentation of nyxx 0.21.0 Download nyxx 0.21.0 archive
0.20.0 Jul 2, 2018 Go to the documentation of nyxx 0.20.0 Download nyxx 0.20.0 archive
0.19.1 Jun 30, 2018 Go to the documentation of nyxx 0.19.1 Download nyxx 0.19.1 archive

All 17 versions...

Analysis

We analyzed this package on Jul 13, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.63.0
  • pana: 0.11.3

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
43 / 100
Health:
Code health derived from static analysis. [more]
100 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100 / 100
Overall score:
Weighted score of the above. [more]
72
Learn more about scoring.

Platforms

Detected platforms: other

Primary library: package:nyxx/nyxx.dart with components: io, mirrors.

Suggestions

  • The description is too short.

    Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

  • Package is pre-v1 release.

    While there is nothing inherently wrong with versions of 0.*.*, it usually means that the author is still experimenting with the general direction API.

  • Fix analysis and formatting issues.

    Analysis or formatting checks reported 7 hints.

    Strong-mode analysis of lib/src/objects/Shard.dart gave the following hint:

    line: 85 col: 9
    'JSON' is deprecated and shouldn't be used.

    Strong-mode analysis of lib/src/objects/Snowflake.dart gave the following hint:

    line: 29 col: 9
    The value of the local variable '_maxWorkerId' isn't used.

    Similar analysis of the following files failed:

    • lib/src/objects/auditlogs/AuditLog.dart (hint)
    • lib/src/objects/channel/MessageChannel.dart (hint)
  • Maintain an example.

    None of the files in your example/ directory matches a known example patterns. Common file name patterns include: main.dart, example.dart or you could also use nyxx.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=1.23.0 <2.0.0
http_parser >=3.0.0 <4.0.0 3.1.2
w_transport >=3.0.0 <4.0.0 3.2.5
Transitive dependencies
browser 0.10.0+3
charcode 1.1.2
collection 1.14.10
dart2_constant 1.0.1+dart2
fluri 1.2.4
intl 0.15.6
js 0.6.1
logging 0.11.3+1
meta 1.1.5
mime 0.9.6+1
path 1.6.1
sockjs_client 0.3.3
sockjs_client_wrapper 1.0.4
source_span 1.4.0
string_scanner 1.0.2
typed_data 1.1.5
w_common 1.13.0
Dev dependencies
dart_style