Skip to content

Configuration ‐ Guide

Jump to bottom
Gundahar Bravin edited this page Feb 17, 2026 · 1 revision

Configuration Guide

After installing L.O.R.E., you need to configure it with your grid's settings. This guide explains every setting in detail.

🎛️ Accessing Settings

  1. Log into WordPress Admin
  2. Go to Settings → L.O.R.E. Map
  3. You'll see the configuration panel with several sections

🌐 Grid Settings

These settings tell L.O.R.E. about your OpenSimulator grid.

Grid Name

What it is: The display name for your grid
Example: Neverworld Grid or My OpenSim Grid
Used for: Map attribution text and branding
Required: No, but recommended

Grid URL

What it is: Your grid's login URI (without http://)
Example: mygrid.com:8002 or grid.example.com:8002
Used for: Building teleport links automatically
Required: Yes, for teleport functionality

⚠️ Important: Don't include http:// or https:// - just the hostname and port!

✅ Correct: neverworldgrid.com:8002
❌ Wrong: http://neverworldgrid.com:8002

Registration URL

What it is: Link to your grid's registration/signup page
Example: https://neverworldgrid.com/register
Used for: The "Join Free Today" button in region popups
Required: No - if left blank, button won't appear

🗄️ OpenSimulator Database

L.O.R.E. connects to your Robust database to sync region data.

Database Host

What it is: IP address or hostname of your MySQL/MariaDB server
Examples:

  • localhost (if database is on same server as WordPress)
  • 142.132.208.50 (remote database server IP)
  • db.mygrid.com (database hostname)

Required: Yes

Database Name

What it is: Name of your Robust database
Default: Usually robust or opensim
Required: Yes

💡 Tip: Check your Robust.ini or Robust.HG.ini file - look for ConnectionString under [DatabaseService]

Database User

What it is: MySQL username with access to the regions table
Recommended: Create a read-only user for security
Required: Yes

Creating a read-only user:

CREATE USER 'lore_readonly'@'%' IDENTIFIED BY 'your_secure_password';
GRANT SELECT ON robust.regions TO 'lore_readonly'@'%';
FLUSH PRIVILEGES;

Database Password

What it is: Password for the database user
Required: Yes
Security: Stored in WordPress database (encrypted at rest if using WordPress security plugins)

🗺️ Map Settings

Control how your map looks and behaves.

Map Tile URL

What it is: URL pattern for your Warp3D map tiles
Default: Auto-generated from Grid URL
Required: No - leave blank to use default

Advanced users: You can customize the tile URL pattern. Use these placeholders:

  • {z} = Zoom level
  • {x} = Tile X coordinate
  • {y} = Tile Y coordinate

Example:

http://mygrid.com:9000/index.php?method=MapItems&zoom={z}&x={x}&y={y}

Default Zoom

What it is: Initial zoom level when map loads
Range: 1-8 (1 = zoomed out, 8 = zoomed in)
Default: 3
Recommended: 3-4 for most grids

Zoom levels explained:

  • 1-2: See entire grid at once (good for huge grids)
  • 3-4: Balanced view (recommended)
  • 5-6: Close-up view
  • 7-8: Very close (individual region detail)

Center X Coordinate

What it is: Map loads centered on this X region coordinate
Default: 1000
Your grid: Set to your Welcome region or grid center

Finding your coordinates:

  • Log into your grid
  • Stand in your Welcome region
  • Type /map in chat (some viewers)
  • Or check Region/Estate → Region tab for coordinates

Center Y Coordinate

What it is: Map loads centered on this Y region coordinate
Default: 1000
Your grid: Set to your Welcome region or grid center

💡 Pro Tip: Set Center X/Y to your Welcome or Landing region so visitors see the most important area first!

🎨 Appearance

Make L.O.R.E. match your grid's branding!

Accent Color

What it is: Main color for UI elements
Default: #2563eb (blue)
Used for:

  • Popup titles
  • Search box border
  • Coordinate text
  • Feature markers

How to choose: Click the color picker and select any color. Changes apply immediately after saving!

Button Color

What it is: Color for the Teleport button gradient
Default: #7c3aed (purple)
Used for: The main Teleport button in region popups

Examples:

  • Grid with blue theme → Use blue accent + darker blue button
  • Grid with red theme → Use red accent + dark red button
  • Grid with green theme → Use green accent + forest green button

⭐ Featured Region (Optional)

Highlight a specific region with a special marker.

Featured Region Name

What it is: Exact name of a region to highlight
Example: Welcome or Main Plaza
Case sensitive: Yes - must match exactly
Leave blank: To disable featured marker

Marker Style

Options:

  • None - No special marker
  • Pulsing Glow - Animated glowing pin (default, very visible)
  • Gold Star - Static star icon
  • Pin Drop - Classic map pin

When to use:

  • Highlight your Welcome/Landing region
  • Draw attention to an event venue
  • Mark your main shopping area

🔄 Region Sync

Keep your map up-to-date with your grid.

Automatic Daily Sync

What it is: L.O.R.E. automatically syncs regions every day at 3:00 AM
Default: Disabled
Recommended: Enable if your grid adds/removes regions regularly

How it works:

  1. Check the box to enable
  2. Save settings
  3. L.O.R.E. schedules a daily WordPress cron job
  4. Every morning at 3:00 AM server time, regions sync automatically
  5. Check logs in WordPress error log to verify

When you see: "⏰ Next automatic sync: [date/time]" - it's working!

💡 Why 3:00 AM? Low traffic time, won't impact visitors. The sync runs in the background with no visible UI.

Manual Sync

Always available! Even with auto-sync enabled, you can click "Sync Regions Now" anytime to force an immediate update.

Use manual sync when:

  • You just added a new region
  • You changed region coordinates
  • You want to test the connection
  • Auto-sync is disabled

💾 Saving Settings

Important: Click "Save Settings" at the bottom of the page after making any changes!

Changes take effect immediately after saving. You don't need to refresh your map page.

✅ Testing Your Configuration

After configuring, test each part:

1. Test Database Connection

Click "Sync Regions Now" - you should see:

  • Progress bar filling up
  • "X of Y regions synced"
  • Green success message

If sync fails: Check Troubleshooting

2. Test the Map

Add [lore_map] to a test page and check:

  • Map tiles load correctly
  • Click a region - popup appears with name
  • Teleport button works (opens your viewer)
  • Search box finds regions

3. Test Colors

The popup title and buttons should match your chosen colors.

🔐 Security Best Practices

  1. Use a read-only database user - L.O.R.E. only needs SELECT permission
  2. Use strong database password - Don't reuse passwords
  3. Limit database access by IP - If possible, restrict to WordPress server IP
  4. Keep WordPress updated - For overall security
  5. Use HTTPS - Secure your WordPress admin area

🎯 Next Steps

Now that L.O.R.E. is configured:

  1. Perform Your First Sync - Import all your regions
  2. Add the Map to a Page - Embed on your site
  3. Customize Further - Advanced tweaks

Having issues? Check Troubleshooting or FAQ.

Clone this wiki locally