General Questions
Can I use Runway with other plugins?
Can I use Runway with other plugins?
Yes! Runway is designed to work seamlessly with other plugins.Runway operates at the packet level, which means it processes messages sent by any plugin before they reach the player. This allows you to add MiniMessage formatting to plugins that don’t natively support it.Compatible with:
- Chat plugins (LuckPerms, EssentialsX Chat, etc.)
- GUI plugins (DeluxeMenus, ChestCommands, etc.)
- Scoreboard plugins (FeatherBoard, AnimatedScoreboard, etc.)
- Any plugin that sends messages, titles, or items
Does Runway work with Folia?
Does Runway work with Folia?
Yes! Runway fully supports Folia.The plugin’s This means Runway is compatible with Folia’s multi-threaded server architecture and can run safely on Folia servers without issues.
paper-plugin.yml explicitly declares:What is the performance impact?
What is the performance impact?
Minimal performance impact in most cases.Why it’s efficient:
- Runway only processes packets that require formatting
- When
require-prefixis enabled (default), only messages with[mm]or[p]are processed - Packet processing happens asynchronously via PacketEvents
- The plugin uses minimized/shaded dependencies to reduce overhead
- Keep
require-prefixenabled to avoid processing unnecessary packets - Only enable the listeners you actually need
- Disable placeholder parsing if not using PlaceholderAPI/MiniPlaceholders
- CPU: < 1% on average servers
- Memory: ~5-10MB additional RAM usage
- Network: No additional bandwidth (only modifies existing packets)
Why should I use prefixes?
Why should I use prefixes?
Prefixes provide fine-grained control over which messages are formatted.Benefits of prefixes:
- Performance - Only process messages that need formatting
- Compatibility - Avoid formatting messages that shouldn’t be formatted
- Selective formatting - Choose exactly which messages use MiniMessage
- Debug-friendly - Easy to identify which messages are being processed
[mm]- Enable MiniMessage formatting[p]- Enable placeholder parsing (PlaceholderAPI/MiniPlaceholders)[actionbar]- Send message as action bar
Can I disable the prefix requirement?
Can I disable the prefix requirement?
Yes! You can make Runway process all messages automatically.Disable prefixes in config.yml:When to disable:
- You want all server messages to support MiniMessage
- You’re using Runway as a global formatting solution
- You trust all plugin messages to have valid MiniMessage syntax
- Higher processing overhead (all packets are formatted)
- Potential formatting of unintended messages
- May cause issues if plugins send malformed text
What's the difference between PlaceholderAPI and MiniPlaceholders?
What's the difference between PlaceholderAPI and MiniPlaceholders?
Both plugins provide placeholder functionality, but they work differently:PlaceholderAPI:
- Traditional placeholder system
- Uses
%placeholder%syntax - Wide plugin support (1000+ plugins)
- Expansion-based (download specific placeholder packs)
- Example:
%player_name%,%vault_eco_balance%
- Modern placeholder system for MiniMessage
- Uses
<placeholder>syntax (matches MiniMessage) - Designed for Paper servers
- Built-in placeholders (no expansions needed)
- Example:
<player:name>,<server:tps>
How do custom placeholders work?
How do custom placeholders work?
Runway allows you to define custom static placeholders in Usage in messages:Key features:
placeholders.yml.Example configuration:- Placeholders are automatically converted to lowercase and use underscores
- Supports full MiniMessage syntax (gradients, hover, click events, etc.)
- Reloaded with
/runway reload - Static only (not player-specific)
Can I use Runway for scoreboards?
Can I use Runway for scoreboards?
Yes, but it’s disabled by default.Enable scoreboard support:Note: Scoreboard formatting can be performance-intensive since scoreboards update frequently. Only enable if you need MiniMessage formatting in scoreboards.Best practices:
- Keep scoreboard updates to a reasonable interval (1-2 seconds minimum)
- Use simple MiniMessage tags (avoid complex gradients)
- Test with multiple players online to verify performance
What happens to messages without the prefix?
What happens to messages without the prefix?
Depends on your configuration:With prefix required (default):With prefix disabled:
- Messages without
[mm]are passed through unchanged - Original formatting is preserved
- MiniMessage tags in the text are treated as literal text
- All messages are processed as MiniMessage
- MiniMessage tags are always interpreted
Is Runway compatible with ViaVersion?
Is Runway compatible with ViaVersion?
Yes! Runway declares optional dependencies for:
- ViaVersion
- ViaBackwards
- ViaRewind
Can I use Runway in production?
Can I use Runway in production?
Absolutely! Runway is designed for production use.Production-ready features:
- Minimal performance impact
- Graceful error handling
- Hot-reload configuration with
/runway reload - No data storage or persistence needed
- Compatible with Folia (multi-threaded)
- Actively maintained
- Test thoroughly on a staging server first
- Start with conservative settings (prefixes enabled)
- Monitor performance during peak hours
- Keep the plugin updated
How do I test if Runway is working?
How do I test if Runway is working?
Use the parse command:This command will show you exactly how Runway processes the text.Other tests:
- Add
[mm]to a message in another plugin’s config - Use the
/mecommand with MiniMessage formatting - Check if existing plugin messages respect the formatting
- Look for Runway in
/pluginslist (should be green)
- Console shows “Runway has been enabled”
- No errors during startup
- Parse command returns formatted text
Still Have Questions?
If your question isn’t answered here:- Check the Troubleshooting guide
- Read the Configuration documentation
- Contact the developer on Discord:
@mrafonso - Open a discussion on GitHub