Breeze/Readme.txt at develop · MissAllSunday/Breeze · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
======================================================================
  BREEZE 2.0.0-beta.1  -  Social Wall Mod for SMF 2.1
  https://missallsunday.com
  License: Mozilla Public License 2.0
======================================================================

Breeze adds a social wall to every member profile on your forum.
Members can post status updates, leave comments, give likes, and
mention each other. Works with any SMF theme, no file edits required.

----------------------------------------------------------------------
  REQUIREMENTS
----------------------------------------------------------------------

  * SMF 2.1.x
  * PHP 8.3 or higher

----------------------------------------------------------------------
  USER FEATURES
----------------------------------------------------------------------

  [ Personal Wall ]

    Every member gets their own wall on their profile page. It is
    opt-in: each user decides whether to activate it. When off, the
    profile falls back to the standard SMF summary page.

  [ Status & Comments ]

    Members post short status updates on any wall. Other members can
    reply with comments. The editor supports BBC.

  [ Action Bar ]

    Every status and comment displays a compact action bar with inline
    buttons for likes, toggling the comment section, and deleting the
    post. Buttons are shown or hidden based on the member's permissions.

  [ Likes ]

    Any status or comment can be liked. Each member can only like a
    given post once. The like count updates in real time.

  [ General Wall ]

    A dedicated "Wall" page in the main navigation aggregates the
    latest posts from all of a member's buddies in one feed.
    Visibility is controlled by a Breeze permission (see below).

  [ About Me tab ]

    Users can write a short bio on their profile using full BBC
    support. The tab is hidden automatically when left empty.

  [ Buddies tab ]

    An optional tab on the profile page that lists all buddies with
    quick add/remove buttons.

  [ Block List ]

    Each user can maintain a private block list. Blocked members
    cannot view the wall owner's profile wall, and the wall owner
    will not see blocked members' walls either (symmetric blocking).

  [ Post Confirmation ]

    Users can opt in to a confirmation dialog that appears before
    every status or comment submission, preventing accidental posts.

  [ Mentions ]

    Type @ in the editor to search for and mention other members.
    A real-time suggestion dropdown appears as you type. Mentioned
    members receive an SMF alert linking directly to the status or
    comment where they were mentioned.

  [ Alerts ]

    Breeze plugs into the standard SMF alert system. Each user can
    tune their preferences independently. Supported alerts:

      - Someone posted a status on my wall
      - Someone commented on a status I made
      - Someone commented on a status posted on my wall
      - Someone liked one of my status or comments
      - Someone mentioned me in a status or comment

----------------------------------------------------------------------
  ADMIN FEATURES
----------------------------------------------------------------------

  [ Flood Control ]

    Limit how many status updates and comments a member can post
    within a rolling time window. Both the message count and the
    window length are configurable. Defaults to 10 messages per
    5 minutes across all walls combined.

  [ Permissions ]

    Breeze registers its own permission group alongside the standard
    SMF permissions. Available permissions:

      - Post new status on any wall
      - Post new comments on any wall
      - Delete own status (anywhere)
      - Delete own comments (anywhere)
      - Delete any status on any wall        (for moderators)
      - Delete any comment on any wall       (for moderators)
      - Delete status posted on their own profile wall
      - Delete comments posted on their own profile wall
      - Access the general wall feed

  [ Maintenance Tools ]

    Built-in tools to detect and repair data inconsistencies:
    orphan comments (whose parent status was deleted), orphan likes
    (pointing to content that no longer exists), and a bulk action
    to enable the personal wall for every member at once.

----------------------------------------------------------------------
  SUPPORT
----------------------------------------------------------------------

  Questions, bug reports, or feedback:
    https://missallsunday.com

  Breeze is open-source (MPL 2.0). Source code:
    https://github.com/MissAllSunday/Breeze

======================================================================