Skip to content

A MyBB plugin that can change the language of various sections that require changes to the database, without having to perform an upgrade or reinstallation process.

License

Notifications You must be signed in to change notification settings

ParsanIT/PIT-Change-Forum-Language

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Read me in EN FA

🧩 PIT Change Forum Language plugin for MyBB

A plugin for managing and installing MyBB language packs that allows full and automatic translation of all forum sections without the need for reinstallation or upgrade.

Introduction

In the current MyBB architecture, The text in some sections only applies when performing a installation or upgrade of the forum.

Because of this, parts of MyBB may remain in English even after installing a language pack. (Especially in language packs that did not follow the full and standard approach.)

The PIT Change Forum Language plugin has completely removed this limitation.
With this plugin, all parts of MyBB — even those that were previously only translated during the installation or upgrade process — are fully translated without the need for a reinstallation or upgrade.

The plugin also recommends and installs the appropriate skin if needed to ensure complete harmony between the language and the user interface.

Key Features

  • 🌐 Download and install language packs online
  • 🔄 Full translation coverage for all parts of the forum, without the need for an installation or upgrade process
  • 🧠 Suggest or install a suitable theme with the language pack installed.
  • 🖱 Setup and operation with just click
  • 🤖 No need to upload language pack files or do manual settings

Installation steps

  1. Upload the plugin file to your MyBB root directory.
  2. From the MyBB admin panel, go to the Plugins section and activate the plugin.
  3. Go to the Configuration > Change PIT Community Language.
  4. Select your desired language and complete the installation by clicking.

Advantages

  • Complete and flawless translation of all MyBB components
  • No need to reinstall or upgrade the forum to apply translations
  • Fast, convenient, and uncomplicated management experience
  • Simple and clean user interface.

Add language

This depends on the activity of your community developers, they must prepare and provide us with their language packs according to the principles.
We will include it in the plugin as soon as possible and provide it to you in the form of an update.

How to add by developers and translators:

  1. Prepare the initial language pack by adhering to a principled structure.
  2. Add the required xml files in the specified structure in the path /inc/plugins/pit_changeforumlang_languages
    language_common_name/
        |
        |--- adminviews.xml
        |--- settings.xml
        |--- tasks.xml
        |--- usergroups.xml
    language_common_name.php
  3. Create a GitHub repository for the relevant language pack as Public.
  4. Create a Release for the first time or every update.
    • To identify compatibility before installation, enter Compatibility: xxxx in its description. (Not mandatory)
  5. Submit a request for inclusion in the project by preparing the following JSON and submitting it to the issues section of this project.
{
  "english": {
    "data": {
      "__comment_rtl": "Sets if the language is RTL (Right to Left) (1: yes, 0: no)",
      "__comment_htmllang": "Sets the lang in the <html> on all pages",
      "__comment_charset": "Sets the character set, blank uses the default.",
      "__comment_icon_code": "use https://flagicons.lipis.dev/",
      "__comment_common_name": "equal with folder name",
      "name": "English",
      "rtl": 0,
      "htmllang": "en",
      "charset": "UTF-8",
      "icon_code": "gb",
      "common_name": "english"
    },
    "packages": [
      {
        "__comment_seperator_0": "PIT Change forum languages data(difference with language pack base data)",

        "__comment_is_default": "is default language pack in that exist in mybb package... other language pack can't be default...",
        "__comment_mybb_mod_pid": "can find from url of that like https://community.mybb.com/mods.php?action=view&pid=1675",
        "__comment_mybb_mod_codename": "can find from details of that project(in edit page)",
        "__comment_mybb_userid": "can find from url of user profile like https://community.mybb.com/user-79079.html",
        "is_default": true,
        "mybb_mod_pid": 0,
        "mybb_mod_codename": "english",
        "mybb_userid": 1,
        "mybb_username": "Chris Boulton",

        "__comment_githubrepo": "github repo base link (for browse) like: https://github.com/ParsanIT/MyBB-Persian-Language-Pack",
        "__comment_githubrepo_release_zipball": "github repo suggestion release asset like: https://github.com/ParsanIT/MyBB-Persian-Language-Pack/archive/refs/tags/1839.zip",
        "__comment_githubrepo_release_version": "github repo suggestion release 1.8.39",

        "__comment_includes": {
          "settings_translation": "Inserted setting language strings into standard method(inc/languages/{common_name}/admin/settings.php), true or false",
          "install_upgrade_translation": "Install and upgrade is translated in this languagepack?  true or false",
          "acp_theme": "if package contain acp theme, input name of that(same as that folder) here"
        },
        "includes": {
          "settings_translation": true,
          "install_upgrade_translation": false,
          "acp_theme": ""
        },
        "__comment_recommended": {
          "acp_theme": "if a theme has spcefic option for your language such as RTL, input required data of that here such as below"
        },
        "recommended": {
          "acp_theme": {
            "forcefully": true,
            "name": "default"
          }
        },

        "__comment_seperator_1": "Language pack data",

        "__comment_name": "The friendly name of the language",
        "__comment_author": "The author of the language",
        "__comment_website": "The language authors website",
        "__comment_docs_link": "The documentation site link",
        "__comment_common_issues_link": "The documentation FAQs site link",
        "__comment_support_link": "The support website link",
        "__comment_version": "Compatible version of MyBB",
        "__comment_admin": "Sets if the translation includes the Admin CP (1: yes, 0: no)",

        "name": "English (American)",
        "author": "MyBB",
        "website": "https://mybb.com/",
        "docs_link": "",
        "common_issues_link": "",
        "support_link": "",
        "version": "1839",
        "admin": 1,
        "icon_codus"
      }
    ]
  }
};

List of available language packs

  • English (American) (Default)
  • Persian (پارسی)

About

A MyBB plugin that can change the language of various sections that require changes to the database, without having to perform an upgrade or reinstallation process.

Topics

Resources

License

Stars

Watchers

Forks