Plugin Development

You should be able to overwrite a core module completely using your plugins modules section. For example to overwrite the navigator module with your own you can do. "modules": { "navigator": "public/navigator.js" }, Copy the navigator module from core and make your changes and it will replace the core module during build.

This commit implements that, the teasers are updated in the event event:unread.updateChatCount because that is sent even if the user is not currently in that room. https://github.com/NodeBB/NodeBB/commit/ac644ac2866bfa48a939a94b6ec34ad9fd493f7d

You can also use db.objects.updateMany

You could use the below custom javascript, it will open the last chat if there is no open chat. $(window).on('action:ajaxify.end', async () => { const { data } = ajaxify; if (data.template.chats && !data.template.roomId && data.rooms.length) { const Chats = await app.require('forum/chats'); Chats.switchChat(data.rooms[0].roomId); } });

What is the name of the plugin? Does it start with nodebb-plugin-?

I ended up adding a child span to hold the tooltip, and just removing the child altogether anytime the event fired. Inserting a new element and then setting the tooltip was the only way to get the tooltip updated correctly (for me). Thanks for the help!

A socket event is sent when a new topic or reply is made, they are called event:new_topic and event:new_post. We listen to that and update the ui when a new reply comes in.

@יושב-אוהלים Hi, I would appreciate it if you could write how it can be done

Depending on what you want to change, you can modify it via css or override the bootbox.dialog method like we do in core https://github.com/NodeBB/NodeBB/blob/master/public/vendor/bootbox/wrapper.js#L27-L45

Try navigating to the route created by the plugin for the admin page, it should be something like /admin/plugins/pluginname. If that is giving a 404 that means your plugin isn't being loaded properly on startup. Check nodebb logs for any errors / warnings. The quick start plugin creates a route at /admin/plugins/quickstart https://github.com/NodeBB/nodebb-plugin-quickstart/blob/master/library.js#L37

@baris Just found the root cause of the weird behaviour! Turns out that there is a bug in my NodeBB dev startup scripts. One of the steps involves automatically symlink plugin packages for a more seamless plugin development. The issue happens when the yarn link only happens after NodeBB build but before NodeBB start Thus there is this weird behaviour of the plugin is loaded but its public assets are not built 🫠 Thank you for your pointers and help

After a lot tries here and there I have reached the cause of this issue... I cause is some plugins which are not running properly. It is due to this it hinders the compilation of client side JS for all the plugin which loads after that.

Yeah your flow should work, we don't trigger it on all instances as that would cause issues if the function is doing db writes for example. You would have 2+ instances trying to create the same records etc.

My fault. I wasn't calling ajaxify.go correctly. All works now.

I would advise against using those since they operate on fields that are not indexed. If all you want to store is a uid and score pair you can use sorted sets like below. //setting values await db.sortedSetAdd('pluginname:users:customstats', [score1, score2], [uid1, uid2]); // getting first 10 values await db.getSortedSetRevRange('pluginname:users:customstats', 0, 9);

I don't know why, but taking those conditionals checks that I have to the route controller fixed the problem. I don't need to reload the page anymore.

Hi all, Well this is my first time writing a plugin which involves using client side hooks... For a start, i would want my plugin to listen to a hook which activates when the topic page is completely loaded and topic tools are loaded too. For which I wrote this function: 'use strict'; /* globals document, $ */ $(document).ready(function () { function alertType(type, message) { require(['alerts'], function (alerts) { alerts[type](message); }); } console.log('nodebb-plugin-quickstart: loaded'); $(window).on('action:topic.loaded', notifyBox); function notifyBox() { console.log("in notify box"); alertType('success', "done") } }); but this is not working... I can only see "nodebb-plugin-quickstart: loaded" on the console. Where am i going wrong here??

Hello, first of' thanks for the amazing work ! For the context: I'm a junior developer from France, so excuse my english (and my limited understanding of everything lol). I was looking for a software alternative to build a forum RPG. I just installed NodeBB on Ubuntu 20 (Focal) working on WSL 2. I'm using redis and want to write plugin using typescript. It would be great to have a guide version of the Quickstart plugin in typescript ! I know its possible to write plugin in typescript, the emoji plugin does that. But it would save me so much time to have a guide that explain the extra step we need to do in order of compiler and make it work on NodeBB. Here's my questions tho: Is it in the roadmap team of NodeBB to document how to write plugin in typescript? Did the team plan to write a typescript version of NodeBB? Although it would be great to have some more advanced example right in the documentation on how to do something and what are the step to make it work. Like here : https://community.nodebb.org/topic/16994/how-do-i-add-custom-user-fields-to-my-theme Like "if I want to add/ change something, I have to think of the scope of this features and what's need to be modify in other file to be working properly". Or at least, say it in the documentation a little bit more straightforward. So that beginner will understand that first sight. But I think examples are more worthy than tons of words. Is it possible for beginner to contribute on the documentation to make it more specific and understandable for beginners, or is it a documentation for more experienced developers and a choice of the team (and don't want to change that)? Is it because from a plugin to another, things might be working so differently that it's not worthy to do a more detailed documentation ? Because people might be wanted to write plugin over time, mutualisation of knowledge would be great, so that might simplified the process of each developer trying to write plugin have to go throw investigations to understand how NodeBB works before even start to develop the actual plugin. For example: How to interact with the database explain in this answer: https://community.nodebb.org/topic/17657/best-way-to-store-plugin-data-in-database-in-context-of-compatibility/2?_=1714543873650 for me this should be in the documentation. In conclusion, I feel like in general people agree that it's difficult to start writting plugin without investigate and dive in the structure file of the source code. I'm willing to help on that make it easier to really understand how NodeBB works for developer. So that anyone not familiar with the source code can start almost immediately customization.