Using Node
You can install yolkbot using whatever package manager supports your needs. Bun is the most modern (and fastest) option on the market, but if you need to use npm or pnpm, these are supported as well.
bun add yolkbot@latest
The package is stylized in folder structure. You never import yolkbot directly, but instead import the specific parts you need. For example, to import the Bot class, you would do:
import Bot from 'yolkbot/bot';
If you want to use a dispatch, you would do:
import { ChatDispatch } from 'yolkbot/dispatches';
// or...
import ChatDispatch from 'yolkbot/dispatches/ChatDispatch';
That's the basics of Node usage. Time to build your first bot!
yolkbot bundles types in the package, which means VSCode and other IDEs will provide you with autocompletion, import suggestion, and (if using Typescript) type checking.
Supported Environments
yolkbot FULLY supports Node, Deno, AND Bun. It is recommended to use Bun for the best performance, but if you need to use Node or Deno, these are supported as well. The previous incompatibility issues with Bun have been resolved as of yolkbot v1.3.0.
yolkbot also can be installed using Bun, npm, or pnpm. Yarn may work, but no support is provided and it is not tested.
yolkbot is limited to Node-like environments that are supported by wwws. You can read more information about what wwws supports here. If wwws does not support your environment, open an issue on the wwws repository. wwws's compatibility does not include browsers, which have entirely different requirements (see browser file for more information).
Using Node
You can install yolkbot using whatever package manager supports your needs. Bun is the most modern (and fastest) option on the market, but if you need to use npm or pnpm, these are supported as well.
bun add yolkbot@latest
The package is stylized in folder structure. You never import yolkbot directly, but instead import the specific parts you need. For example, to import the Bot class, you would do:
import Bot from 'yolkbot/bot';
If you want to use a dispatch, you would do:
import { ChatDispatch } from 'yolkbot/dispatches';
// or...
import ChatDispatch from 'yolkbot/dispatches/ChatDispatch';
That's the basics of Node usage. Time to build your first bot!
yolkbot bundles types in the package, which means VSCode and other IDEs will provide you with autocompletion, import suggestion, and (if using Typescript) type checking.
Supported Environments
yolkbot FULLY supports Node, Deno, AND Bun. It is recommended to use Bun for the best performance, but if you need to use Node or Deno, these are supported as well. The previous incompatibility issues with Bun have been resolved as of yolkbot v1.3.0.
yolkbot also can be installed using Bun, npm, or pnpm. Yarn may work, but no support is provided and it is not tested.
yolkbot is limited to Node-like environments that are supported by wwws. You can read more information about what wwws supports here. If wwws does not support your environment, open an issue on the wwws repository. wwws's compatibility does not include browsers, which have entirely different requirements (see browser file for more information).