Skip to content

Installation Guide

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

Installation Guide

This guide walks you through installing L.O.R.E. on your WordPress site step-by-step.

⚙️ Requirements

Before installing L.O.R.E., make sure you have:

  • ✅ WordPress 5.5 or higher
  • ✅ PHP 7.4 or higher
  • ✅ OpenSimulator grid (any version with Robust database)
  • ✅ MySQL/MariaDB access to your Robust database
  • ✅ Warp3D map tiles enabled on your grid

Not sure if you have Warp3D? Check your OpenSim.ini for [Warp3DImageModule]. Most modern grids have this enabled by default.

📥 Method 1: WordPress Admin (Recommended)

This is the easiest method for most users.

Step 1: Download L.O.R.E.

  1. Go to the Releases page
  2. Download the latest lore-opensim-map-vX.X.X.zip file
  3. Save it to your computer

Step 2: Upload to WordPress

  1. Log into your WordPress Admin dashboard
  2. Go to Plugins → Add New
  3. Click the Upload Plugin button at the top
  4. Click Choose File and select the zip you downloaded
  5. Click Install Now

Upload Plugin

Step 3: Activate

  1. After installation completes, click Activate Plugin
  2. You'll see "Plugin activated" at the top
  3. L.O.R.E. is now installed!

Next: Continue to Configuration Guide to set up your grid.

📁 Method 2: FTP/FileZilla

If you prefer manual installation or don't have access to WordPress Admin upload:

Step 1: Download and Extract

  1. Download lore-opensim-map-vX.X.X.zip from Releases
  2. Extract the zip file on your computer
  3. You should see a folder called lore-opensim-map

Step 2: Upload via FTP

  1. Connect to your WordPress server via FTP (FileZilla, WinSCP, etc.)
  2. Navigate to /wp-content/plugins/
  3. Upload the entire lore-opensim-map folder
  4. Wait for all files to upload

Step 3: Activate in WordPress

  1. Log into WordPress Admin
  2. Go to Plugins
  3. Find "L.O.R.E. - Leaflet OpenSimulator Regional Explorer"
  4. Click Activate

Next: Continue to Configuration Guide to set up your grid.

🔄 Upgrading L.O.R.E.

From v1.0.0 to v1.0.1+

WordPress Admin Method:

  1. Go to Plugins in WordPress Admin
  2. Find L.O.R.E. and click Deactivate
  3. Click Delete
  4. Follow Method 1 above to install the new version
  5. Your settings and region data are preserved!

FTP Method:

  1. Delete the /wp-content/plugins/lore-opensim-map/ folder
  2. Upload the new version
  3. Activate in WordPress Admin

⚠️ Important: Your database table (wp_lore_regions) and all settings are stored in the WordPress database, NOT in the plugin files. Deleting the plugin folder is safe - you won't lose any data!

🗄️ Database Permissions

L.O.R.E. needs read-only access to your OpenSimulator Robust database to sync regions.

Option 1: Create a Read-Only MySQL User (Recommended)

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

This creates a user that can ONLY read the regions table - much more secure!

Option 2: Use Existing Database User

You can use your existing Robust database credentials, but this gives L.O.R.E. full access. Only do this if you trust the plugin and your WordPress site is secure.

✅ Verify Installation

After activation, you should see:

  1. Settings → L.O.R.E. Map appears in your WordPress admin menu
  2. A new database table wp_lore_regions exists (check via phpMyAdmin)
  3. No error messages appear

Having issues? Check Troubleshooting or FAQ.

🎯 Next Steps

  1. Configure L.O.R.E. - Enter your grid settings
  2. Sync Your Regions - Import regions from your database
  3. Add the Map - Put the map on a page

Need help? Visit the Troubleshooting page or ask in GitHub Discussions.

Clone this wiki locally