Team Fortress 2 Classic · handler “TeamFortress2Classic”

Version 2

Files 3

Hub.Handler.Version = 2; // Released at https://hub.splitscreen.me/ on Sun Nov 29 2020 12:47:22 GMT+0000 (UTC).
Hub.Handler.Id = "MyBKSkcch7tQQ7r7Y";
Hub.Maintainer.Name = "Bizzo";
Hub.Maintainer.Id = "HEgozNi3MNvhAmWfi";

//^^^^ Remove these lines if you are creating a new personal script.

/* Nucleus R4 make the mouse pointer lag when using DInput. This should be used only with controllers:
With more than 4 controllers, you can use only ONE XboxOne controller and you can't use at the same time the keyboard. 
You must click/alt+tab on the corresponding instance to make it work. 
In alternative you can try fix the problem by doing this http://www.snes9x.com/phpbb3/viewtopic.php?t=27510 or try Xoutput.
For enable the support add two slashes // before this line:
- Game.XInputPlusDll = [ "xinput1_4.dll" ]; 
and set on true or remove slashes from these ones:
- Game.Hook.XInputReroute
- Game.Hook.CustomDllEnabled
- Game.Hook.XInputNames = [ "xinput1_4.dll" ];
*/

/* If you are creating a script, PCGamingWiki is a good start for find fixes for problems https://www.pcgamingwiki.com/wiki/Home . Or use google if is not Nucleus problem related ;)  
You can ask support on our Discord https://discord.com/invite/WFnyMfh or in our subReddit https://www.reddit.com/r/nucleuscoop/ . 
Also, check the FAQ post https://www.reddit.com/r/nucleuscoop/comments/fjdqid/list_of_new_supported_games_and_faq/ */

/*You can find most of the lines in the Mod-ReadMe.txt (inside Nucleus root folder) and in the Master_SCript.js (documentation link inside Reddit FAQ post).
Check even the released scripts (usually, scripts of games that use the same game-engine share a lot characteristic. Example: You are scripting an Unreal Engine 4 game? Use as a base-script one that use Unreal Engine 4). */

/*These lines will add/show in the first Nucleus options tab.
var answers = contains the possible answers that the User can choose.
Game.AddOption("Question", "Description", "ID of the option", *here what var answers this option will show);*/
var answers = ["60", "45", "30", "120", "144", "240", "300"];
Game.AddOption("Which FPS Cap the game will use?", "", "Fps", answers);

/* (Team Fortress 2 Classic must have Steam open. Using the command "-insecure" the game will be able to start multiple times.)
Most of the games, need a specific (or more) mutex/event/semaphore to be killed. (Not all of them. There are game that you can start multiple times without problems, so try it before do work for nothing :p)
Usually the right one/ones have the game-name or engine-name in the name. For example, most of source game use "hl2"_singleton_mutex.
For check which ones the game use, we are gonna use Process Explorer: https://docs.microsoft.com/en-us/sysinternals/downloads/process-explorer .
Open Process Explorer (with admin rights), start the game, click the game process on the list and press View Handles (Ctrl+H). You will see the full list of mutex/event/semaphore...
If you think to have found the right one, right click on it and choose "Close Handle". After that, try to run a second instance of the game and see if it open.
Be careful that launchers check if the game is already running. For example, Goldberg, make the game unseen from Steam. So, if is a Steam game, try to create a script with 
Goldberg enabled for testing if the game starts multiple times (+ the mutex/event/semaphore...etc needed to be kill).
If you find that, no mutex closed helps you (or is not enough), there are other ways:
- Change the game exe name for each instance (in Nucleus = Game.ChangeExe = true;)
- Change name of the game window. You can use https://www.nirsoft.net/utils/winexp.html for testing. (in Nucleus = Game.IdInWindowTitle = true;) 
- Start the game as a different windows user. (For testing you need a second windows user and press shift + right click on the exe and choose "Rus as another user". In Nucleus you can use
  Game.LaunchAsDifferentUsers = true; and if needed Game.ThirdPartyLaunch = true;)*/
Game.KillMutex = ["hl2_singleton_mutex"]; //you can even specify the type: Game.KillMutex = ["Type:Mutant|mutex_to_kill", "Type:Semaphore|mutex_to_kill", "Type:Event|mutex_to_kill",];
Game.RenameNotKillMutex = true; //Instead of killing the mutex, rename it to something else | Requires Game.KillMutex to contain the EXACT name of the mutexes for this to work (no partial). For a tester this helped kill the mutex in this game.

