Skip to content

INSTALL.md

Latest commit

 

History

History
92 lines (60 loc) · 3.65 KB

INSTALL.md

File metadata and controls

92 lines (60 loc) · 3.65 KB
Raw

Requirements

  • Sourcemod 1.12 or better
  • Metamod: Source 1.12 or better

Downloading

Development Builds

The latest dev builds of NavBot are available as workflow artifacts. Check the Actions page.
These will contain the latest features and bug fixes.

Stable Builds

Stable builds are pushed to the Releases page.

Choosing The Right Version.

Currently, NavBot is compiled against both Stable and Dev SourceMod.
You need to download the version compiled against the SM version you're running on your server otherwise the extension won't load.
The naming convention for NavBot build is:
navbot-[operating system]-[sourcemod branch]-[version]

Installing

Copy the extension files (extension, plugins, gamedata, data, translations and config) files into your sourcemod install directory.
Generally it's <game root>/addons/sourcemod/.

Setting Up A Listen Server

A listen server is required if you intent on editing the navigation mesh or wants to use the built-in debug commands.
The basic installation of Metamod and Sourcemod is the same for a listen server.
To run the game with MM and SM, you need to launch the game in insecure mode by adding -insecure to the launch parameters.

Windows Listen Server

I recommend creating a batch script to run the game instead of modifying the Steam launch options for the game.
Create a .bat file on the same folder where the .exe of the game is, then add the following:

start <exe> -steam -game <game folder> -console -insecure -dev -condebug
  • : Replace with the game's launcher executable.
  • : Replace with the game's game folder name.

Example for Team Fortress 2:

start tf_win64.exe -steam -game tf -console -insecure -dev -condebug

Save the file and double click it to launch the game, Steam needs to be running.
The game will run in insecure and developer mode.
Note: You need to load a map before checking if SM and MM:S is installed and working correctly.
If you need help with installing on a Listen Server, join my discord server linked on the main README file.

Linux Listen Server

There are two methods for setting up NavBot on a Linux listen server.

Proton

The first method is the most simple one. Use proton to run the Windows version. Sourcemod runs without issues and you won't have to deal with broken gamedata due to missing debug symbols on the binaries.

Native

The second method requires creating a few symbolic links.
Metamod and Sourcemod is hardcoded to look for binaries with debug symbols and Valve does not ship these binaries for the game client.
Open the <game>/bin/linux32|linux64 folder (the folder where engine.so is), you're going to create a symbolic link containing the _srv suffix for the following files:

  • engine.so
  • libtier0.so
  • libvstdlib.so

Example: ln -s engine.so engine_srv.so
Notes: Some games may need additional binaries. The binaries listed above are for TF2 engine games.
The same needs to be done for the game's server binary.
Go to <game>/<mod folder>/bin/ (the folder where server.so is). Create a symbolic link to with the _srv suffix for the server binary.
More notes:

  • Exact file location may change depending if the game/mod has x64 support or not.
  • On x64, Metamod: Source 2.0.x build 1375 or greater is required for correct engine detection.

Additional Plugins

NavBot can be extended by plugins. See the official addon plugins.