Documentation

Requirements

• Moodle 4.x (4.1, 4.2, 4.3, 4.4, or 4.5)
• PHP 8.0+ (tested on 8.0, 8.1, 8.2, 8.3)
• cURL extension (for AI provider API calls)
• JSON extension (standard in PHP 8.x)
• An AI provider API key (OpenAI, DeepSeek, Gemini, Claude, or any OpenAI-compatible endpoint)

Installation

Step 1: Download

After purchasing, download the plugin ZIP from your dashboard. The file is named campus-assistant-v2.2.1.zip (~114KB).

Step 2: Upload to Moodle

Go to your Moodle admin panel:

• Site administration → Plugins → Install plugins
• Upload the ZIP file
• Select plugin type: Local plugin
• Install

Step 3: Configure

After installation, go to:

• Site administration → Local plugins → Campus Assistant
• Enter your license key (from your dashboard)
• Select your AI provider
• Enter your API key
• Customize: name, color, logo, language, welcome message
• Save changes

Step 4: Verify

Visit any course page while logged in as a student, teacher, or admin. The assistant button should appear in the bottom-right corner.

Configuration Options

AI Provider

Choose from the built-in providers or use the free tier:

• Free (Managed): 50 messages/month per campus, no API key needed
• OpenAI: GPT-4o, GPT-4o-mini — enter your API key
• DeepSeek: Most affordable — enter your API key
• Google Gemini: Flash, Pro — enter your API key
• Anthropic Claude: Haiku, Sonnet — enter your API key
• Custom: Any OpenAI-compatible endpoint (Ollama, LM Studio, vLLM, etc.)

Branding

• Assistant name: Displayed in the chat header
• Button icon: Upload your logo (PNG, SVG)
• Primary color: Hex color for the button and header
• Welcome message: Shown when chat opens
• Default language: ES, EN, FR, DE, IT, or PT

Security

• Rate limit: Max messages per user per hour (default: 20)
• Conversation retention: Days to keep logs (default: 30, auto-purge via cron)

Function Reference

Student Functions (20)

Course list, pending tasks, upcoming deadlines, exam dates, grades, course progress, unread forums, tutor info, course content, announcements, course calendar, feedback results, course resources, next activity, study time, coursemates, late submissions, search content, submission status, overview.

Teacher Functions (12)

Teaching courses, needs grading, class progress, at-risk students, ungraded work, student list, completion overview, forum questions, gradebook summary, overdue assignments, class engagement, upcoming events.

Admin Functions (16)

Campus statistics, course enrolments, grade statistics, inactive users, pending submissions, recent activity, course list, completion rates, user growth, storage usage, login statistics, course categories, plugin overview, teachers without courses, empty courses, system health.

Troubleshooting

The assistant button doesn't appear

• Check that your license key is valid in settings
• Clear Moodle cache: Site administration → Development → Purge all caches
• Run cron: php admin/cli/cron.php
• Check that your theme renders the before_standard_html_head hook

The assistant responds with errors

• Verify your AI provider API key is correct
• Check app/ directory permissions
• Review Moodle error logs: php admin/cli/psr2logger.php

Theme compatibility

Campus Assistant uses Moodle's additionalhtmlhead for reliable injection across all themes, including commercial themes like Edumy that override standard hooks. If the button doesn't show, check that your theme's additionalhtmlhead setting is not disabled.

Need Help?

Email us at hola@campusassistant.app. Your license includes email support from the developers who built the plugin.