@bf6mods/cli 1.0.0

package/dist/resources/templates/AcePursuit/src/strings.json

@@ -0,0 +1,191 @@
+{
+  "teamrespawns": "Team Redeploys Remaining: {}",
+  "titleLineOne": "PORTAL HOH_Parkour",
+  "titleLineTwo": "PVE HOLDOUT",
+  "gearStore": "Weapons & Ammo",
+  "waitingforplayersX": "{}/{} IN LOBBY - {} REQUIRED",
+  "waitingforplayers": "Waiting for Players: {}/{}",
+  "combatStartDelayCountdown": "THE BATTLE BEGINS IN {}",
+  "gameround": "Round {}",
+  "enemiesremaining": "Enemies Remaining: {}",
+  "playerwallet": "Cash Remaining: ${}",
+  "healthState": "{} / {}",
+  "combatStartCountdown": "{} Enemies Inbound!",
+  "bigEnemyIncoming": "Powerful Enemy Inbound!",
+  "purchasePhaseCountdown": "Spend your cash! {}",
+  "gamestart": "GO!",
+  "startsin": "Start in {}",
+  "gamestarting": "Starting in: {}",
+  "gameending": "Game Ends In: {}",
+  "lap": "Lap {}/{}",
+  "victory": "WINNER!",
+  "scoreboard_1_rank": "#{}",
+  "scoreboard_1_name": "{}",
+  "scoreboard_1_time_1": "{}{}:",
+  "scoreboard_1_time_2": "{}{}.{}",
+  "scoreboard_1_time_3": ":",
+  "scoreboard_1_time_4": ".",
+  "vehicle_1": "F-97 Kestrel",
+  "vehicle_2": "F-61V",
+  "vehicle_3": "F-39E",
+  "X": "X",
+  "Select": "Select",
+  "leftArrow": "<",
+  "rightArrow": ">",
+  "readyplayers": "({}/{} ready)",
+  "ready": "READY",
+  "overtakenmessage": "OVERTAKE!",
+  "chosenvehicle": "CHOSEN VEHICLE",
+  "waitingforplayer": "Waiting for players to ready up!",
+  "selectVeh": "Selected Vehicle",
+  "header_placement": "FINISHED! You placed {}.",
+  "position_in_race": "{}/{}",
+  "scoreboard": "Scoreboard",
+  "combatPrePhaseBanner": "Enemy ETA {} Seconds",
+  "combatRoundBanner": "Round {}",
+  "combatPostPhaseBanner": "Enemy Attack Repulsed",
+  "purchasePrePhaseBanner": "Pre Purchase Phase Banner",
+  "purchasePhaseBanner": "Purchase Phase {}",
+  "youAreInJail": "You Are In No-Redeploy Jail",
+  "afterburnerExplainedTitle": "Comeback Mechanic",
+  "afterburnerExplained": "To keep things close, the racers at the back gain access to the afterburner. The number of boosted players scales with how many are in the race.",
+  "autoPurchasedRespawn": "Redeploy Purchased: -${}",
+  "outOfInventory": "Out of Inventory",
+  "modversion": "Script ver: {}-{}-{}",
+  "boosterdisabled": "AFTERBURNER TRIGGER DISABLED",
+  "sneakySnake": "Sneaky Snake",
+  "speedySnake": "Speedy Snake",
+  "slasher": "Stabber",
+  "sniper": "Sniper",
+  "soldier": "Soldier",
+  "shotgun": "Skeeter",
+  "hmgClass": "SAW-er",
+  "rpgClass": "Splasher",
+  "sacrificer": "Sacrificer",
+  "paratrooper": "Sky Soldier",
+  "_default_language_": "_en_",
+  "Abrams": "Abrams",
+  "Leopard": "Leopard",
+  "Cheetah": "Cheetah",
+  "CV90": "CV90",
+  "Gepard": "Gepard",
+  "UH60": "UH60",
+  "Eurocopter": "Eurocopter",
+  "AH6M": "AH6M",
+  "AH64": "AH64",
+  "Vector": "Vector",
+  "Quadbike": "Quadbike",
+  "GolfCart": "GolfCart",
+  "Marauder": "Marauder",
+  "Flyer60": "Flyer60",
+  "JAS39": "JAS39",
+  "F22": "F22",
+  "F16": "F16",
+  "M2Bradley": "M2Bradley",
+  "SU57": "SU57",
+  "store": {
+    "cashFmt": "Cash: ${}",
+    "costFmt": "${}",
+    "healthFmt": "Health: {}",
+    "killsFmt": "Kills: {}",
+    "closeStore": "X",
+    "disabledMsg": {
+      "locked": "LOCKED",
+      "buyAmmo": "BUY ANY AMMO"
+    },
+    "gunstab": "Guns",
+    "attachmentstab": "Attachments",
+    "gadgetstab": "Gadgets",
+    "ammotab": "Ammo",
+    "upgradestab": "Upgrades",
+    "randomize": "Reroll This Tab",
+    "gun1": "G36",
+    "gun2": "Tavor 7",
+    "gun3": "G3A4",
+    "gun4": "",
+    "primary1": "G36",
+    "primary2": "Tavor 7",
+    "primary3": "G3A4",
+    "primary4": "ACE 32",
+    "primary5": "HK433",
+    "primary6": "SCAR MK17",
+    "primary7": "L85A3",
+    "primary8": "KORD 6P67",
+    "primary9": "HK417 A2",
+    "primary10": "XM7",
+    "primary11": "M4A1",
+    "M4A1": {
+      "M4A1_SCP_RMR": "M4A1_SCP_RMR",
+      "M4A1_SCP_TrijiconMRO": "M4A1_SCP_TrijiconMRO",
+      "M4A1_SCP_TrijiconSDO": "M4A1_SCP_TrijiconSDO",
+      "M4A1_SCP_TrijiconVCOG": "M4A1_SCP_TrijiconVCOG",
+      "M4A1_SCP_NX81": "M4A1_SCP_NX81",
+      "M4A1_SCP_Mark4M2": "M4A1_SCP_Mark4M2",
+      "M4A1_SCP_VortexM157": "M4A1_SCP_VortexM157"
+    },
+    "primary12": "SCAR-SC .300",
+    "primary13": "QBZ-192",
+    "primary14": "AK-205",
+    "primary15": "MSBS GROT B10 C",
+    "primary16": "APC10 G Pro",
+    "primary17": "Kriss Vector",
+    "primary18": "UMP-40",
+    "primary19": "MP7 A2",
+    "primary20": "MP5 MLI",
+    "primary21": "P90 Tactical",
+    "primary22": "MPX",
+    "primary23": "M27 IAR",
+    "primary24": "Ultimax 100 MK8",
+    "primary25": "RPK",
+    "primary26": "M60E6",
+    "primary27": "M250",
+    "primary28": "Minimi 5.56 Mk3",
+    "primary29": "M240 L",
+    "primary30": "MG4k",
+    "primary31": "SVCh",
+    "primary32": "M39 EMR",
+    "primary33": "SVDM",
+    "primary34": "ARA Light DMR",
+    "primary35": "MRAD",
+    "primary36": "SV-98",
+    "primary37": "M2010 ESR",
+    "primary38": "590A1",
+    "primary39": "KSG",
+    "primary40": "M4/M1014",
+    "primary41": "18.5KS-K",
+    "ammo1": "Primary Ammo",
+    "ammo2": "Secondary Ammo",
+    "ammo3": "Primary Mag",
+    "ammo4": "Secondary Mag",
+    "upgrade1": "More Speed",
+    "upgrade2": "More Bullets",
+    "upgrade3": "More Lunch",
+    "upgrade4": "<-- buy me to unlock",
+    "upgrade5": "Bonus Health",
+    "upgrade6": "Bonus Damage",
+    "upgrade7": "+1 Redeploy",
+    "upgrade8": "Start Combat",
+    "gadgetTEST": "Test Gadget",
+    "gadget1": "C5 Explosives",
+    "gadget2": "RPG-7",
+    "gadget3": "Deployable Cover",
+    "gadget4": "Explosive Crossbow",
+    "gadget5": "Adrenaline Shot",
+    "gadget6": "T-UGS",
+    "gadget7": "Supply Crate",
+    "gadget8": "UAV",
+    "gadget9": "2x Throwing Knife",
+    "gadget10": "AT Mine",
+    "gadget11": "Defibrillator",
+    "gadget12": "SRAW",
+    "gadget13": "Motion Sensor",
+    "gadget14": "MBT LAW",
+    "gadget15": "MP APS",
+    "gadget16": "Decoy Grenade",
+    "gadget17": "Sticky Grenade Launcher",
+    "gadget18": "PTKM 1R",
+    "gadget19": "Concussion Grenade",
+    "gadget20": "M4 SLAM",
+    "gadget21": "Frag Grenade"
+  }
+}

