- Required Dependencies
- https://umod.org/plugins/rust-kits
AimTrain brings you the assistance in firearm combat training by offering a mode to any server (event server or not) by just typing one command to be teleported to a configured location to shoot bots for practice in gun fire(bots are not shooting back). In order for players to join the AimTrain their inventory must be empty and will not be able to teleport unless done so. Once they are done they will be teleported back to their previous locations where they were before the training.
Players inside the Arena cant see each other while AimTraing, if you are using the Plugin on a other server than a Event server i recommend securing the Area with ZoneManager to make sure people cant leave the Arena with their kit.
Here a short Video of the Bots running around. (Bots are currently running through structures etc)
Player Commands
/at - To join AimTrain (If only one Arena is set up)
/at <arena name>- To join AimTrain (If multiple Arenas are set up)
Admin Commands
/aimtrain - Gives you Infos about all the options below.
/aimtrain add <arena name>
/aimtrain delete <name>
/aimtrain list
/aimtrain info <name>
/aimtrain leavepos - Sets the default spawn point when leaving AimTrain.
For the following commands you need to be editing a Arena, use /at_edit <name> to start editing a Arena.
/aimtrain sbot - To set a Bot spawn at current location.
/aimtrain splayer - To set a Player spawn at current location.
/aimtrain botkit <name> - Add a kit for the Bots.
/aimtrain playerkit <name> - Add a kit for the players.
/aimtrain movement - Toggle Bot movement in the Arena on/off.
/aimtrain enable - Toggle the Arena on/off.
/aimtrain botcount <amount> - Change the active Bot amount.
Permissions
aimtrain.join - Required to join AimTrain.
aimtrain.admin - Required to use /aimtrain commands.
Config
"Use permissons for Arena" - If this is true people need permissions to join Arenas, if your Arena is called Mountain, the players needs the permission aimtrain.Mountain.
"Needs empty inventory to join" - If this is false people can join without clearing their inventory, however the items will be lost.
"Enable UI" - Shows a little UI while AimTraining to leave and turn off/on unlimited Ammo.
"Use NoEscape Raid/Combatblock" - If this is set to true players cant join while they are Raid / Combatblocked (https://oxidemod.org/plugins/noescape.1394/)
"Bot Names" - You can give Bots different names, every time a bot spawns it will pick a random name from the list.
API
Check if a player is inside a AimTrain Arena
Add a player to a AimTrain Arena
Remove a player from AimTrain and teleport him a position
Hooks
Called when a player tries to join AimTrain, return non null object to cancel
Called when a player joined AimTrain
Called when a player leaves AimTrain
Players inside the Arena cant see each other while AimTraing, if you are using the Plugin on a other server than a Event server i recommend securing the Area with ZoneManager to make sure people cant leave the Arena with their kit.
Here a short Video of the Bots running around. (Bots are currently running through structures etc)
Player Commands
/at - To join AimTrain (If only one Arena is set up)
/at <arena name>- To join AimTrain (If multiple Arenas are set up)
Admin Commands
/aimtrain - Gives you Infos about all the options below.
/aimtrain add <arena name>
/aimtrain delete <name>
/aimtrain list
/aimtrain info <name>
/aimtrain leavepos - Sets the default spawn point when leaving AimTrain.
For the following commands you need to be editing a Arena, use /at_edit <name> to start editing a Arena.
/aimtrain sbot - To set a Bot spawn at current location.
/aimtrain splayer - To set a Player spawn at current location.
/aimtrain botkit <name> - Add a kit for the Bots.
/aimtrain playerkit <name> - Add a kit for the players.
/aimtrain movement - Toggle Bot movement in the Arena on/off.
/aimtrain enable - Toggle the Arena on/off.
/aimtrain botcount <amount> - Change the active Bot amount.
Permissions
aimtrain.join - Required to join AimTrain.
aimtrain.admin - Required to use /aimtrain commands.
Config
"Use permissons for Arena" - If this is true people need permissions to join Arenas, if your Arena is called Mountain, the players needs the permission aimtrain.Mountain.
"Needs empty inventory to join" - If this is false people can join without clearing their inventory, however the items will be lost.
"Enable UI" - Shows a little UI while AimTraining to leave and turn off/on unlimited Ammo.
"Use NoEscape Raid/Combatblock" - If this is set to true players cant join while they are Raid / Combatblocked (https://oxidemod.org/plugins/noescape.1394/)
"Bot Names" - You can give Bots different names, every time a bot spawns it will pick a random name from the list.
Code:
"Enable AimTrain": true,
"Use permissons for Arena": false,
"Needs empty inventory to join": true,
"Enable UI": true,
"Use NoEscape Raid/Combatblock": false,
"Bot Names": [
"Bot1",
"Bot2",
"Bot3"
],
"Commands that cant be used during AimTrain": [
"tp",
"home",
"kits",
"kit"
],
"Leave Position": {
"PosX": -494.816681,
"PosY": 21.4366665,
"PosZ": -228.687271
}API
Check if a player is inside a AimTrain Arena
Code:
bool IsAimTraining(ulong playerId)Add a player to a AimTrain Arena
Code:
void EnterAimTrain(BasePlayer player, string arenaName)Remove a player from AimTrain and teleport him a position
Code:
void LeaveAimTrain(BasePlayer player, Vector3 position = default)Hooks
Called when a player tries to join AimTrain, return non null object to cancel
Code:
object CanJoinAimTrain(BasePlayer player)Called when a player joined AimTrain
Code:
void JoinedAimTrain(BasePlayer player)Called when a player leaves AimTrain
Code:
void LeftAimTrain(BasePlayer player)
