search

WildPHP / module-moderation

Moderation commands module for WildPHP
MIT License
0 stars 0 forks source link

Wrong installation instructions #2

Open ivptr opened 3 years ago

ivptr commented 3 years ago

https://github.com/WildPHP/module-moderation/blob/master/README.md shows wrong installation instructions:

composer require wildphp/module-moderation

displays

[InvalidArgumentException]
Could not find a version of package wildphp/module-moderation matching your minimum-stability (stable). Require it with an explicit version constraint allowing its desired stability.

Also config.neon mentioned does not exist.

irc-bot has config.php with line 'modules' => [], I suppose we should add it there?

Other modules' README.md at https://github.com/WildPHP have the same instructions.

NanoSector commented 3 years ago

I'm aware of this; these modules are built with the old bot framework, it used a config file in the Neon syntax. Unfortunately I haven't had enough time to port these modules over to the new framework.

A notice in the documentation does seem appropriate though.

ivptr commented 3 years ago

So all modules actually won't work anyway?

NanoSector commented 3 years ago

Unfortunately yes. The ground work for them is mostly complete and the bot internally actually uses the module system, however the main point of concern is the command system.

Technically commands should work and the foundation for that (https://github.com/wildphp/command-parser) and the registration components in the main bot already exist and function. However there currently is no system in place for authenticating users or managing registration in the bot, so any commands made can be executed by anyone.

The old framework had this support but it was very rudimentary and buggy, hence the major refactoring work that has gone into the bot. I work on this in my spare time as a hobby which is why activity is quite sporadic. Moreover I don't want to rush things along just to deliver a "stable" version, to avoid needing another refactor later down the road to fix any mess that this would cause.

Having said all this, I greatly appreciate your reports as these do allow me to target and think about things that are important to end users like you. This effectively allows me to build a roadmap of things to test and target. And with that I am sorry for the rough state the bot is currently in, I hope you understand.