>> GameMode Reference <<

[Rotondo]

What are Game Modes?

   Game Modes are a way to package and distrubute your mods in a more user friendly fashion.
   
   You also gain more control over your mod, you can set things exactly how you need them. Which makes it easier for both you and the user who wants to run it.
   
   This post will give you a general idea on how to get a gamemode running.

Required Files

• colorSet.txt
• description.txt
• gamemode.txt
• save.bls
• preview.jpg
• thumb.jpg

Note: If any required files are missing the gamemode will not run and you will be notified of what's missing.

Game Modes can also contain normal Add-On files such as

• client.cs
• server.cs
• models
• sounds
• etc

Making a gamemode

• Naming the Game Mode
     
     The folder should named in this fashion, GameMode_Example
     
     This gamemode would show up as "Example" on the select gamemode menu.
  
     A gamemode entitled, GameMode_Flying_Pig_DM , would show up as "Flying Pig DM".
     
• Enabling Add-Ons
  
     To enable Add-Ons for gamemodes you have to add them to the gamemode.txt file.
     
     If you wanted to add the rocket launcher for example, you would do this.
     
     ADDON Weapon_Rocket_Launcher
     
     Remember if your gamemode also contains server scripts, you have to include it as well.
     
     ADDON GameMode_Example
     
• Enabling Music
     
     Enabling music is done in a similar way to Add-Ons.
     
     If you wanted to enable After School Special for use in your mode, you would do this.
     
     MUSIC After_School_Special
     
• Changing Environment settings
  
     To change the environment you must edit the $EnvGuiServer variables.
  
     In simple mode you can use preset add-ons like, Sky_Sunset, and Ground_Plate to set the tone of things.
     
     $EnvGuiServer::SimpleMode 1
     $EnvGuiServer::SkyFile Add-Ons/Sky_Sunset/Sunset.dml
     $EnvGuiServer::WaterFile NONE
     $EnvGuiServer::GroundFile Add-Ons/Ground_Plate/plate.ground
     
     If you wish to do more you can refer to the list of variables here.
     
     Also read the tip relating to the saveEnvironment command, to make things easier for you.
     
• Changing Minigame settings
  
     All of the normal minigame options are available to change
  
     Adding this
     
     $MiniGame::Enabled 1
     
     will add a default minigame to your gamemode
     
     All the MiniGame variables you can change are located here.
     
• Changing Server settings
  
     Changing the server settings is done in the same way as minigames & environments.
     
     $Server::WelcomeMessage \c2Welcome to Splosion mode %1!
     
     Here \c2 is used for coloring the message, %1 is the players name.
     
     All server variable options are at the bottom of this post, here.
     
• Preview Image
  
     All gamemodes require a preview image.
  
     All preview images must be jpeg.
     
     preview.jpg should be 256x256
     
     thumb.jpg should be 64x64
     
     Try to capture the feeling of your mode in the preview.
     
• Packaging the GameMode
     
     Packaging a gamemode is done the same way as normal Add-On.
     
     Take all the required files and put them in a zip file.
  
     Do not put other Add-On zip files into your gamemode, things don't work this way.
     
     All gamemodes must have the prefix GameMode_
     

Tips

• $DefaultMiniGame - If you ever need to access the minigame through script, you can just get it through this variable.
• $DefaultMiniGame.reset( 0 ) - For resetting the minigame, since the default minigame has no client.
• serverDirectSaveFileLoad(%fileName, 3, "", %ownership) - For loading bricks in scripts, %fileName is where your save is, %ownership can be 0 for load as host, or 2 load as public
• saveEnvironment( %fileName ) - This will save your current environment settings to a text file, has to be in a folder.
  Example: saveEnvironment( "config/mySettings.txt" );
   
• Can also be used in custom games - Gamemodes can also be used in custom games if you want them to be.
• $GameModeArg - Used to detect what gamemode is running. You can use this to make sure your gamemode scripts only run when you want them to.
     
        Example : At the top of server.cs
  
           if( $GameModeArg !$= "Add-Ons/GameMode_Example/gamemode.txt" )
           {
              error( "Error: GameMode_Example cannot be used in custom games!" );
              return;
           }
   