//Name of the folders you don't want Nucleuscoop to symlink, only the folders placed here get hardcopied not the files.
Game.DirSymlinkExclusions = ["bin", "tf2classic", "tf2classic\\cfg"];

//Name of the files you want Nucleuscoop to do real copies instead of symlinking them.
Game.FileSymlinkCopyInstead = ["config.cfg", "360controller.cfg"];

//Name of the files you don't want Nucleuscoop to symlink, only the files placed here will be completaly ignored
Game.FileSymlinkExclusions = ["autoexec.cfg", "config.cfg", "listenserver.cfg", "mapcycle.txt", "motd_default.txt", "motd_text_default.txt", "xinput1_4.dll"];

//		[Game Info]
// Here the lines that are used by Nucleus for infos about the game

//What executable the game use. This will be used by Nucleus for "exe script selection", for run the game and as process to follow for postion and resizing.
Game.ExecutableName = "hl2.exe";
//Here the SteamID of the game. You can find it on https://steamdb.info/ . Add it only if the game is available on Steam.
Game.SteamID = "";
//The name of the folder that will be created inside the Nucleus\content folder (Don't use spaces). In this folder Nucleus will store the game files for each instance of the game.
Game.GUID = "TeamFortress2Classic";
//Title of the game that will be show on Nucleus.
Game.GameName = "Team Fortress 2 Classic";
//Relative path to where Nucleus should start the game's working folder to.
Game.WorkingFolder = "bin";
//The name of the launcher's window title. Some games need to go through a launcher to open. This is needed or else the application will lose the game's window.
Game.LauncherTitle = "";
//Usually source games, use hl2.exe as executable. Each game as is own gameinfo.txt that identify the game that hl2.exe will load.
Game.ExecutableContext = ["tf2classic"];
//This is just an info. It will not limit the players number.
Game.MaxPlayersOneMonitor = 4;
//This is just an info. Usually we write the max players number the game support. (PC, should support max 16 input devices connected)
Game.MaxPlayers = 32;

//		[File System]
// Lines for decide how Nucleus will copy (or not) the game files.

//False = this will copy the game exe. Enable = will symlink the game exe.
Game.SymlinkExe = false;
//False = this will not copy the game in Nucleus\content folder. Enable = this will symlink the game in Nucleus\content folder
Game.SymlinkGame = true;
//False = after Nucleus is closed, game files inside Nucleus\content will be deleted. Enable = Nucleus will keeps the files inside Nucleus\content even after is closed. Useful if the game store saves in the game-folder.
Game.KeepSymLinkOnExit = false;
//False = this will not do a real copy of all game files. Enable = this will do a real copy of all game files.
Game.HardcopyGame = false;
//Different type of link files. Hardlink files instead of Symlink (or hard copy) | Directories will still be symlinked but files will be hardlinked
Game.HardlinkGame = false;

//		[Hooks]

//If enabled, Windows taskbard will be hidden.
Game.HideTaskbar = true;
//Chooses whether or not to automatically move the windows around to fit in the right spaces.
Game.SupportsPositioning = false;
//If our custom x360ce xinput DLL should hook into the game's window and fake Window's events so we never leave focus.
Game.Hook.ForceFocus = false;
//If force focus is enabled, this is the window we are attaching ourselves to and the window we are going to keep on top. Needs exact name of the window. If force focus is disabled you still need to set the game window name for resizing and positioning.
Game.Hook.ForceFocusWindowName = "Team Fortress 2 Classic";
//Usually helps when you hear the audio only from one instance. Enable or disable the sending of focus messages to each game window at a regular interval. This will help the game on thinking is window is active and not out of focus.
Game.HookFocus = true;
//Enable or disable hooks of functions some games may try and use to prevent multiple instances from running
Game.HookInit = true;

//		[Input lines]

//(Multiple Keyboards/Mice support is enabled) If enabled, will allow the keyboard to be used as a device input in Nucleus. Before enable it by default, be sure that keyboard/mouse works without problems.
Game.SupportsKeyboard = false;
//Keyboard player will be the first to be initialized
Game.KeyboardPlayerFirst = false;
//If enabled, will allow DInput devices to be used as a device input in Nucleus. This doesn't mean that it will work with the game if not supported.
Game.Hook.DInputEnabled = false;
//If we should completely remove support for DirectInput input from the game
Game.Hook.DInputForceDisable = true;
//If enabled, will allow XInput devices to be used as a device input in Nucleus. This doesn't mean that it will work with the game if not supported.
Game.Hook.XInputEnabled = true;
//If enabled, will allow XInput devices to act like DInput devices. This allow to use more than 4 controllers. You can use only ONE XboxOne controller and you can't use at the same time the keyboard. You must click/alt+tab on the corresponding instance to make it work. In alternative you can try fix the problem by doing this http://www.snes9x.com/phpbb3/viewtopic.php?t=27510 or try Xoutput.
Game.Hook.XInputReroute = false;
//If force focus is enabled, this blocks all mouse input.
Game.Hook.BlockMouseEvents = false;
//If force focus is enabled, this blocks all input events but gamepad.
Game.Hook.BlockInputEvents = false;
//If force focus is enabled, this blocks all keyboard input.
Game.Hook.BlockKeyboardEvents = false;

