90 lines
3.5 KiB
Markdown
90 lines
3.5 KiB
Markdown
# Event Configuration
|
|
|
|
This page explains all configuration options for the event system in codem-phone.
|
|
|
|
---
|
|
|
|
## Overview
|
|
|
|
The event system allows players to create, manage, and participate in community events. Features include event reminders, automatic status updates, and participant management.
|
|
|
|
---
|
|
|
|
## Configuration
|
|
|
|
```lua
|
|
return {
|
|
OnlyAdminCreateEvent = false,
|
|
AutoDeletePastEventsMinutes = 15,
|
|
AutoDeleteCheckIntervalMinutes = 5,
|
|
EnableReminders = true,
|
|
ReminderMinutesBefore = 5,
|
|
NotifyOnEventStart = true,
|
|
ReminderCheckIntervalMinutes = 1,
|
|
StatusUpdateIntervalMinutes = 1,
|
|
EnableBlackWord = true
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## Settings
|
|
|
|
### Event Creation
|
|
|
|
| Option | Type | Default | Description |
|
|
| ---------------------- | ------- | ------- | -------------------------------------- |
|
|
| `OnlyAdminCreateEvent` | boolean | `false` | If true, only admins can create events |
|
|
|
|
### Auto Delete
|
|
|
|
| Option | Type | Default | Description |
|
|
| -------------------------------- | ------ | ------- | -------------------------------------- |
|
|
| `AutoDeletePastEventsMinutes` | number | `15` | Delete events X minutes after they end |
|
|
| `AutoDeleteCheckIntervalMinutes` | number | `5` | Check for deletion every X minutes |
|
|
|
|
### Reminders
|
|
|
|
| Option | Type | Default | Description |
|
|
| ------------------------------ | ------- | ------- | ------------------------------------ |
|
|
| `EnableReminders` | boolean | `true` | Enable event reminder notifications |
|
|
| `ReminderMinutesBefore` | number | `5` | Send reminder X minutes before event |
|
|
| `NotifyOnEventStart` | boolean | `true` | Send notification when event starts |
|
|
| `ReminderCheckIntervalMinutes` | number | `1` | Check for reminders every X minutes |
|
|
|
|
### Status Updates
|
|
|
|
| Option | Type | Default | Description |
|
|
| ----------------------------- | ------ | ------- | ----------------------------------- |
|
|
| `StatusUpdateIntervalMinutes` | number | `1` | Update event status every X minutes |
|
|
|
|
### Content Moderation
|
|
|
|
| Option | Type | Default | Description |
|
|
| ----------------- | ------- | ------- | --------------------------------------------------- |
|
|
| `EnableBlackWord` | boolean | `true` | Filter inappropriate content in titles/descriptions |
|
|
|
|
---
|
|
|
|
## Event Statuses
|
|
|
|
Events have the following status lifecycle:
|
|
|
|
| Status | Description |
|
|
| ---------- | -------------------------------------------------- |
|
|
| `upcoming` | Event is scheduled for the future |
|
|
| `active` | Event has started (event_date has passed) |
|
|
| `deleted` | Event is removed after AutoDeletePastEventsMinutes |
|
|
|
|
## Notifications
|
|
|
|
The event system sends the following notifications:
|
|
|
|
| Notification | When |
|
|
| ------------------ | ------------------------------------- |
|
|
| Event Reminder | X minutes before event (configurable) |
|
|
| Event Starting Now | When event time is reached |
|
|
| Event Updated | When event details are changed |
|
|
| Event Cancelled | When event is deleted |
|
|
| New Participant | When someone joins your event |
|