• MiniGameSO::onAdd( %minigame ) - If you need to access the minigame right as the server starts you can package this.

Example Game Mode
   
   This is a simple example gamemode using the Blupo save, Rocket Launchers, and Fuel Jet Player type.

   Download

   

[Ad Bot]

[Rotondo]

Variable	Type	Example | Min : Max
// environment variables
$EnvGuiServer::SimpleMode	bool	0 : 1
$EnvGuiServer::Skyfile	file	Add-Ons/Sky_Skylands/Skylands.dml
$EnvGuiServer::Waterfile	file	Add-Ons/Water_Default/default.water or NONE
$EnvGuiServer::Groundfile	file	Add-Ons/Ground_Plate/plate.ground
$EnvGuiServer::SunFlareTopTexture	file	base/lighting/corona.png
$EnvGuiServer::SunFlareBottomTexture	file	base/lighting/corona.png
$EnvGuiServer::DayOffset	float	0.0 : 1.0
$EnvGuiServer::DayLength	integer	0 : 86400
$EnvGuiServer::DayCycleEnabled	bool	0 : 1
$EnvGuiServer::DayCycle	file	Add-Ons/DayCycle_Default/default.daycycle
$EnvGuiServer::Sunational socialistmuth	float	-360.0 : 360.0
$EnvGuiServer::SunElevation	float	-360.0 : 360.0
$EnvGuiServer::DirectLightColor	color	0.968628 0.835294 0.796079 1.000000
$EnvGuiServer::AmbientLightColor	color	0.600000 0.500000 0.400000 1.000000
$EnvGuiServer::ShadowColor	color	0.525490 0.560784 0.682353 1.000000
$EnvGuiServer::SunFlareColor	color	0.100000 0.100000 0.100000 1.000000
$EnvGuiServer::SunFlareSize	float	0.0 : 5.0
$EnvGuiServer::VisibleDistance	float	20.0 : 1000.0
$EnvGuiServer::FogDistance	float	0.0 : 1000.0
$EnvGuiServer::FogColor	color	0.580000 0.680000 0.940000 1.000000
$EnvGuiServer::WaterColor	color	255 255 255 128
$EnvGuiServer::WaterHeight	float	1.0 : 1000.0
$EnvGuiServer::UnderWaterColor	color	51 153 153 77
$EnvGuiServer::SkyColor	color	1.0 1.0 1.0 1.0
$EnvGuiServer::WaterScrollX	float	-10.0 : 10.0
$EnvGuiServer::WaterScrollY	float	-10.0 : 10.0
$EnvGuiServer::GroundColor	color	0 128 64 255
$EnvGuiServer::GroundScrollX	float	-10.0 : 10.0
$EnvGuiServer::GroundScrollY	float	-10.0 : 10.0
$EnvGuiServer::VignetteMultiply	bool	0 : 1
$EnvGuiServer::VignetteColor	color	0.000000 0.000000 0.000000 0.392157
// minigame variables
$MiniGame::Enabled	bool	0 : 1
$MiniGame::GameColor	integer	0 : 9
$MiniGame::InviteOnly	bool	0 : 1
$MiniGame::IncludeAllPlayersBricks	bool	0 : 1
$MiniGame::PlayersUseOwnBricks	bool	0 : 1
$MiniGame::Points_BreakBrick	integer	-9999 : 9999
$MiniGame::Points_PlantBrick	integer	-9999 : 9999
$MiniGame::Points_KillPlayer	integer	-9999 : 9999
$MiniGame::Points_KillSelf	integer	-9999 : 9999
$MiniGame::Points_Die	integer	-9999 : 9999
$MiniGame::RespawnTime	seconds	0 : 300
$MiniGame::VehicleRespawnTime	seconds	0 : 300
$MiniGame::BrickRespawnTime	seconds	0 : 300
$MiniGame::UseSpawnBricks	bool	0 : 1
$MiniGame::FallingDamage	bool	0 : 1
$MiniGame::WeaponDamage	bool	0 : 1
$MiniGame::SelfDamage	bool	0 : 1
$MiniGame::VehicleDamage	bool	0 : 1
$MiniGame::BrickDamage	bool	0 : 1
$MiniGame::EnableWand	bool	0 : 1
$MiniGame::EnableBuilding	bool	0 : 1
$MiniGame::EnablePainting	bool	0 : 1
// These go by ui name, 0 for none
$MiniGame::PlayerDataBlockName	string/ui name	No-Jet Player
$MiniGame::StartEquipName0	string/ui name	Sword
$MiniGame::StartEquipName1	string/ui name	0
$MiniGame::StartEquipName2	string/ui name	0
$MiniGame::StartEquipName3	string/ui name	0
$MiniGame::StartEquipName4	string/ui name	0
//server config
$Server::BrickRespawnTime	integer	1000 : 300000
$Server::ClearEventsOnClientExit	bool	0 : 1
$Server::MaxBricksPerSecond	integer	1 : 1000
$Server::MaxPhysVehicles_Total	integer	0 : 20
$Server::MaxPlayerVehicles_Total	integer	0 : 200
$Server::Quota::Environment	integer	20 : 5000
$Server::Quota::Item	integer	5 : 100
$Server::Quota::Misc	integer	10 : 9999
$Server::Quota::Player	integer	0 : 100
$Server::Quota::Projectile	integer	5 : 200
$Server::Quota::Schedules	integer	10 : 1000
$Server::Quota::Vehicle	integer	0 : 100
$Server::QuotaLAN::Environment	integer	20 : 5000
$Server::QuotaLAN::Item	integer	5 : 100
$Server::QuotaLAN::Misc	integer	10 : 9999
$Server::QuotaLAN::Player	integer	0 : 100
$Server::QuotaLAN::Projectile	integer	5 : 200
$Server::QuotaLAN::Schedules	integer	10 : 1000
$Server::QuotaLAN::Vehicle	integer	0 : 100
$Server::WelcomeMessage	string	Welcome to the server!
$Server::WrenchEventsAdminOnly	bool	0 : 1
$GameMode::BrickOwnership	string	Host : SavedOwner *if not set will default to public

