OUGC Thread Contributors

Displays a list of users who contributed to a discussion.

📜 Table of Contents

• About
• Getting Started
  • Dependencies
  • File Structure
  • Install
  • Update
  • Template Modifications
• Settings
• Templates
• Usage
• Built Using
• Authors
• Acknowledgments
• Support & Feedback

🚀 About

OUGC Thread Contributors is a MyBB plugin designed to enhance user engagement and provide a comprehensive overview of thread participants. With this simple plugin, users can easily access a list of contributors who have posted or commented within a thread. The list ensures an accurate representation of participant involvement, fostering greater interaction and community engagement.

Go up to Table of Contents

📍 Getting Started

The following information will assist you into getting a copy of this plugin up and running on your forum.

Dependencies

A setup that meets the following requirements is necessary to use this plugin.

• MyBB >= 1.8.30
• PHP >= 7.4
• MyBB-PluginLibrary >= 13

File structure

   .
   ├── inc
   │ ├── plugins
   │ │ ├── ougc
   │ │ │ ├── ThreadContributors
   │ │ │ │ ├── templates
   │ │ │ │ │ ├── .html
   │ │ │ │ │ ├── user.html
   │ │ │ │ │ ├── user_avatar.html
   │ │ │ │ │ ├── user_plain.html
   │ │ │ │ │ ├── user_postcount.html
   │ │ │ │ ├── settings.json
   │ │ ├── ougc_threadcontributors.php.php
   │ ├── languages
   │ │ ├── espanol
   │ │ │ ├── admin
   │ │ │ │ ├── ougc_threadcontributors.lang.php
   │ │ │ ├── ougc_threadcontributors.lang.php
   │ │ ├── english
   │ │ │ ├── admin
   │ │ │ │ ├── ougc_threadcontributors.lang.php
   │ │ │ ├── ougc_threadcontributors.lang.php

Installing

Follow the next steps in order to install a copy of this plugin on your forum.

1. Download the latest package from the MyBB Extend site or from the repository releases.
2. Upload the contents of the Upload folder to your MyBB root directory.
3. Browse to Configuration » Plugins and install this plugin by clicking Install & Activate.

Updating

Follow the next steps in order to update your copy of this plugin.

1. Browse to Configuration » Plugins and deactivate this plugin by clicking Deactivate.
2. Follow step 1 and 2 from the Install section.
3. Browse to Configuration » Plugins and activate this plugin by clicking Activate.

Template Modifications

To display the list of contributors it is required that you edit the showthread template for each of your themes.

1. Open the showthread template for editing.
2. Find {$usersbrowsing}.
3. Add {$ougc_threadcontributors_list} right after.
4. Save the template.

Go up to Table of Contents

🛠 Settings

Below you can find a description of the plugin settings.

Global Settings

• Show Avatars yesNo Default: no
  • If disabled, a list of usernames will be displayed.
• Show Avatars to Guests yesNo Default: no
  • If disabled, a list of usernames will be displayed to guests.
• Display Post Count yesNo Default: no
  • If enabled, the total amount of (visible) posts will be displayed for each user.
• Order By radio Default: username
  • Order criteria to use: ordering by username could be faster.
• Order On Ascending Order yesNo Default: no
  • If enabled, the order of users will be reversed.
• Ignore Authors yesNo Default: no
  • If enabled, the thread author will not be displayed in the contributors list.
• Avatar Maximum Dimensions numeric Default: 30
  • Set the maximum avatar width and height size.
• Allow Post Filtering (Experimental) yesNo Default: no
  • If enabled, user list will link to the same thread filtered to display the user's posts. If disabled, the filtering wil not be accessible.

Go up to Table of Contents

📐 Templates

The following is a list of templates available for this plugin. Uncommon in plugins, we use some templates exclusively for the Administrator Control Panel.

• ougcthreadcontributors
  • front end; used to wrap the user list
• ougcthreadcontributors_user
  • front end; used once for each user
• ougcthreadcontributors_user_avatar
  • front end; used when avatars are displayed
• ougcthreadcontributors_user_plain
  • front end; used when avatars are disabled
• ougcthreadcontributors_user_postcount
  • front end; used when displaying the post count

Go up to Table of Contents

📖 Usage

This plugin has no additional configurations; after activating make sure to modify the global settings in order to get this plugin working.

Go up to Table of Contents

⛏ Built Using

• MyBB - Web Framework
• MyBB PluginLibrary - A collection of useful functions for MyBB
• PHP - Server Environment

Go up to Table of Contents

✍️ Authors

• @Omar G - Idea & Initial work

See also the list of contributors who participated in this project.

Go up to Table of Contents

🎉 Acknowledgements

• The Documentation Compendium

Go up to Table of Contents

🎈 Support & Feedback

This is free development and any contribution is welcome. Get support or leave feedback at the official MyBB Community.

Thanks for downloading and using our plugins!

Go up to Table of Contents