Software /
code /
prosody-modules
Annotate
mod_muc_moderation/README.md @ 6112:4c0e3fe57e92
mod_compliance_latest: Gracefull error logging on missing dependency.
diff --git a/mod_compliance_latest/README.md b/mod_compliance_latest/README.md
--- a/mod_compliance_latest/README.md
+++ b/mod_compliance_latest/README.md
@@ -9,13 +9,15 @@ rockspec:
# Introduction
-This module will always require and load to the lastest compliance tester we have in the community modules.
-Currently this is [mod_compliance_2023].
+This meta-module will always `require` (and therefore auto-load) the lastest compliance tester we have in the community modules.
+Currently this is [mod_compliance_2023]. See the linked module for further details.
+
+If you do not use the *Prosody plugin installer* this module will likely have limited value to you.
+You can also just install the current compliance tester manually.
# Configuration
-Just load this module as any other module and it will automatically install [mod_compliance_2023] if you use the Prosody plugin installer.
-See the linked module for further details.
+Just load this module as any other module and it will automatically install and load [mod_compliance_2023] if you use the *Prosody plugin installer*.
# Compatibility
diff --git a/mod_compliance_latest/mod_compliance_latest.lua b/mod_compliance_latest/mod_compliance_latest.lua
--- a/mod_compliance_latest/mod_compliance_latest.lua
+++ b/mod_compliance_latest/mod_compliance_latest.lua
@@ -1,1 +1,6 @@
-module:depends("compliance_2023");
+local success, err = pcall(function() module:depends("compliance_2023") end)
+
+if not success then
+ module:log("error", "Error, can't load module: mod_compliance_2023. Is this module downloaded in a folder readable by prosody?")
+ return 1, "Error: Couldn't load dependency mod_compliance_2023."
+end
author | Menel <menel@snikket.de> |
---|---|
date | Mon, 23 Dec 2024 12:58:03 +0100 |
parent | 6013:31ea29adb894 |
child | 6156:bcad6baa4fc3 |
rev | line source |
---|---|
5484
bb083e9f78dd
mod_muc_moderation: Point to new Conversations issue tracker
Kim Alvefur <zash@zash.se>
parents:
5127
diff
changeset
|
1 --- |
6013
31ea29adb894
mod_muc_moderation: update Readme Compability
Menel <menel@snikket.de>
parents:
6003
diff
changeset
|
2 labels: |
31ea29adb894
mod_muc_moderation: update Readme Compability
Menel <menel@snikket.de>
parents:
6003
diff
changeset
|
3 - Stage-Beta |
5484
bb083e9f78dd
mod_muc_moderation: Point to new Conversations issue tracker
Kim Alvefur <zash@zash.se>
parents:
5127
diff
changeset
|
4 summary: Let moderators remove spam and abuse messages |
bb083e9f78dd
mod_muc_moderation: Point to new Conversations issue tracker
Kim Alvefur <zash@zash.se>
parents:
5127
diff
changeset
|
5 --- |
bb083e9f78dd
mod_muc_moderation: Point to new Conversations issue tracker
Kim Alvefur <zash@zash.se>
parents:
5127
diff
changeset
|
6 |
3897
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
7 # Introduction |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
8 |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
9 This module implements [XEP-0425: Message Moderation]. |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
10 |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
11 # Usage |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
12 |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
13 Moderation is done via a supporting client and requires a `moderator` |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
14 role in the channel / group chat. |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
15 |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
16 # Configuration |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
17 |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
18 Example [MUC component][doc:chatrooms] configuration: |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
19 |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
20 ``` {.lua} |
5872
593312fedfe1
mod_muc_moderation: Fix example
Kim Alvefur <zash@zash.se>
parents:
5670
diff
changeset
|
21 Component "channels.example.com" "muc" |
3897
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
22 modules_enabled = { |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
23 "muc_mam", |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
24 "muc_moderation", |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
25 } |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
26 ``` |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
27 |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
28 # Compatibility |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
29 |
6013
31ea29adb894
mod_muc_moderation: update Readme Compability
Menel <menel@snikket.de>
parents:
6003
diff
changeset
|
30 ------- --------------- |
31ea29adb894
mod_muc_moderation: update Readme Compability
Menel <menel@snikket.de>
parents:
6003
diff
changeset
|
31 trunk Works^[as of 2024-10-22] |
31ea29adb894
mod_muc_moderation: update Readme Compability
Menel <menel@snikket.de>
parents:
6003
diff
changeset
|
32 0.12 Works |
31ea29adb894
mod_muc_moderation: update Readme Compability
Menel <menel@snikket.de>
parents:
6003
diff
changeset
|
33 ------- --------------- |
3897
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
34 |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
35 ## Clients |
3a96070f4a14
mod_muc_moderation: Initial commit of XEP-0425: Message Moderation
Kim Alvefur <zash@zash.se>
parents:
diff
changeset
|
36 |
4900
cc5ac0f0f32d
mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents:
4753
diff
changeset
|
37 - [Converse.js](https://conversejs.org/) |
cc5ac0f0f32d
mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents:
4753
diff
changeset
|
38 - [Gajim](https://dev.gajim.org/gajim/gajim/-/issues/10107) |
cc5ac0f0f32d
mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents:
4753
diff
changeset
|
39 - [clix](https://code.zash.se/clix/rev/6c1953fbe0fa) |
6013
31ea29adb894
mod_muc_moderation: update Readme Compability
Menel <menel@snikket.de>
parents:
6003
diff
changeset
|
40 - [Cheogram](https://cheogram.com/) |
4752
67848bf6b425
mod_muc_moderation: Add list of client feature requests for XEP-0425
Kim Alvefur <zash@zash.se>
parents:
3897
diff
changeset
|
41 |
67848bf6b425
mod_muc_moderation: Add list of client feature requests for XEP-0425
Kim Alvefur <zash@zash.se>
parents:
3897
diff
changeset
|
42 ### Feature requests |
67848bf6b425
mod_muc_moderation: Add list of client feature requests for XEP-0425
Kim Alvefur <zash@zash.se>
parents:
3897
diff
changeset
|
43 |
5484
bb083e9f78dd
mod_muc_moderation: Point to new Conversations issue tracker
Kim Alvefur <zash@zash.se>
parents:
5127
diff
changeset
|
44 - [Conversations](https://codeberg.org/iNPUTmice/Conversations/issues/20) |
4900
cc5ac0f0f32d
mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents:
4753
diff
changeset
|
45 - [Dino](https://github.com/dino/dino/issues/1133) |
cc5ac0f0f32d
mod_muc_moderation: Update Clients section (+ Gajim, clix)
Kim Alvefur <zash@zash.se>
parents:
4753
diff
changeset
|
46 - [Profanity](https://github.com/profanity-im/profanity/issues/1336) |