CinematicsModelsAddons

A Minecraft plugin for hiding MythicMobs during cinematics.

• Description
• Features
• Dependancies
• Installation
• Configuration
  • config.yml
  • mythicmobs_hide_cinematic.yml
• Commands
  • Main commands
  • Alternatives
  • Options
• Permissions
• How it works
• Debug mode
• PlaceholderAPI integration
• Known-issues
• FAQ
• License
• Author

Description

CinematicsModelsAddons is a plugin designed to enhance the cinematic experience on your Minecraft server. Its main feature is to make specific MythicMobs invisible when a player is in cinematic mode, preventing these mobs from disrupting your cinematic scenes.

The plugin can work either with PlaceholderAPI (using the %typewriter_in_cinematic% variable) or in manual mode via commands.

Features

• Automatic hiding of MythicMobs during cinematics
• Integration with PlaceholderAPI for cinematic mode detection
• Commands to manually simulate cinematic mode
• Options to set a specific duration for cinematic mode
• Silent mode for commands (without confirmation messages)
• Easy configuration of mob types to hide
• Detailed logging system for debugging

Dependencies

• Required: MythicMobs
• Optional: PlaceholderAPI (for automatic cinematic mode detection)

Installation

1. Download the plugin JAR file
2. Place it in your server's plugins folder
3. Restart your server
4. Configure the mythicmobs_hide_cinematic.yml file to specify which mob types to hide

Configuration

config.yml

# Configuration for CinematicsModelsAddons
# Plugin for hiding MythicMobs during cinematics

# General settings
settings:
  # Debug mode (shows more information in console)
  # false: Only basic plugin logs
  # true: Detailed logs including mob visibility changes and player statuses
  debug: false
  
  # Log options (only applied when debug mode is enabled)
  logs:
    # Log mob visibility changes
    mob-visibility: true
    # Log player cinematic status changes
    player-status: true
    # Log command executions
    commands: true
    # Log plugin reload events
    reload: true
    # Log plugin startup and shutdown
    lifecycle: true

# Plugin messages
messages:
  prefix: "&7[&bCMA&7] "
  player-only: "%prefix%&cThis command can only be used by a player."
  no-permission: "%prefix%&cYou don't have permission to use this command."
  invalid-args: "%prefix%&cIncorrect usage. Use /cinematicsmodelsaddons <start|stop|reload> [options]"
  invalid-subcommand: "%prefix%&cInvalid subcommand. Available options: start, stop, reload"
  invalid-simulate-args: "%prefix%&cIncorrect usage. Use /simulatecinematic <start|stop> [duration] [player] [-s]"
  invalid-simulate-action: "%prefix%&cInvalid action. Use 'start' or 'stop'."
  invalid-duration: "%prefix%&cDuration must be a positive integer (in seconds)."
  mythicmobs-unavailable: "%prefix%&cMythicMobs is not available. Unable to execute command."
  player-not-found: "%prefix%&cPlayer &e%player%&c was not found."
  cinematic-started: "%prefix%&aCinematic mode &aactivated&a. Configured mobs are now invisible to you."
  cinematic-stopped: "%prefix%&aCinematic mode &cdeactivated&a. Configured mobs are visible again."
  cinematic-started-other: "%prefix%&aCinematic mode &aactivated&a for &e%player%&a."
  cinematic-stopped-other: "%prefix%&aCinematic mode &cdeactivated&a for &e%player%&a."
  cinematic-started-time: "%prefix%&aCinematic mode &aactivated&a for &e%time% seconds&a."
  cinematic-started-time-other: "%prefix%&aCinematic mode &aactivated&a for &e%player%&a for &e%time% seconds&a."
  reload-success: "%prefix%&aConfiguration reloaded successfully!"

mythicmobs_hide_cinematic.yml

# Configuration for MythicMobsHideCinematic
# List of MythicMobs types to hide during cinematics
mobs:
  - "arbre_chene"
  - "arbre_bouleau"
  - "zombie"
  - "skeleton"
  - "golem"
  - "dragon"
  - "boss"
  - "creeper"
  # Add your mob types here

# Check frequency (in ticks)
update-frequency: 10

Commands

Main Commands

