APX orchestrator

Stop debugging, start racing.

User Tools

Site Tools


tutorials

Tutorials

Create a server

  1. Log in into APX.
  2. Click “servers” on the left side
  3. Choose “create server from scratch” at the top
  4. Wait until the status is “Ready for usage. Key was collected on try X”
  5. Optional: You can adapt the name at any time. The server content will only update if a suitable action is selected

If this does not work see: Troubleshooting

General remarks

Follow this workflow when creating an event:

  1. Optional: Add mods missing to APX
  2. Create the sessions
  3. Create the weekend
  4. Create the liveries (if needed)
  5. Create event
  6. Use the event in a server

Optional: Add a new mod to APX

If a track or car is not present in APX, you can add them. To do this, you need to have your instance not running in the EASY_MODE. To disable that, close the wizard app, open the file “settings.py” in the folder “wizard” and set EASY_MODE = True to EASY_MODE = False. Then restart the wizard. You will now have a section components, we will use for that.

  1. Select “components”
  2. Select “add new component”
  3. Name the type. You can choose between Vehicle or track
  4. Add the Steam workshop ID
  5. You can leave base component empty
  6. Name the component name. This is the folder name inside Installed/<Type>
  7. Give the mod a short name (it will be used for livery creation to have <shortname>_<number> in the file names. Keep that value short)
  8. If the mod has an encrypted base mod and an update, check “is official”

Tracks only: Add layouts

  1. Select “tracks”
  2. Select “add new track”
  3. Select the component (step 1)
  4. Name your layout (step 2). Repeat for all layouts included. The names can be taken out of the game or the GDB file (value can be EventName, TrackName or VenueName)

Optional: The mod is based on another mod

You cannot add liveries on top of a mod based on a mod.

Example:

You have an livery pack for a single GT3 car.

To use that, add the livery pack in APX as it's own vehicle mod and name the GT3 mod as a base component (step 3).

In the event, select the updating mod pack (the livery pack) to the event as a “car”.

Optional: The mod I want to add is not based on steam

Create liveries

  1. Select liveries on the left
  2. Select add new livery
  3. Select the car the livery will be using
  4. Select the team name (avoid “#” and “:” for technical reasons)
  5. Add a number (can also be alphanumeric, such as “31x”
  6. Choose a base class (only needed if a base mod has several classes included, such as “Cup” or “GT4” for the Alpine 110 mod, upper- or lowercasing does not matter)
  7. Press “save”
  8. You will be redirected to the car list. You can search for your car and select the plus to upload files to this livery. Repeat this until all files are uploaded. If you click on the livery name (here “APX Test#51”), you can expand the list to include the filenames uploaded.

Your livery will be now usable in the next step to create an event.

If you need to import more files at once, you can use this: Import files into APX:

Race weekend

Sessions

First, you create the sessions.

The grip settings are either based on a provided grip file or you name a “grip needle”. A grip needle is a regular expression describing mod-provided filenames to be used. You can find more in-depth information here: https://wiki.apx.chmr.eu/doku.php?id=wizard_session#grip_needle_examples

The weekend

A race weekend is basically the setting of how your sessions will work together and how long they will be.

You cannot use the same type of a session multiple times. Use ingame server commands to use different race lenghts within a race day.

Create an event

An event is an reusable configuration about a track and car combination with a certain set of settings. You can use an event on multiple servers. Changes on an event will only applied to a server if you update the servers.

  1. Log in into APX
  2. Click “events” on the left side
  3. Choose “Add new event”

Possible settings of an event

Some settings will be missing in this table as they are self explanatory.

SettingDefaultDescription
Nameempty, but requiredThe Name of the event. Will be used as the name on the server in the server list
Mod nameempty, not requiredThe name of the mod inside rFactor 2
Mod versionempty, not requiredThe version of the mod inside rFactor 2
Event mod versionempty, not requiredWhen liveries are build, they need an additional version to make a difference for the game. APX will add a text behind the base version to identify the update. Example: Base mod is 1.41, so the update mod will get 1.41{Event mod version}
Liveries and CarsemptyThe fields cars and liveries exclude themselves. Cars is used if your mod will be using stock liveries, so APX only needs to know which car mod is used. If you are using custom liveries, you will select the added liveries instead
Dowstream and upstream0You will have to set these values to suit your network settings. Cannot be 0
Race weekendemptysee section race weekend

Add real weather

Sinc release 80 APX can inject real weather using the weather plugin by Stefan_L_01.

This will only work properly if the track GDB file has proper location data.

Keep your API request limits in mind!

  1. Check real weather
  2. Check your weather provider
  3. Add your key
  4. Add a temp offset (optional) which will be added to the temperature (if it's too cold)

Update the server

  1. Select the desired server
  2. select update as action (see differences on https://wiki.apx.chmr.eu/doku.php?id=force_builds)
  3. Save
  4. Grab a ☕

If this does not work see: Troubleshooting

Start the server

  1. Wait until the server acknowledges “deployment finished”
  2. Select the server from the server list
  3. select “start” as action
  4. Save

Stop the server

APX kills the server quite hard. To prevent information loss, the stopping process will invoke a “restart weekend” first to get the XML files written.

  1. Select the server from the server list
  2. select “stop” as action
  3. Save
tutorials.txt · Last modified: 2021/10/24 11:51 by chmr