package/dist/resources/templates/All/bf6.config.ts

@@ -0,0 +1,6 @@
+export default defineBf6Config({
+	entrypoint: 'src/index.ts',
+	config: 'src/config.json',
+	tscn: 'src/levels.tscn',
+	strings: 'src/strings.json',
+})

package/dist/resources/templates/All/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "{name}",
+  "scripts": {
+    "build": "bf6mods build",
+    "dev": "bf6mods dev",
+    "postinstall": "bf6mods prepare"
+  },
+  "type": "module",
+  "devDependencies": {
+    "@bf6mods/cli": "^1.0.0",
+    "@bf6mods/sdk": "^1.0.1"
+  }
+}

package/dist/resources/templates/All/tsconfig.json

@@ -0,0 +1,4 @@
+{
+	// Do not touch unless you know what you are doing
+	"extends": "./.bf6/tsconfig.json",
+}

package/dist/resources/templates/Basic/bf6.config.ts

@@ -0,0 +1,3 @@
+export default defineBf6Config({
+	entrypoint: 'src/index.ts',
+})

package/dist/resources/templates/Basic/src/index.ts

@@ -0,0 +1,112 @@
+/* 
+
+Welcome to basic templates!
+
+Here you can find some of the commonly used events and functions that'll hopefully kickstart your scripting journey. 
+'mod/index.d.ts' is your bestfriend when it comes to learning about all that is capable within Portal scripting. 
+If you're ever unsure how to do something, try searching for a relevant function in it! 
+
+*/
+
+////////////////////////////////// ON PLAYER EVENTS ///////////////////////////////////////
+//////////// Useful player action-related events to hook up reactive logics to ////////////
+
+// Triggered when player joins the game. Useful for pregame setup, team management, etc.
+export function OnPlayerJoinGame(eventPlayer: mod.Player): void {}
+
+// Triggered when player leaves the game. Useful for clean up logic, team management, etc.
+export function OnPlayerLeaveGame(eventNumber: number): void {}
+
+// Triggered when player selects their class and deploys into game. Useful for any spawn/start logic.
+export function OnPlayerDeployed(eventPlayer: mod.Player): void {}
+
+// Triggered on player death/kill, returns dying player, the killer, etc. Useful for updating scores, updating progression, handling any death/kill related logic.
+export function OnPlayerDied(eventPlayer: mod.Player, eventOtherPlayer: mod.Player, eventDeathType: mod.DeathType, eventWeaponUnlock: mod.WeaponUnlock): void {}
+
+export function OnPlayerEarnedKill(
+    eventPlayer: mod.Player,
+    eventOtherPlayer: mod.Player,
+    eventDeathType: mod.DeathType,
+    eventWeaponUnlock: mod.WeaponUnlock
+): void {}
+
+// Triggered when a player is damaged, returns same variables as OnPlayerDied. Useful for custom on damage logic and updating custom UI.
+export function OnPlayerDamaged(
+    eventPlayer: mod.Player,
+    eventOtherPlayer: mod.Player,
+    eventDamageType: mod.DamageType,
+    eventWeaponUnlock: mod.WeaponUnlock
+): void {}
+
+// Triggered when a player interacts with InteractPoint. Reference by using 'mod.GetObjId(InteractPoint);'.
+// Useful for any custom logic on player interaction such as updating check point, open custom UI, etc.
+// Note that InteractPoint has to be placed in Godot scene and assigned an ObjId for reference.
+export function OnPlayerInteract(eventPlayer: mod.Player, eventInteractPoint: mod.InteractPoint): void {}
+
+// Triggered when a player enters/leaves referenced BF6 capture point. Useful for tracking capture point activities and overlapping players.
+// Note that CapturePoint has to be placed in Godot scene, assigned an ObjId and a CapturePointArea(volume).
+export function OnPlayerEnterCapturePoint(eventPlayer: mod.Player, eventCapturePoint: mod.CapturePoint): void {}
+export function OnPlayerExitCapturePoint(eventPlayer: mod.Player, eventCapturePoint: mod.CapturePoint): void {}
+
+// Triggered when a player enters/leaves referenced AreaTrigger volume. Useful for creating custom OnOverlap logic, creating custom capture point, etc.
+// Note that AreaTrigger has to be placed in Godot scene, assigned an ObjId and a CollisionPolygon3D(volume).
+export function OnPlayerEnterAreaTrigger(eventPlayer: mod.Player, eventAreaTrigger: mod.AreaTrigger): void {}
+export function OnPlayerExitAreaTrigger(eventPlayer: mod.Player, eventAreaTrigger: mod.AreaTrigger): void {}
+
+/////////////////////// GAMEMODE EVENTS AND USEFUL FUNCTIONS //////////////////////////////
+////////// Various useful events and functions to manipulate gameplay and actors //////////
+
+export function OnGameModeEnding(): void {}
+
+export function OngoingGlobal(): void {}
+
+// Triggered on main gamemode start/end. Useful for game start setup and cleanup.
+export async function OnGameModeStarted() {
+
+    // Enables or disables a headquater. Note that HQ_PlayerSpawner has to be placed in Godot scene, assigned an ObjId and a HQArea(CollisionPolygon3D).
+    const hq = mod.GetHQ(0);
+    mod.EnableHQ(hq, true);
+
+    // Enables or disables the provided objective.
+    const capturePoint = mod.GetCapturePoint(0);
+    mod.EnableGameModeObjective(capturePoint, true);
+
+    // Returns the id corresponding to the provided object.
+    const capturePointId = mod.GetObjId(capturePoint);
+
+    // Returns a vector composed of three provided 'X' (left), 'Y' (up), and 'Z' (forward) values.
+    // Useful for specifying transform, 3d velocity or RGB color.
+    const vector = mod.CreateVector(1, 2, 3);
+
+    // Get player closest to a point
+    const player = mod.ClosestPlayerTo(vector);
+
+    // Returns the team value of the specified player OR the corresponding team of the provided number.
+    const teamOfPlayer = mod.GetTeam(player);
+    const teamObject = mod.GetTeam(0);
+
+    // Displays a notification-type Message on the top-right of the screen for 6 seconds. Useful for communicating game state/info or debugging.
+    const exampleMessage = mod.Message('example');
+    mod.DisplayNotificationMessage(exampleMessage);
+    mod.DisplayNotificationMessage(exampleMessage, player);
+    mod.DisplayNotificationMessage(exampleMessage, teamOfPlayer);
+
+    // Adds X delay in seconds. Useful for making sure that everything has been initialized before running logic or delaying triggers.
+    await mod.Wait(5);
+
+    // Teleports a target to a provided valid position facing a specified angle (in radians).
+    mod.Teleport(player, mod.CreateVector(100, 0, 100), mod.Pi());
+
+    // Returns the 'X', 'Y', or 'Z' component of a provided vector.
+    // Useful for modifying specific vector component or debugging transform.
+    const x = mod.XComponentOf(vector);
+    const y = mod.YComponentOf(vector);
+    const z = mod.ZComponentOf(vector);
+    const changedVector = mod.CreateVector(x + 10, y - 5, z * 2);
+
+    // Returns various player state information
+    const eyePosition = mod.GetSoldierState(player, mod.SoldierStateVector.EyePosition);
+    const facingDirection = mod.GetSoldierState(player, mod.SoldierStateVector.GetFacingDirection);
+    const health = mod.GetSoldierState(player, mod.SoldierStateNumber.CurrentHealth);
+    const isInWater = mod.GetSoldierState(player, mod.SoldierStateBool.IsInWater);
+}