/*You can find out which dlls the game is using with Process Explorer. 
Start the game, open Process Explorer, click on the game process and click on View DLLs (Ctrl+D).
Search on the list and you will find which Xinput DLLs the game is using. Game that support controllers but not Xinput ones (old games) use dinput8.dll or dinput.dll.*/

/* [This is used for restrict each controller to a specific instance. Disable other alternatives if you are using this one. For XInputPlusDll, remove or comment the line by using // for disable it.] 
This set up XInputPlus and specify which Xinput DLL it will use (If multiple dlls required, use comma seperated strings).
XinputPlus support max 4 controllers.*/
Game.XInputPlusDll = ["xinput1_4.dll"];

/* [This is used for restrict each controller to a specific instance. Disable other alternatives if you are using this one. CustomDllEnabled is enabled by default so, if you will not use it, add this line in false]
If the game should be run using our custom version of x360ce for gamepad control. Enabled by default as the majority of our games need it. */
Game.Hook.CustomDllEnabled = false;
//Game.Hook.XInputNames = [ "xinput1_4.dll" ]; //This line specify which DLLS CustomDll will use.

//		[Multiple Keyboards/Mice lines]

//[thanks to Ilyaki for the multiple keyboards and mice support and guide]

//If enable, it will allow multiple Keyboards and Mice to be used as a device input in Nucleus. Before enable it by default, be sure that all works without problems.
Game.SupportsMultipleKeyboardsAndMice = true;

// This will hook the SetCursorPos Windows function which the game may use to set the mouse position.
// This is useful to have on to prevent the game from moving the 'real' Windows mouse cursor around the screen.
Game.HookSetCursorPos = true;
// This will hook the GetCursorPos Windows function which the game may use to get the mouse position.
Game.HookGetCursorPos = true;
// These options hook Windows functions that can be used by the game to detect if keys are down.
// HookGetAsyncKeyState is usually the only one that's needed, but leave the others enabled if there are no problems.
// Some games may conflict with these hooks, so try toggling some of them if keyboard input isn't working properly.
Game.HookGetKeyState = true;
Game.HookGetAsyncKeyState = true;
Game.HookGetKeyboardState = true;
// This filters raw input messages inside the application. This makes sure each instance only receives input for its designated input device.
Game.HookFilterRawInput = true;
// This hook filters many mouse messages to position the mouse cursor and other necessary changes from within the game itself.
// This should almost always be enabled, unless it causes some conflict.
Game.HookFilterMouseMessages = false;
// This is the main switch for legacy input.
Game.HookUseLegacyInput = false;
//Nucleus Coop will hook mouse movement messages and the GetCursorPos function to work around legacy input. Some games only need the GetCursorPos hook and conflict when mouse movement messages are edited. If this is the case, enable this option:
Game.HookDontUpdateLegacyInMouseMsg = false;

