matrix-moderation-widget

A widget for moderating with mjolnir. Highly WIP. Use at your own risk!
git clone git://archive.git.mtrnord.blog/MTRNord/matrix-moderation-widget.git
Log | Files | Refs | README | LICENSE

README.md (1450B)

      1 # Matrix Moderation Widget for Mjolnir
      2 
      3 This is an experimental widget to be used in the Mjolnir moderation room.
      4 
      5 Use at your own risk! If you break your bot and it is not an bug your issue will be closed.
      6 Using this currently is extremely dangerous!
      7 
      8 Room: [#mjolnir-widget:nordgedanken.dev](https://matrix.to/#/#mjolnir-widget:nordgedanken.dev)
      9 
     10 ## Screenshots
     11 ![Screenshot](images/screenshot.png)
     12 
     13 ## How to start in dev mode
     14 
     15 1. Follow https://create-react-app.dev/docs/using-https-in-development for your os
     16 2. Run `npm start`
     17 
     18 ## How to build
     19 
     20 Run `npm run build`.
     21 
     22 ## How to add
     23 
     24 Something like this (room_id and https are required)
     25 
     26 `/addwidget https://localhost:3000?room_id=$matrix_room_id`
     27 
     28 ## Hosted instance
     29 
     30 A hosted widget is at https://moderation_widget.nordgedanken.dev/ you can add it via
     31 `/addwidget https://moderation_widget.nordgedanken.dev?room_id=$matrix_room_id`
     32 
     33 ## Adcanced
     34 
     35 ### Use a state event to allow showing relevant Lists only in the dropdown
     36 
     37 TODO:
     38 
     39 1. Allow the bot to send the state event. For this you need to make the bot PL 1
     40 and allow sending `dev.nordgedanken.mjolnir_banlists` for PL1 users.
     41 2. Send the following state event as the bot:
     42 
     43 You can use `/devtools` in element-web to send a custom state event.
     44 
     45 Event Type: `dev.nordgedanken.mjolnir_banlists`
     46 State Key: The user id of the bot
     47 Content: 
     48 
     49 ```
     50 {
     51   "banlists": {
     52     "#matrix-org-coc-bl:matrix.org": "COC"
     53   }
     54 }
     55 ```
     56 
     57 Edit it to fit your banlists.