• /cinematicsmodelsaddons or /cma - Main command
  • start [duration] [player] [-s] - Activates cinematic mode
  • stop [player] [-s] - Deactivates cinematic mode
  • reload [-s] - Reloads the plugin configuration

Alternative Commands

• /simulatecinematic or /sc or /cinematic - Alternative command for cinematic mode

  • start [duration] [player] [-s] - Activates cinematic mode
  • stop [player] [-s] - Deactivates cinematic mode

• /cmaReload or /cinematicsreload or /cmarl - Alternative command for reloading the configuration

  • [-s] - Option to reload in silent mode (without messages)

Command Options

• [duration] - Duration in seconds of cinematic mode (optional, default: indefinite)
• [player] - Name of the target player (optional, requires permission to target other players)
• [-s] - Option to execute the command in silent mode (without messages)

Permissions

• cinematicsmodelsaddons.command.use - Permission to use the main command
• cinematicsmodelsaddons.command.simulatecinematic - Permission to simulate a cinematic
• cinematicsmodelsaddons.command.simulatecinematic.others - Permission to simulate a cinematic for another player
• cinematicsmodelsaddons.command.reload - Permission to reload the plugin configuration

How It Works

Cinematic Mode

The plugin can detect cinematic mode in two ways:

1. Via PlaceholderAPI: If PlaceholderAPI is installed, the plugin checks the %typewriter_in_cinematic% placeholder for each player. If this placeholder returns "1" or "true", the player is considered to be in cinematic mode.

2. Via manual commands: The commands /cma start or /simulatecinematic start allow you to manually activate cinematic mode for a player.

When a player is in cinematic mode, all MythicMobs whose type is listed in mythicmobs_hide_cinematic.yml will automatically be made invisible for that player only.

Cinematic Mode Duration

Cinematic mode can be:

• Permanent (until manually deactivated)
• Temporary (for a specified duration in seconds)

If a duration is specified, cinematic mode will automatically be deactivated after this duration, and mobs will become visible to the player again.

Silent Mode

All commands can be executed with the -s option for silent mode. In this mode:

• No message is sent to the player when cinematic mode is activated/deactivated
• Confirmation messages are not sent to the command executor
• Silent mode is preserved for the entire duration of cinematic mode (including automatic deactivation)

Debug Logs

When debug mode is enabled (settings.debug: true), the plugin will display detailed logs in the server console. These logs can be customized to include only the desired information.

Debug Mode

The plugin has a debug mode that can be enabled in the config.yml file. When enabled, the plugin displays detailed information in the server console about:

• Mob visibility changes (which mobs have been hidden/shown to which players)
• Player cinematic status changes (activation/deactivation of the mode)
• Command executions (who executed which command with which parameters)
• Reload events (details about the reloaded configuration)
• Plugin lifecycle events (startup/shutdown)

Example of debug logs:

[INFO] [CinematicsModelsAddons] [DEBUG] Manual activation of cinematic mode for Player1 for 60 seconds
[INFO] [CinematicsModelsAddons] [DEBUG] Hidden 5 mobs for player Player1
[INFO] [CinematicsModelsAddons] [DEBUG] Mob zombie (ID: 12345) hidden for Player1

PlaceholderAPI Integration

If PlaceholderAPI is installed, the plugin will automatically use the %typewriter_in_cinematic% placeholder to detect if a player is in cinematic mode. This feature allows you to easily integrate this plugin with other cinematic plugins that use PlaceholderAPI.

When PlaceholderAPI is not detected, the plugin automatically switches to manual mode, where only commands can activate/deactivate cinematic mode.

Known Issues

• If MythicMobs is not loaded, cinematic simulation commands will not work properly.
• In case of server restart, the manual cinematic state of players will be lost.

FAQ

Q: How do I hide all mobs of a certain type?
A: Add the internal name of the mob to the mobs list in the mythicmobs_hide_cinematic.yml file.

Q: How can I find the internal name of a MythicMob?
A: Use the command /mm mobs list to see all loaded mob types.

Q: Does the plugin work for vanilla mobs?
A: No, the plugin is specifically designed for MythicMobs.

Q: How can I activate cinematic mode for all players?
A: You need to execute the command for each player individually.

License

This plugin is under the MIT license. See the LICENSE file for more details.

Author

• Ax_Dev - Main developer