// This will send the game mouse input via Windows messages.
Game.SendNormalMouseInput = true;
// This sends keyboard input via Windows messages. This is usually all that's needed to get keyboard input working.
Game.SendNormalKeyboardInput = true;
// Use this to send scroll wheel events to the game.
// Some games don't need this, if for example they receive scroll wheel data from raw input.
Game.SendScrollWheel = true;
//In some cases, you may need to forward raw mouse input. This is almost never needed as re-register raw input has the same effect with a much more efficient method. Forwarding input forwards raw input from Nucleus Coop to the game. This has a high CPU usage and many input events will not pass, resulting in choppy movement.
Game.ForwardRawMouseInput = false;
// The same as ForwardRawMouseInput, but for keyboards. Again, this should almost never be used instead of re-register raw input.
Game.ForwardRawKeyboardInput = false;
// This will re-register the game for Windows raw input with the option to receive input while not in the foreground.
// This is important as most games will register to receive raw input only when in the foreground.
Game.HookReRegisterRawInput = false;
Game.HookReRegisterRawInputMouse = false;
Game.HookReRegisterRawInputKeyboard = false;
// This enables the fake mouse cursor to be drawn over the game by Nucleus Coop.
// If the game uses a custom cursor, you will probably not need this option. (This will be obvious if you see the games custom cursor and a fake cursor drawn over it).
// Be aware this is a 'fake' mouse cursor in the sense that Nucleus Coop will fake mouse input to the game via the other options and then the fake mouse cursor is drawn where the game should be responding to mouse input.
// The fake cursor is drawn by creating a large transparent window over the game. This may prevent the game from receiving mouse input from the 'real' Windows cursor. It is sometimes useful to disable this while testing.
Game.DrawFakeMouseCursor = true;
// Once you have finished setting up the input options, enable this to automatically lock input (equivalent to pressing End) once all of the instances have been set up.
// This is usually convenient to leave disabled whilst testing.
Game.LockInputAtStart = false;
// If you need to change the key to toggle input lock, e.g. if the game uses the End key, edit it with this.
// You can find a list of keys and their numbers at https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes
Game.LockInputToggleKey = 0x23;

//		[Handlers]

//The interval in milliseconds the Handler should be updated at. Set it to 0 to disable updating (will lose all functionality that depends on ticks).
Game.HandlerInterval = 100;
//Pause between game intances starts in milliseconds.
Game.PauseBetweenStarts = 30;

//		[Launch Parameters]

//Use the built-in Goldberg features in Nucleus. Goldberg is used for: Redirect to LAN Network SteamWorks games that doesn't support LAN, make the game unseen from Steam and other fantastic features! https://gitlab.com/Mr_Goldberg/goldberg_emulator | default: false
Game.UseGoldberg = false;
//Some older games require a steam_interfaces.txt file for Goldberg to work | Will first search orig game path and nucleus games path, if not found then tries to create one with the GoldbergNeedSteamInterface command
Game.GoldbergNeedSteamInterface = false;
//If the game needs a fake Steam wrapper (SSE) to run multiple instances (this is not needed if you are using the new use Goldberg emulator line).
Game.NeedsSteamEmulation = false;
//Sets the overall priority category for the associated process. Can be "AboveNormal", "High" or "RealTime" | default: "Normal"
Game.ProcessorPriorityClass = "High";
//Nucleus will show a prompt between each instances for let you decide when start the next one.
Game.PromptBetweenInstances = true;
//After each new instance opens, resize, reposition and remove borders of the previous instance
Game.ResetWindows = true;

// This is the text that will be shown inside the box "Script Author's Notes" in the Nucleus UI.
Game.Description =
  ' Start a server on the first instance. When you are in, start the next one. If you are using keyboards/mice, when all instances are open and you already clicked "ok" on the last Nucleus prompt, press END for restrict the input. For release it, press END again. For change map, you must start a new server on the first instance. For quick join, alt+tab on other instances and press "F8". For pause the server press "F7" (Usually first keyboard must be clicked/alt-tabbed for make it work.)';

