Description

An implementation of i18next's filesystem backend for Sapphire. It allows you to use a JSON-based languages directory to add internationalization for your bot using SapphireClient's fetchLanguage hook and a custom message extension, adding features such as sendTranslated and resolveKey.

Features

• Fully ready for TypeScript!
• Includes ESM ready entrypoint
• Framework agnostic
• Includes convenience register for discord.js

Installation

@sapphire/plugin-i18next depends on the following packages. Be sure to install these along with this package!

• @sapphire/framework
• @sapphire/pieces v1.x
• discord.js

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install @sapphire/plugin-i18next @sapphire/framework @sapphire/pieces@1 discord.js

Usage

import '@sapphire/plugin-i18next/register';

And for discord.js:

import '@sapphire/plugin-i18next/register-discordjs';

It is to be noted that unless you are using discord.js, which has the convenience register to extend the client, guild, channel and message methods for you, you will have to implement your own extensions.

This is currently undocumented and not covered by guides, but will be in the future. For now, you may follow the structure of register-discordjs.ts if this is the case for you.

Sapphire i18next Documentation

For the full @sapphire/plugin-i18next documentation please refer to the TypeDoc generated documentation.

Buy us some doughnuts

Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Jeroen Claassens 💻 🚇 📆	Nejc Drobnic 💻 📖	Antonio Román 💻	Vlad Frangu 👀	depfu[bot] 🚧	dependabot[bot] 🚧	allcontributors[bot] 📖
Tyler J Russell 💻	Stitch07 💻 🐛	PlatinBae 📖

This project follows the all-contributors specification. Contributions of any kind welcome!