https://github.com/lucasb25/panais-language

https://github.com/lucasb25/panais-language

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/lucasb25/panais-language
• Owner: LucasB25
• Created: 2024-08-15T13:33:41.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-09-07T23:38:40.000Z (2 months ago)
• Last Synced: 2024-09-08T00:31:42.718Z (2 months ago)
• Size: 46.9 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🌍 Multilanguage Support for Panais 🎶

### 📚 Available Translations

- [x] English (US) - `EnglishUS.json` (Default)

- [x] French - `French.json` [by @LucasB25](https://github.com/LucasB25)

- [ ] Hindi - `Hindi.json` (Not Started)

- [ ] Spanish (ES) - `SpanishES.json` (Not Started)

- [ ] Portuguese (PT) - `PortuguesePT.json` (Not Started)

- [ ] Polish - `Polish.json` (Not Started)

- [ ] German - `German.json` (Not Started)

- [ ] Russian - `Russian.json` (Not Started)

- [ ] Korean - `Korean.json` (Not Started)

- [ ] Indonesian - `Indonesian.json` (Not Started)

- [ ] English (GB) - `EnglishGB.json` (Not Started)

- [ ] Bulgarian - `Bulgarian.json` (Not Started)

- [ ] Chinese (CN) - `ChineseCN.json` (Not Started)

- [ ] Chinese (TW) - `ChineseTW.json` (Not Started)

- [ ] Croatian - `Croatian.json` (Not Started)

- [ ] Czech - `Czech.json` (Not Started)

- [ ] Danish - `Danish.json` (Not Started)

- [ ] Dutch - `Dutch.json` (Not Started)

- [ ] Finnish - `Finnish.json` (Not Started)

- [ ] Greek - `Greek.json` (Not Started)

- [ ] Hungarian - `Hungarian.json` (Not Started)

- [ ] Italian - `Italian.json` (Not Started)

- [ ] Japanese - `Japanese.json` (Not Started)

- [ ] Lithuanian - `Lithuanian.json` (Not Started)

- [ ] Norwegian - `Norwegian.json` (Not Started)

- [ ] Portuguese (BR) - `PortugueseBR.json` (Not Started)

- [ ] Romanian - `Romanian.json` (Not Started)

- [ ] Swedish - `Swedish.json` (Not Started)

- [ ] Thai - `Thai.json` (Not Started)

- [ ] Turkish - `Turkish.json` (Not Started)

- [ ] Ukrainian - `Ukrainian.json` (Not Started)

- [ ] Vietnamese - `Vietnamese.json` (Not Started)

## 📚 How to Use the Translations

2. 📋 Copy the contents of the `EnglishUS.json` file into the new file.

3. 🌐 Translate the strings in the new file to the desired language.

## Have a language to contribute? 🎉

- Fork the repository.

- Add the translation file in the `locales` directory.

- Create a pull request with the changes.

## 📝 Translation Guidelines

- **Do not** change the key names in the translation JSON file.

- **Do not** change the structure of the translation JSON file.

- **Do not** remove the `{}` tags from the strings.

- **Do not** add any new keys to the translation JSON file.

- **Do not** add any new directories to the repository.

### Example Translation JSON

**EnglishUS:**

```json

{

	"cmd": {

		"ping": {

			"description": "Displays the bot's ping.",

			"content": "`🏓` | Pinging...",

			"bot_latency": "Bot Latency:",

			"api_latency": "API Latency:",

			"requested_by": "Requested by: {author}"

		}

	}

}

```

**French:**

```json

{

	"cmd": {

		"ping": {

			"description": "Affiche le ping du bot.",

			"content": "`🏓` | En train de pinger...",

			"bot_latency": "Latence du Bot :",

			"api_latency": "Latence de l'API :",

			"requested_by": "Demandé par : {author}"

		},

	}

}

```

### Formatting Tags for i18n NPM

To ensure `{}` are not removed during translations, use the format tags: `["{", "}"]`.

## 📚 Resources

- [i18n NPM](https://www.npmjs.com/package/i18n)

- [Discord Developer Portal - Locales](https://discord.com/developers/docs/reference#locales)