Troubleshooting - Shopkeepers/Shopkeepers-Wiki GitHub Wiki

This page documents debugging and testing features that might help investigate or test functionality of the Shopkeepers plugin.

Commands

Check the Debugging and auxiliary Commands section for debugging and helper commands.

Debug Mode and Options

The plugin includes a "debug mode" that, when enabled, will cause the plugin to log or display additional information to the console or in-game in various situations.

The debug mode can be enabled via debug: true inside the Configuration or via the /shopkeeper debug [option] command.

Some of the debug logging can be quite verbose or impact the server's performance, so certain "debug options" must be additionally enabled to be in effect. Check the debug-options inside Configuration for a list of the available options and their effect. These debug options can either be enabled inside the config, or via the debug command.

Test Fallback Mode

The Shopkeepers plugin relies on server version specific code to function properly, but it includes a reflection-based "fallback mode" that it tries to run in when it detects a server version that is not yet supported. It is generally recommended to wait for an official plugin update instead of trying to run the plugin in this fallback mode. In either case, always keep backups of your plugin and world data in case the plugin breaks in unexpected ways and you need to revert.

This fallback mode is quite prone to break across server updates. In order to simplify testing it, it can be forcefully enabled by adding a file named .force-fallback in the plugin's data folder.