---
title: "Spawner"
canonical: "https://documentation.chaos.com/space/ARENA/124622602/Spawner"
format: markdown
---
This page provides information about the command-line application, or spawner, of Chaos Arena. 

## **Overview**

---

<span style="color: #000000">The spawner is a </span><span style="color: #000000">**command-line application**</span><span style="color: #000000"> that can be started from either Windows Explorer or from a Windows Command Prompt. Alternatively, you can run the spawner via a batch script (*.bat). </span>

<span style="color: #000000">Go to "</span><span style="color: #000000">***..\Chaos_Arena\arena_server\***</span><span style="color: #000000">" and double-click on </span><span style="color: #000000">**"arena_spawner.exe"**</span><span style="color: #000000">. </span>

<span style="color: #000000">It provides you with useful information about:</span>

- <span style="color: #000000">The </span><span style="color: #000000">**IP**</span><span style="color: #000000"> address of the machine on which it is running (for example, </span><span style="color: #000000">*10.0.0.106 *</span><span style="color: #000000">);</span>
- <span style="color: #000000">The network interfaces available on the machine (for example, </span><span style="color: #000000">*"Ethernet 2"*</span><span style="color: #000000"> and </span><span style="color: #000000">*"Loopback Pseudo-interface 1"*</span><span style="color: #000000">);</span>
- <span style="color: #000000">The "</span><span style="color: #000000">**Broadcast**</span><span style="color: #000000">" address, which you might need for configuring Arena Server (to look for Operator and Render Nodes) on the respective network, in case you use the </span><span style="color: #000000">[Server Auto Discovery](https://docs.chaos.com/display/ARENA/Global+Options#GlobalOptions-ServerAuto-Discovery)</span><span style="color: #000000"> option;</span>
- <span style="color: #000000">The port on which the spawner is listening ( 20711 by default );</span>
- <span style="color: #000000">Example commands for running the spawner.</span>

<span style="color: #000000">The spawner can be started before or after the server. It acts like a </span><span style="color: #000000">**service **</span><span style="color: #000000">that can be started once and left running indefinitely until the current user is logged off or Windows is restarted.</span>


## **Windows Command Line options**

---

<span style="color: #000000">In case "</span><span style="color: #000000">**arena_spawner.exe**</span><span style="color: #000000">" is started from the </span><span style="color: #000000">**Windows Command Line,**</span><span style="color: #000000"> or through a batch file, there are a few command-line options that have to be passed to the spawner on each machine:</span>

**-server**<span style="color: #000000"> </span><span style="color: #000000">*host[:port] [optional] *</span><span style="color: #000000">- specifies the server address with an optional port. The default port is 20710. If the </span><span style="color: #000000">[Server Auto Discovery](https://docs.chaos.com/display/ARENA/Global+Options#GlobalOptions-ServerAuto-Discovery)</span><span style="color: #000000"> is set, the spawners don't need to specify the server address; they can listen for the auto-discovery broadcast messages from the server and automatically determine its IP address.</span>

<span style="color: #000000">-</span><span style="color: #000000">**id **</span><span style="color: #000000">*id [optional] *</span><span style="color: #000000">- the string ID of the spawner and the render instance. It must be a non-empty string, and it must match the one in the server configuration. If this parameter is not provided, the spawner will be assigned an automatic ID containing the spawner IP address, as seen from the server when the spawner connects.</span>

<span style="color: #000000">-</span><span style="color: #000000">**vantage **</span><span style="color: #000000">*path_to_exe*</span><span style="color: #000000"> - path to the installed Arena renderer (vantage.exe).</span>


<span style="color: #000000">Here is an example</span><span style="color: #000000">** **</span><span style="color: #000000">command line for running the spawner with ID “center” and a server running on IP address 10.0.0.5 (assuming that your "Chaos_Arena" folder structure is located in the root of drive "C:\")</span>

```
arena_spawner.exe -id center -server 10.0.0.5 -vantage C:\Chaos_Arena\arena_renderer\vantage.exe
```

Optionally, you can set up a script or a configuration file for easy startup of the spawner with the server IP (or auto-discovery), renderer ID, and the path to the installed renderer (vantage.exe).

##   
**Using Configuration Files for Spawners**

---

<span style="color: #000000">A sample configuration file (“</span><span style="color: #000000">**arena_spawner.json.template**</span><span style="color: #000000">”) can be found in the </span><span style="color: #000000">**arena_server**</span><span style="color: #000000"> folder. </span>

<span style="color: #000000">To use this option, make a copy of the file and rename it to </span><span style="color: #000000">**"arena_spawner.json"**</span><span style="color: #000000"> (remove the </span><span style="color: #000000">**" .template"**</span><span style="color: #000000"> extension). In this case, the configuration file will be used automatically when the </span><span style="color: #000000">**arena_spawner.exe**</span><span style="color: #000000"> is started.</span>

## **Starting the Spawners**

---

<span style="color: #000000">Open Windows Command Prompt and start </span><span style="color: #000000">**Chaos_Arena\arena_server\arena_spawner.exe**</span><span style="color: #000000"> on each </span><span style="color: #000000">**Render**</span><span style="color: #000000"> and </span><span style="color: #000000">**Operator**</span><span style="color: #000000"> machine. </span>  
  
<span style="color: #000000">When the process starts, you will see the </span><span style="color: #000000">**Broadcast Subnet address**</span><span style="color: #000000"> in the printed messages, write it down as later it will be used for the </span><span style="color: #000000">[Server configuration](https://docs-chaos.atlassian.net/wiki/spaces/ARENA/pages/125143783)</span><span style="color: #000000">.</span>