GunPlugin Documentation Version: 1.0.0 Introduction GunPlugin is a highly customizable gun plugin designed for Minecraft servers. With GunPlugin, you can create custom guns that can be assigned to any item and use any type of ammo. Whether you're looking to enhance your server's combat experience or add a unique gameplay element, GunPlugin provides extensive customization options to suit your needs.
Features
Create highly customizable guns in Minecraft.
Assign guns to any item in the game.
Use any type of ammo with your guns.
Customize various aspects of the gun, including bullet damage, bullet velocity, particles, sound, and more.
Simple usage: Hold the gun and right-click to shoot, or left-click to reload.
Installation
Download the GunPlugin.jar file from the official website or trusted plugin distribution platform.
Place the GunPlugin.jar file into the "plugins" folder of your Minecraft server.
Start or restart your server.
Configuration After installing GunPlugin, you can customize the plugin's behavior by modifying the configuration file. The configuration file can be found at: plugins/GunPlugin/config.yml
The config.yml file contains various options that allow you to tailor the plugin to your preferences. Here's a brief overview of the available settings:
gun-settings section: This section contains settings related to gun customization. Each gun customization is defined within this section, allowing you to specify bullet damage, bullet velocity, particles, sound effects, and more.
Usage GunPlugin offers a simple and intuitive way to use the guns in-game. Here's how you can use the plugin effectively:
Acquiring a Gun:
Obtain a gun by assigning it to any item in the game. You can do this by using the appropriate ItemStack name in the 'config.yml'
Shooting:
To shoot the gun, hold the assigned item and right-click. The gun will fire a bullet with the specified settings, such as damage, velocity, particles, and sound effects.
Reloading:
To reload the gun, simply left-click while holding the assigned item. The gun will be reloaded based on the specified configuration.
Customization GunPlugin offers extensive customization options to create unique gun experiences. The plugin provides 49 different customization settings, allowing you to fine-tune the behavior of your guns. These customizations include:
Bullet damage: Control the amount of damage the bullet inflicts on players or entities.
Bullet velocity: Adjust the speed at which the bullet travels.
Particles: Customize the visual effects produced by the bullet.
Sound effects: Define the sounds played when shooting or reloading the gun.
And much more.
To customize a gun, you will need to edit the config.yml file as described in the Configuration section above. Within the gun-settings section, locate the customization you wish to modify and adjust its corresponding values.
#
# GunPlugin
# Highly Customizable Gun Plugin
# v1.0.1
#
# General Settings
bulletDrop: false
cancelEvent: true
cancelPlayerDamage: true
# Bullet Settings
bullet:
item: 'ARROW'
particleAmount: 1
particleDelay: 1
projectileVisible: false
removeAmmoAmount: 1
# Gun Settings
gun:
bulletVelocity: 3.5
damage: 5.0
item: 'BOW'
recoilStanding: 0.05
recoilCrouching: 0.01
# Gun Actions
actions:
shoot: 'RIGHT_CLICK'
reload: 'LEFT_CLICK'
# Sound Settings
blockHit:
sound: 'BLOCK_ANVIL_HIT'
volume: 1
pitch: 100
entityHit:
sound: 'BLOCK_BAMBOO_BREAK'
volume: 1
pitch: 100
gunshot:
sound: 'ENTITY_ARROW_SHOOT'
volume: 3
pitch: 100
hitMarker:
sound: 'BLOCK_BAMBOO_BREAK'
volume: 1
pitch: 100
noAmmo:
sound: 'UI_BUTTON_CLICK'
volume: 1
pitch: 100
reload:
sound: 'ITEM_SHIELD_BLOCK'
volume: 1
pitch: 100
# Particles
bulletParticle:
particle: 'ELECTRIC_SPARK'
particleStartDelay: 2
particleFollowTicks: 1
blockHitParticle:
particle: 'ASH'
amount: 100
entityHitParticle:
particle: 'FALLING_LAVA'
amount: 100
Troubleshooting If you encounter any issues or need assistance with GunPlugin, consider the following troubleshooting steps:
Verify that you have installed the plugin correctly by following the installation instructions.
Double-check the configuration file (config.yml) for any syntax errors or incorrect values. Ensure that the desired gun settings are accurately defined.
If the plugin is not functioning as expected, check the server console for any error messages or warnings related to GunPlugin.