DOCSEARCHbyAlgolia
Submit Docs

Fruchtplaner Documentation

website·Indexed 30 days ago

https://fruchtplaner-docs.pages.dev

Documentation for the Fruchtplaner bot, featuring guides on team appointment management, private reminders, admin modules, and permission configurations. Includes a command overview and instructions for setting up calendars on servers.

Tokens
4.1K
Snippets
21
Records
27
Agent score
75%

What's inside Fruchtplaner

  2. Create and use description templates

    Templates allow you to overwrite appointment descriptions with formatted content and dynamic variables. This is useful for creating consistent announcements that reference other appointments.

    To reference another appointment's data, use the format {variable_terminid} (e.g., {date_268} for the date of appointment ID 268). You can find appointment IDs using /termin -> Liste.

    # Example Template Content:
Hallo! Wir erinnern an das Event {name}. 
Einsendeschluss: {date_55} ({relative_55})

  3. Create a new team appointment

    To create a team appointment via the /termin menu, follow these steps:

    1. Basic Info: Click 'Erstellen' (Create) and provide:
      • Name: Required.
      • Time/Date: Required (leave empty if using an RRULE).
      • Description: Optional.
    2. Visibility & Categorization: In the 'Sichtbarkeit, Kategorie & Pings' embed:
      • Visibility (Required): Choose 'Öffentlich' (Public - visible in calendar/overview) or 'Versteckt' (Hidden - only visible in the internal /termin list).
      • Category (Recommended): Used for color-coding and determining which calendars the appointment appears in.
      • Pings (Optional): Select roles or users to be notified.
    3. Notification Channel: In the 'Ziel-Kanal für Benachrichtigung' embed, select the channel where the start-of-appointment notification should be sent. If left blank, it defaults to the channel where the appointment was created.
    4. Recurrence Options: Choose one of the following:
      • Ohne Wiederholung: No recurrence.
      • Mit Wiederholung: Select a type (daily, weekly, monthly). For custom intervals, enter custom in the type field and specify the interval in the second field.
      • Mit RRULE: Enter a standard RRULE string for advanced recurrence.
      • Abbrechen: Cancel creation.

  4. Configure the Reminder-Thread channel

    Set up a dedicated channel for reminders using /reminder_setup kanal. This sends a setup embed to the channel. When users click 'Wo ist mein Thread?' or run /reminder, a personal thread is created for their reminders.

    Note: Personal threads are visible to the user and server admins. To keep reminders private from admins, users can create reminders via DM by messaging the bot directly.

    # Add reminder setup to a channel
/reminder_setup kanal

# Remove reminder setup from server
/reminder_setup entfernen

  5. Set up or update a server calendar

    Use the /kalender_setup command to configure how calendar photos are displayed on your server. You can have multiple calendar setups per server. When configuring, you must specify: a channel for the calendar photos, the number of weeks/images to show (options 1-4, where 4 shows the current week plus the next 3 weeks), and the appointment categories to be included in this setup and the 'Terminübersicht' button.
    /kalender_setup

  6. Manage reminders using the /reminder command

    Executing the /reminder slash command opens the Reminder Management Menu. This menu allows users to create new reminders, view a list of active reminders, delete all reminders, or test an RRULE to see a preview. When a specific reminder is selected from the list, users can edit its text, timestamp, or custom recurrence rule (RRULE), or delete the reminder entirely.

    Notification Delivery:

    • Execute /reminder via Direct Message (DM) to receive notifications via DM.
    • Execute /reminder within a server thread channel to receive notifications within that thread.

    First-time Setup: Upon first use on a server, the bot automatically creates a dedicated thread channel for the user to manage their reminders.

    /reminder

  7. Configure simple recurrence rules

    After creating a reminder or appointment, use the Mit Wiederholung button in the menu to open a form for simple intervals.
    täglich              - Daily
wöchentlich          - Weekly
monatlich            - Monthly
alle 2 tage          - Custom interval (e.g., every 2 days)
jeden 1. des monats  - Monthly on the 1st

  9. Manage team appointments with the /termin command

    The /termin slash command opens the Appointment Management Menu. This menu allows users to create new appointments, view a list of all active team appointments, and manually refresh the menu.

    When a specific appointment is selected from the list, the following actions are available:

    • Create, list, edit, or delete reminders (before and after the appointment).
    • Reschedule the appointment.
    • Edit the name, description, RRULE recurrence, and visibility.
    • Edit the appointment category.
    • Change the target channel or thread for notifications.
    • Delete the appointment.

    Permissions:

    • To execute /termin: User must be a Staff user or possess a role designated as a Staff role (though some basic execution may not strictly require this depending on the bot's permission hierarchy).
    • To modify/delete appointments or change notifications: User must be the creator of the appointment, a Bot-Admin, or a Server Administrator.
    /termin

  10. Report a bug or error for Fruchtplaner

    To report a bug or error, contact the developer via direct message or notify the server team. When reporting, provide a detailed description of the error, including screenshots and the specific steps taken to reproduce the issue.

    Developer contact: @Max (Discord ID: max1385)

  11. Configure the appointment log channel

    Set up a channel to log all appointments sent by the bot. The bot will post and pin the current month and year at the start of each new month as a separator. Only one log channel is allowed per server.
    # Setup or update the log channel
/log_channel setup

# Remove the log channel
/log_channel entfernen

  12. Create a new private reminder

    To create a new reminder, follow these steps:

    1. Run the /reminder command and click the "Erstellen" (Create) button.
    2. Enter the Title and the Timestamp (when the reminder should trigger). If you intend to use a complex RRULE, leave the timestamp field empty to be prompted for the RRULE in the next step.
    3. Configure the recurrence by selecting one of the following options:
      • Ohne Wiederholung (No Repeat): The reminder triggers once and is then finished.
      • Mit Wiederholung (Simple Repeat): Enter the repetition type (daily, weekly, monthly). To use a custom interval, enter custom in the repetition type field and specify the interval in the second field.
      • Mit RRULE (Advanced Repeat): Enter a standard RRULE string for complex recurrence patterns.
      • Abbrechen (Cancel): Stop the creation process.
    /reminder