Skip to content
Gundahar Bravin edited this page Feb 17, 2026 · 1 revision

Frequently Asked Questions (FAQ)

Quick answers to common questions about L.O.R.E.


πŸ“¦ Installation & Requirements

What version of WordPress do I need?

WordPress 5.5 or higher. Most hosts run a recent version by default.

What version of PHP do I need?

PHP 7.4 or higher. Check your hosting control panel or ask your host.

Does L.O.R.E. work with any OpenSimulator version?

Yes! L.O.R.E. works with any OpenSim version that has a Robust database with a regions table. This includes OpenSim 0.9.x and later.

Do I need Warp3D map tiles?

Yes, your grid needs Warp3D enabled for map tiles to appear. Most modern grids have this enabled by default. Check your OpenSim.ini for [Warp3DImageModule].

Can I use L.O.R.E. on a standalone OpenSim setup?

Yes, but you'll need to configure L.O.R.E. to connect to your standalone database instead of a Robust database. The table structure is the same.


πŸ—„οΈ Database & Security

Does L.O.R.E. modify my OpenSim database?

No! L.O.R.E. only reads from your OpenSim database. It never writes, updates, or deletes anything. All region data is copied to a separate WordPress table (wp_lore_regions).

What database permissions does L.O.R.E. need?

Only SELECT permission on the regions table. We strongly recommend creating a read-only database user for L.O.R.E.

Is it safe to give L.O.R.E. my database password?

If you create a read-only user (recommended), yes. That user can only view data, not modify it. Never give L.O.R.E. a user with UPDATE, DELETE, or DROP permissions.

Where are my database credentials stored?

In your WordPress database, in the wp_options table. They're as secure as your WordPress installation.

Can L.O.R.E. access multiple OpenSim databases?

Not yet, but v1.1.0 will support multiple databases for large grids that shard their regions across multiple database servers. Coming soon!


πŸ—ΊοΈ Map Features

Can I customize the map colors?

Yes! Go to Settings β†’ L.O.R.E. Map β†’ Appearance section. Use the color pickers to set your accent and button colors.

Can I have multiple maps on one page?

Yes! Use multiple [lore_map] shortcodes with different parameters. Each creates an independent map instance.

Can I display only certain regions?

Not currently. L.O.R.E. shows all regions from your database. If you need this feature, request it in GitHub Discussions.

How do I change the default zoom level?

Go to Settings β†’ L.O.R.E. Map β†’ Default Zoom (1-8). Or use the shortcode parameter: [lore_map zoom="5"]

Can visitors zoom and pan the map?

Yes! The map is fully interactive. Visitors can zoom with the +/- buttons or mouse wheel, and pan by clicking and dragging.


πŸ”„ Syncing

How often should I sync regions?

  • Active grids (adding/removing regions often): Enable auto-sync for daily updates
  • Stable grids (few changes): Manual sync when needed
  • Testing/development grids: Sync after each change

Does syncing affect my grid's performance?

No. L.O.R.E. only reads from your database, and batch sync processes just 50 regions at a time. Your grid won't notice any performance impact.

What happens if I delete regions from my grid?

They'll disappear from the map after the next sync. L.O.R.E. clears the WordPress table and re-imports fresh data on each sync.

Can I schedule syncs at a different time?

Currently syncs run at 3:00 AM. Custom scheduling will be added in a future update. Track this in GitHub Issues.

How long does a sync take?

For most grids:

  • 100 regions: ~4 seconds
  • 500 regions: ~20 seconds
  • 1000 regions: ~40 seconds

Time varies based on database server speed and network latency.


πŸš€ Teleport

Why doesn't the teleport button work?

