π·οΈ Startup Flags
In Open Ticket, you can use startup flags when starting the bot from the console. This is useful for temporarily disabling some systems or enabling additional features in the bot.
A flag is inserted after the startup command (node index.js
or npm start --
). Every flag starts with --
and doesn't contain any spaces.
Flag Examples:β
--dev-config
: Use the./devconfig/
folder instead of./config
. Used by the Open Ticket developers.--debug
: Enable thedebug mode
in the bot. This will log almost everything to the console.--crash
: Crash the bot when an unexpected error happens.--no-checker
: Disable the config checker and start the bot without validating the config.--no-plugins
: Disable all plugins. This will start Open Ticket without modifications.--force-slash
: Force the bot to update all slash commands. This is useful when the slash commands are glitched for some reason.- And so much more!
Usage Examples:β
node index.js --debug --crash
npm start -- --debug --crash
(the extra--
is required!)
If you need help with enabling flags, feel free to join our discord server!
Table Of Contents
- No Migration
- Developer Config
- Developer Database
- Debug Mode
- Crash Mode
- Full Config Checker
- No Config Checker
- No Transcripts
- No Easter Eggs
- No Plugins
- Soft Plugin Crash
- Force Slash Update
- No Compile
- Compile Only
No Migration (--no-migration
)β
Aliases: -nm
Default Value: false
API Identifier: opendiscord:no-migration
Using this flag, you can disable Open Ticket data migration when the bot updates. Data migration is the process of modifying the Open Ticket database to a newer version (e.g. v4.0.0
to v4.1.0
).
β Disabling this feature may result in unexpected problems when running the bot.
Developer Config (--dev-config
)β
Aliases: -dc
Default Value: false
API Identifier: opendiscord:dev-config
Using this flag, the bot will read all built-in config files from ./devconfig/
instead of ./config/
. This is used by the developers from Open Ticket to test the bot without modifying the actual ./config/
directory.
This is a technical flag used mainly for development.
β You can also use this to test 2 different bots for plugin development.
Developer Database (--dev-database
)β
Aliases: -dd
Default Value: false
API Identifier: opendiscord:dev-database
Using this flag, the bot will read all built-in database files from ./devdatabase/
instead of ./database/
. This is used by the developers from Open Ticket to test the bot without modifying the actual ./database/
directory.
This is a technical flag used mainly for development.
β You can also use this to test 2 different bots for plugin development.
Debug Mode (--debug
)β
Aliases: -d
Default Value: false
API Identifier: opendiscord:debug
Couldn't find the error? Try running the bot with this flag!
This enables detailed debugging logs for plugin developers to help identify issues during execution.
This is a technical flag used mainly for development.
β
The output in the console will now be the same as in otdebug.txt
.
Crash Mode (--crash
)β
Aliases: -cr
Default Value: false
API Identifier: opendiscord:crash
If enabled, the bot will crash immediately on an unknown error instead of trying to recover.
β Use this if your hosting has its own error handling system.
Full Config Checker (--checker
)β
Aliases: -c
Default Value: false
API Identifier: opendiscord:checker
Enables the full Config Checker, which renders extra details about the botβs config files.
β
This will also log optional
issues with your config and recommendations.
No Config Checker (--no-checker
)β
Aliases: -nc
Default Value: false
API Identifier: opendiscord:no-checker
Disables the Config Checker entirely. Useful when debugging issues or testing specific scenarios.
β Use this when developing plugins or when experiencing issues with the config checker.
No Transcripts (--no-transcripts
)β
Aliases: -nt
Default Value: false
API Identifier: opendiscord:no-transcripts
Disables the creation and uploading of HTML transcripts for debugging purposes.
This is a technical flag used mainly for development.
β
This flag will has a higher priority than the transcripts.json
config enable/disable switch.
No Easter Eggs (--no-easter
)β
Aliases: -ne
Default Value: false
API Identifier: opendiscord:no-easter
Removes all hidden easter eggs in Open Ticket.
Use this if you want a serious, no-surprises bot experience.
β
Open Ticket currently only contain one small easter egg in the /stats
command which is related to contributors.
No Plugins (--no-plugins
)β
Aliases: -np
Default Value: false
API Identifier: opendiscord:no-plugins
Disables all Open Ticket plugins.
This is useful for testing core bot functionality without plugins.
β Be aware that custom stats from plugins will be removed from the database when the plugin is not enabled!
Soft Plugin Crash (--soft-plugins
)β
Aliases: -sp
Default Value: false
API Identifier: opendiscord:soft-plugins
If enabled, the bot won't crash when a plugin fails.
Instead, the bot will continue running while skipping the faulty plugin.
β This is not recommended for production usage. Please use it for development purposes only.
Force Slash Update (--force-slash
)β
Aliases: -fs
Default Value: false
API Identifier: opendiscord:force-slash-update
Forces an immediate update of all registered slash commands.
Use this when making slash command changes that arenβt updating properly.
β This is useful when the current slash commands are glitched/missing and you want to re-enable them.
No Compile (--no-compile
)β
Aliases: (None)
Default Value: false
API Identifier: opendiscord:no-compile
Disables automatic compilation of plugins and bot code before startup.
This is a technical flag used mainly for development.
β Use this to run the bot without re-compiling it after you made changes. Perfect for plugin developers.
Compile Only (--compile-only
)β
Aliases: (None)
Default Value: false
API Identifier: opendiscord:compile-only
This flag only compiles the bot and plugins without starting Open Ticket.
This is a technical flag used mainly for development.
β Use this to compile the bot without immediately starting it. Perfect for plugin developers.