Skip to content

COMPATIBILITY.md

Latest commit

 

History

History
159 lines (108 loc) · 5.34 KB

COMPATIBILITY.md

File metadata and controls

159 lines (108 loc) · 5.34 KB

Compatibility Notes

⚠️ Player Inventory Transfer Limitation

Player inventories do NOT transfer between servers.

When a player uses a servergate to transfer from one server to another:

What Transfers:

  • ✅ Player username
  • ✅ Player authentication (if shared auth database)
  • ✅ Player privileges (if shared auth database)

What Does NOT Transfer:

  • ❌ All items in inventory
  • ❌ Armor items (helmet, chestplate, leggings, boots)
  • ❌ Wielded item (held in hand)
  • ❌ Health points
  • ❌ Breath/oxygen level
  • ❌ Experience/skill points
  • ❌ Quest progress
  • ❌ Player metadata from mods
  • ❌ Protected areas
  • ❌ Player's home/spawn points

Why This Limitation Exists:

  1. No Standardized Protocol: Minetest/Luanti has no built-in cross-server player transfer system
  2. Item Incompatibility: Different servers may run different games (Minetest Game, MineClone2, etc.) with incompatible item names
  3. Security Concerns: Transferring inventory would require complex validation to prevent exploits
  4. Mod-Specific Data: Items can have custom metadata that wouldn't transfer correctly

Design Recommendations:

  • Fresh Start Approach: Treat each server as a separate adventure
  • Identical Game Setup: Use the same game + mods across all servers for consistency (items still won't transfer, but gameplay will be familiar)
  • Spawn Kits: Give players starter items when they join
  • Communication: Clearly inform players that they'll lose inventory when transferring

For detailed information, see the full explanation in API.md and QUICKSTART.md.

Coexistence with Original Worldgate/Telemosaic Mods

This mod has been designed to coexist peacefully with the original worldgate mod and/or telemosaic mod if both are installed in the same world.

Visual Differences

Servergate Beacons (this mod):

  • Node names: servergate:servergate_beacon and servergate:servergate_beacon_off
  • Color: Red (#FF0000 active, #330000 inactive)
  • Purpose: Cross-server player transfers
  • Right-click shows destination server URL

Worldgate/Telemosaic Beacons (telemosaic mod):

  • Node names: telemosaic:beacon and telemosaic:beacon_off
  • Color: Blue (#4444FF)
  • Purpose: Local teleportation within the same server
  • Right-click teleports to destination

Node Groups

Servergate beacons use the servergate_beacon group instead of telemosaic or worldgate_beacon to avoid conflicts.

Backward Compatibility

For worlds that used the older version of this mod:

-- Aliases are automatically registered
minetest.register_alias("servergate:beacon", "servergate:servergate_beacon")
minetest.register_alias("servergate:beacon_off", "servergate:servergate_beacon_off")

Old beacons will automatically convert to the new servergate beacons.

Using Both Systems

You can have both systems in your world:

  1. Worldgates with Telemosaic Beacons: Traditional local teleportation
  2. Worldgates with Servergate Beacons: Cross-server transfers

Players will know which is which by the color:

  • Blue beacons = Local teleport (telemosaic)
  • Red beacons = Server transfer (servergate)

Migration from Pure Worldgate/Telemosaic

If you're upgrading a world that used the original worldgate mod:

  1. The worldgate structures will remain
  2. If telemosaic mod is installed, the blue beacons will continue working for local teleportation
  3. New worldgate structures will generate with red servergate beacons
  4. You can manually replace old beacons with servergate beacons if desired

Commands

All admin commands work specifically with servergate beacons:

  • /worldgate_info - Only works when looking at servergate beacons (red)
  • /worldgate_link - Only links servergate beacons
  • /worldgate_list - Lists servergates on this server

Telemosaic commands continue to work with telemosaic beacons independently.

Database Independence

The servergate system uses its own database tables and does not interfere with any telemosaic data:

  • Servergates: Stored in worldgates table
  • Telemosaic beacons: Use mod_storage or telemosaic's own system
  • No data conflicts between systems

Performance

Running both systems simultaneously:

  • No performance impact
  • Each system operates independently
  • Servergate beacons managed by ABM every 5 seconds
  • Telemosaic beacons managed by telemosaic mod

Recommended Setup

For a clean server network:

  1. Single Server: Use telemosaic for local gates only
  2. Multiple Servers: Use both:
    • Telemosaic for convenient local teleportation
    • Servergates for traveling between servers
  3. Pure Server Network: Disable servergate.native.link and use only servergates

Technical Details

Node Registration Order

The mod registers servergates before checking for telemosaic, ensuring both can coexist.

Metadata Keys

Servergate beacons use:

  • servergate:gate_id - UUID in database
  • servergate:source - Original generation position

These don't conflict with telemosaic's metadata keys.

Group Naming

  • servergate_beacon - This mod's beacons
  • telemosaic - Telemosaic mod's beacons
  • worldgate_extender - Decorative structure nodes (shared, no conflict)

Questions?

If you experience conflicts:

  1. Check that both mods are up to date
  2. Verify node names using /lua minetest.get_node(pos).name
  3. Report issues with full debug logs