Make sure:

  1. Your Grid URL is set correctly in settings (without http://)
  2. Your viewer is configured to handle hop:// protocol links
  3. Your browser allows protocol handlers

See Troubleshooting for detailed solutions.

Can I change the teleport landing position?

Currently all teleports land at 128, 128, 25 (center of region). Custom landing points may be added in a future version.

Do teleport links work on mobile?

Only if you have a mobile OpenSim viewer installed that handles hop:// links. Most mobile browsers won't support this.


🎨 Customization

Can I change the popup design?

The popup design is set by L.O.R.E.'s CSS, but you can override it with custom CSS in your WordPress theme. Advanced users can edit lore.css directly (not recommended - changes will be lost on updates).

Can I add my own logo to the map?

Not built-in, but you can add an image above/below the map using standard WordPress blocks or HTML.

Can I translate L.O.R.E. to another language?

L.O.R.E. is translation-ready but doesn't include translations yet. If you'd like to contribute a translation, see Contributing.

Can I use a custom icon for the featured region marker?

Currently you can choose from 4 built-in styles (none, pulse, star, pin). Custom icon support may be added in the future.


πŸ“Š Performance

Does L.O.R.E. slow down my WordPress site?

No. L.O.R.E. only loads JavaScript on pages that contain the [lore_map] shortcode. Other pages are unaffected.

How much database space does L.O.R.E. use?

Minimal. Each region takes about 200 bytes. A 500-region grid uses roughly 100 KB of database space.

Does L.O.R.E. work with caching plugins?

Yes, but you may need to clear cache after changing settings or syncing regions. See Troubleshooting - Plugin Conflicts.


πŸ†š Comparisons

How is L.O.R.E. different from osquickmap?

L.O.R.E. advantages:

  • Modern Leaflet.js engine (vs old table-based layout)
  • Live region search
  • Color customization
  • Batch sync with progress bar
  • Auto-sync scheduling
  • Active development

Can I migrate from osquickmap to L.O.R.E.?

Yes! Just install L.O.R.E., sync your regions, and replace the old shortcode with [lore_map]. You can keep both plugins active during testing if needed.

Does L.O.R.E. work with w4os (WordPress for OpenSim)?

L.O.R.E. is a standalone plugin and doesn't require w4os, but they work fine together if you use both.


πŸ”§ Technical

What happens if my database credentials change?

Update them in Settings β†’ L.O.R.E. Map. Auto-sync will resume working once credentials are correct again.

Can I use L.O.R.E. with a remote database?

Yes! Just make sure:

  1. MySQL port 3306 is open on your database server
  2. Database allows remote connections (check bind-address in MySQL config)
  3. You've granted access to the remote user

Does L.O.R.E. use any external services?

Only Leaflet.js from unpkg.com CDN. No tracking, no analytics, no phone-home. Your map data stays on your server.

Is there a PHP API or hooks for developers?

Not yet, but custom hooks/filters may be added in future versions. If you need specific hooks, request them in GitHub Discussions.


πŸ’° Licensing & Cost

Is L.O.R.E. free?

Yes! L.O.R.E. is 100% free and open source (GPL v2).

Can I use L.O.R.E. on a commercial grid?

Yes! The GPL v2 license allows commercial use.

Can I modify L.O.R.E.?

Yes! You can modify the code for your own use. If you make improvements, consider contributing them back via pull request.

Do I need to credit L.O.R.E. on my site?

Not required, but appreciated! The map includes a small "L.O.R.E." attribution by default.


🀝 Contributing

How can I contribute?

  • Report bugs via GitHub Issues
  • Suggest features in Discussions
  • Submit pull requests with improvements
  • Help improve documentation (edit any Wiki page!)
  • Share L.O.R.E. with other grid owners

I found a bug - what should I do?

Check GitHub Issues to see if it's already reported. If not, create a new issue with details.

I have a feature request - where do I suggest it?

Post in GitHub Discussions under "Ideas" category.


πŸ“š More Help

Didn't find your question?


Have a question to add to this FAQ? Edit this page or suggest it in Discussions! πŸ™Œ

Clone this wiki locally