[Nobot]

Woah this new system seems cool.

[Mr.Noßody]

Well, damn.

Sounds neat.

[Lugnut]

You guys are loving awesome.

serverDirectSaveFileLoad(%fileName, 3, "", %ownership) - For loading bricks in scripts, %fileName is where your save is, %ownership can be 0 for load as host, or 2 load as public

Does this mean, when loaded as ownership 2, anyone can build on the bricks? What about destroying them?

What if you put a 1 there?

[LOL :D]

my god this is cool

[Rotondo]

1 is load original ownership, which mostly won't be used in scripts.

[Greek2me]

It looks like I have some work to do. Nice update.

Does this also mean that saves can be loaded without a client in a non-hacky way?

[Crøwn]

this is awesome.

[DontCare4Free]

It looks like I have some work to do. Nice update.

Does this also mean that saves can be loaded without a client in a non-hacky way?

Seems like it.

[Rotondo]

Does this also mean that saves can be loaded without a client in a non-hacky way?

Yes.

[Awdax]

So I'm looking through the files to see what's new and I see Gamemode_zombie. Then I remembered that's just a third-party Add-On. It seems all the other gamemodes are titles similarly. Did you always know it was going to be like this, and is this the update you were waiting for to update Left 4 Block?

Sorry if this is off-topic but it seems relevant. Just delete this if not.

[TheABELBOTO]

Is it possible to make a vote gamemode command/mod?
like the same they use for the tf2 servers where you can nominate for a new game, and if it gets enough votes, It'll change to said gamemode, since you now can load game modes with a build, this should be possible

[DontCare4Free]

Is it possible to make a vote gamemode command/mod?
like the same they use for the tf2 servers where you can nominate for a new game, and if it gets enough votes, It'll change to said gamemode, since you now can load game modes with a build, this should be possible

Should be, if nothing else then it should be possible to set up a fake connection to send the servercmds as.

[TheABELBOTO]

Should be, if nothing else then it should be possible to set up a fake connection to send the servercmds as.

Cool, so now I can make a minigame server