// Inside "Game.Play = function()" you can write operations that Nucleus will do in context of game starting.
Game.Play = function() {
  /*In this script, Nucleus will use launch arguments for setup some settings and the instance resoultion in context of what the user chosen in screens sizes selector on the Nuclues UI.
  Then Nucleus will create autoexec.cfg files for setup different settings in context of the device input used in each instance and at the end push the connect command (with Local IP) from the second instance and next ones.*/

  //The configuration of multi keyboards/mice must have FakeFocus turned on. HookMouseVisibility = true; could make the game crash.
  if (Player.IsKeyboardPlayer) {
    Game.FakeFocus = true;
    // Used for games that toggle the mouse visibility, e.g. hidden in first person movement and visible in menus.
    // This shows/hides the fake mouse cursor when the game tries to show/hide the 'real' mouse cursor.
    Game.HookMouseVisibility = true;
  } else {
    Game.FakeFocus = false;
    Game.HookMouseVisibility = false;
  }

  //This line will copy the file "motd_default.txt" inside Nucleus\content\TeamFortress2Classic\Instance#\tf\cfg from Nucleus\scripts\Team Fortress 2 Classic(the folder inside script must be named like the game .js file.)
  var savePath = (Context.SavePath = Context.GetFolder(Nucleus.Folder.InstancedGameFolder) + "\\tf2classic\\cfg\\motd_default.txt");
  var savePkgOrigin = System.IO.Path.Combine(Game.Folder, "motd_default.txt");
  System.IO.File.Copy(savePkgOrigin, savePath, true);

  var savePath = (Context.SavePath = Context.GetFolder(Nucleus.Folder.InstancedGameFolder) + "\\tf2classic\\cfg\\motd_text_default.txt");
  var savePkgOrigin = System.IO.Path.Combine(Game.Folder, "motd_text_default.txt");
  System.IO.File.Copy(savePkgOrigin, savePath, true);

  /*This line will create a variable from the corresponding Nucleus option.
For example, this one will use the word "Fps" inside "Game.AddOption("Which FPS Cap the game will use?", '', "Fps", answers);" for
define the variable "fps" as the answer that the user chosen on this option. So, if the user choose "60", the var "fps" will be defined as "60". */
  var fps = Context.Options["Fps"];

  /*This two lines, will add launch options.	
	For example, source games use "-w" and "-h" as start arguments for set Width and Height of the game resolution. You can find commands and if a determinate game-engine/game can use launch parameters on Google.
	We are gonna use Context.Width and Context.Height for let Nucleus write the Width and Height chosen by the User inside the Nucleus UI. You can find other context values inside the Mod-ReadMe.txt.*/
  var Args = (Context.Args =
    " -game tf2classic -novid -windowed -AlwaysFocus -insecure -console -w " + Context.Width + " -h " + Context.Height + " +sv_cheats 1 +exec autoexec.cfg +host_writeconfig +fps_max " + fps);
  Context.StartArguments = Args;

  //Creating the autoexec.cfg files for each instance and push lines in context of the input device used and the player number.

  // Creating the base autoexec.cfg file that all instance will use
  // These lines will define a variable "autoExec" that will create a file inside Nucleus\content\TeamFortress2Classic\Instance#\tf2classic\cfg with the lines specified inside "var lines".
  var autoExec = Context.GetFolder(Nucleus.Folder.InstancedGameFolder) + "\\tf2classic\\cfg\\autoexec.cfg"; //create an autoexec.cfg file
  var lines = [
    "engine_no_focus_sleep 0", // unlimited FPS on all screens when without focus (!!don't edit!!) // <------------------------------------------- ADD HERE AUTOEXEC COMMANDS OR SERVER SETTINGS
    "cl_hud_minmode 1", //minimal hud
    "sv_lan 1", //LAN server (!!don't edit!!)
    "sv_pausable 1",
    "maxplayers 32",
    "mp_idledealmethod 0", //afk mode kick (0=disabled)
    "mp_idlemaxtime 0", //max time that you can stay afk (0=disabled)
    "mp_showrespawntimes 5" //set the respawn wave time (default is 10)
    //"mp_disable_respawn_times", //instant respawn
  ];
  Context.WriteTextFile(autoExec, lines);

  //This IF will be "used" if the current instance has a player that use the Keyboard
  if (Player.IsKeyboardPlayer) {
    lines.push("m_rawinput 1");
    lines.push("joystick 0");
    lines.push("exec undo360controller.cfg");
    lines.push("bind F7 pause");
    lines.push('bind "F8" "connect ' + Context.LocalIP + '"');
    lines.push("host_writeconfig");
    Context.WriteTextFile(autoExec, lines);
  }
  //while other inputs (controllers)
  else {
    lines.push("m_rawinput 0");
    lines.push("joystick 1");
    lines.push("exec 360controller.cfg");
    lines.push("bind F7 pause");
    lines.push('bind "F8" "connect ' + Context.LocalIP + '"');
    lines.push("host_writeconfig");
    Context.WriteTextFile(autoExec, lines);

    /*These lines will define a variable "txtPath" that will edit a file with the lines specified inside "var dict".
  We can also specify the specific number of the line we need to edit.*/
    var txtPath = Context.GetFolder(Nucleus.Folder.InstancedGameFolder) + "\\tf2classic\\cfg\\360controller.cfg"; //Editing a specific file by manually selecting the line and manually edit the text
    var dict = ['49|bind "JOY9" "toggle_duck"			// Left Stick Down'];
    Context.ReplaceLinesInTextFile(txtPath, dict);
  }

  //These lines will make the first player start normally while the other ones will connect to the local IP at the startup.

  //This IF will be "used" if the instance is the first player
  if (Context.PlayerID == 0) {
  }

  //Here what happens if the instance is a different player from the first one
  else {
    //Context.LocalIP will return the User local IP for let the Source-Engine command "connect"
    lines.push("connect " + Context.LocalIP); //adding line on the autoexec file (var autoExec)
  }

  Context.WriteTextFile(autoExec, lines);
};