Skip to main content

Admin Settings

Overview​

Larpinq provides a dedicated admin settings page in the Nextcloud administration panel. Administrators can configure data source settings for each of the 9 entity types (ability, character, condition, effect, event, item, player, setting, skill), choosing between internal Nextcloud database storage or OpenRegister.

How to Use​

  1. Log in as a Nextcloud administrator
  2. Navigate to Settings → Administration → Larpinq
  3. For each entity type, select the data source:
    • Internal — uses Nextcloud's built-in database (Entity/Mapper pattern)
    • Open Register — uses OpenRegister for JSON object storage with schema validation
  4. When selecting OpenRegister, choose the register and schema from the cascading dropdowns
  5. Click Save All to persist changes

Screenshots​

Admin Settings Page

The Larpinq admin settings page in the Nextcloud administration panel.

Configuration​

Settings are stored via Nextcloud's IAppConfig under the larpinq app ID. Config keys:

KeyDescription
registerThe OpenRegister register ID
character_schemaSchema ID for characters
player_schemaSchema ID for players
ability_schemaSchema ID for abilities
skill_schemaSchema ID for skills
item_schemaSchema ID for items
condition_schemaSchema ID for conditions
effect_schemaSchema ID for effects
event_schemaSchema ID for events
setting_schemaSchema ID for game settings

API Endpoints​

MethodEndpointDescription
GET/apps/larpinq/api/settingsGet current settings
POST/apps/larpinq/api/settingsUpdate settings

Technical Details​

  • lib/Settings/LarpinqAdmin.php — implements ISettings (renders the settings form)
  • lib/Sections/LarpinqAdmin.php — implements IIconSection (sidebar section entry)
  • lib/Controller/SettingsController.php — REST API for settings CRUD
  • lib/Service/SettingsService.php — business logic for config key management
  • lib/Service/SettingsLoadService.php — JSON-based config import from larpinq_register.json