Difference between revisions of "Database"

From ALiVE Wiki
Jump to: navigation, search
 
(11 intermediate revisions by one user not shown)
Line 4: Line 4:
  
 
==How It Works==
 
==How It Works==
 +
[[File:sys_data.png|600px|right]]
 +
The data module will automatically record game statistics as they happen. Player stats and mission events are also recorded to help groups and players track and review their performance. Parameters in this module can be set to disable statistics, After Action Reviews and/or performance data.
  
−
[[File:sys_data.png|600px|right]]Place this module and ALiVE will automatically record game statistics as they happen to the ALiVEmod.com website. Player stats and mission events are also recorded to help groups and players track and review their performance. Parameters in this module can be set to disable statistics, After Action Reviews and/or performance data. You will need to register on ALiVEmod.com for this feature to work.
 
  
−
 
+
''Usage'':  set up a free [[War Room]] account and make sure the server is running @aliveserver. Place the ALiVE Database module in the editor.
−
''Usage'':  Place the Database module and statistics will be automatically enabled. To disable statistics change the parameter on the Database module. Alternatively you can use the ALiVE Admin Command menu in game.
+
  
  
 +
''Module Options'':
 
*Enable Debug - Recommended for loading/saving bug reporting. Will dump errors and information to logs
 
*Enable Debug - Recommended for loading/saving bug reporting. Will dump errors and information to logs
 
*Database Source - Cloud saves mission persistence data to War Room.  Local saves mission persistence data to the host machine.
 
*Database Source - Cloud saves mission persistence data to War Room.  Local saves mission persistence data to the host machine.
 
*Save Mission Time - On server restart you will start at the time of day where you finished
 
*Save Mission Time - On server restart you will start at the time of day where you finished
−
*Disable Stats - Stops event reporting to War Room
+
*Disable Stats - Stops events reporting to War Room
 
*Disable AAR - Stops player movement recording to the Operations Page on War Room
 
*Disable AAR - Stops player movement recording to the Operations Page on War Room
 
*Disable PerfMon - Stops reporting Arma specific performance metrics to War Room server admin page
 
*Disable PerfMon - Stops reporting Arma specific performance metrics to War Room server admin page
Line 22: Line 23:
  
 
==Auto Enable (Optional)==
 
==Auto Enable (Optional)==
−
 
 
There are two optional pbo's included with the ALiVE download. Move them to @ALiVE/addons to auto-enable data and performance monitoring on all missions, regardless of whether the ALiVE modules are placed in the editor.
 
There are two optional pbo's included with the ALiVE download. Move them to @ALiVE/addons to auto-enable data and performance monitoring on all missions, regardless of whether the ALiVE modules are placed in the editor.
  
−
==Example RPT==
 
  
−
To see an example of a mission that is successfully loaded and saved see [http://alivemod.com/wiki/index.php/Database/Example_RPT here]
+
==Notes==
−
 
+
To benefit from War Room stats and cloud persistence, you need to register on alivemod.com then register a group and server in order to download the @ALIVEServer module. Instructions are on the server registration page.  Note that if you are using a 'local dedi', you will need to check that your IP address is the same for each new session.
−
==Example Test==
+
−
 
+
−
#Setup your server on ALiVE War Room (follow the instructions), ensure your servers public IP is registered on War Room etc.
+
−
#In your server.cfg include persistent=1;
+
−
#Start your Dedicated server with the following mod params -mod=@CBA_A3;@aliveserver;@ALiVE; etc
+
−
#Start your Arma 3 client with the following mod params -mod=@CBA_A3;@ALiVE; etc
+
−
#Main Menu > Multiplayer > select your dedicated server > JOIN
+
−
#/ #login yourpassword
+
−
#Maps > Stratis
+
−
#Missions > ALIVE | Quick Start (COOP 9)
+
−
#CONTINUE
+
−
#Select a slot (Squad Leader)
+
−
#OK
+
−
#When the map loads, if you have successfully saved a mission before with SPOTREPS, PATROLREPS, SITREPS or markers, they should be displayed on the map. The map diary should also include entries relating to the reports.
+
−
#CONTINUE
+
−
#A hint to the right hand side should appear stating your web profile has been loaded, if not persistence has failed.
+
−
#If you have saved a previous mission, then you should be restored to your last location with your last loadout.
+
−
 
+
−
==Editor Notes==
+
−
 
+
−
Cloud persistence only works on Dedicated Servers.  You can set up a 'local dedicated' server on your own machine or simply use the 'Local' option.
+
−
 
+
−
To benefit from War Room stats and cloud persistence, you need to register on alivemod.com, then register a group and server in order to download the @ALIVEServer module. Instructions are on the server registration page.  Note that if you are using a 'local dedi', you will need to check that your IP address is the same for each new session.
+
  
 
It is recommended that you prefix all your mission names with a unique identifier so they’re easy to spot in the stats list!
 
It is recommended that you prefix all your mission names with a unique identifier so they’re easy to spot in the stats list!
−
 
−
 
−
==Persistence Script Commands==
 
−
 
−
You can save and retrieve custom values to the ALiVE database using the following funcs.  These functions need to be run SERVER side and @AliveServer needs to be installed and running.
 
−
 
−
<syntaxhighlight lang="php">
 
−
["My Custom Variable", _value] call ALiVE_fnc_setData
 
−
_value = ["My Custom Variable"] call ALiVE_fnc_getData
 
−
</syntaxhighlight>
 
−
 
−
We recommend that you save no more than 10KB worth of data in TOTAL for your custom variables. If you have extensive persistence needs, then please let us know.
 
−
 
−
 
−
Clearing data from the ProfileNameSpace when running Local persistence:
 
−
call ALiVE_fnc_ProfileNameSpaceClear:  clears data for the current mission only. Note that renaming the mission pbo will also start a fresh instance.
 
−
call ALiVE_fnc_ProfileNameSpaceWipe:  clears all ALiVE data from ProfileNameSpace completely.
 
−
 
−
 
−
Autosave can be scripted in using Local persistence only (not available with Cloud).  The server may lag/desync for a few seconds while saving takes place:
 
−
900 call ALiVE_fnc_AutoSave_PNS where 900 is the save interval in seconds
 
−
-1 call ALiVE_fnc_AutoSave_PNS run at any time will disable autosave
 
  
  
 
[[Category:ALiVE Modules]] [[Category:War Room]]
 
[[Category:ALiVE Modules]] [[Category:War Room]]

Latest revision as of 06:17, 16 June 2017

Icon sys data.png ALiVE Data

The ALIVE Data module enables mission data and player stats to be recorded on the War Room at www.alivemod.com. ALiVE will automatically send data to the database as events occur in game. This includes player kills, deaths, use of vehicles, injuries, contacts with enemy units, heals, completion of objectives and much more. The powerful After Action Review feature allows players to playback events from the mission as they happened.

How It Works

Sys data.png

The data module will automatically record game statistics as they happen. Player stats and mission events are also recorded to help groups and players track and review their performance. Parameters in this module can be set to disable statistics, After Action Reviews and/or performance data.


Usage: set up a free War Room account and make sure the server is running @aliveserver. Place the ALiVE Database module in the editor.


Module Options:

  • Enable Debug - Recommended for loading/saving bug reporting. Will dump errors and information to logs
  • Database Source - Cloud saves mission persistence data to War Room. Local saves mission persistence data to the host machine.
  • Save Mission Time - On server restart you will start at the time of day where you finished
  • Disable Stats - Stops events reporting to War Room
  • Disable AAR - Stops player movement recording to the Operations Page on War Room
  • Disable PerfMon - Stops reporting Arma specific performance metrics to War Room server admin page
  • Disable OS PerfMon - Stops reporting server OS specific performance metrics to War Room server admin page
  • Custom Perf Monitors - Customize objects counted and intervals. Ensure interval values are in ascending order. 'triggers' will count allMissionObjects "EmptyDetector", 'entities' will count entities "All", 'objects' will count allMissionObjects "All". Any thing else will be count YOURPARAM i.e. count allDead.


Auto Enable (Optional)

There are two optional pbo's included with the ALiVE download. Move them to @ALiVE/addons to auto-enable data and performance monitoring on all missions, regardless of whether the ALiVE modules are placed in the editor.


Notes

To benefit from War Room stats and cloud persistence, you need to register on alivemod.com then register a group and server in order to download the @ALIVEServer module. Instructions are on the server registration page. Note that if you are using a 'local dedi', you will need to check that your IP address is the same for each new session.

It is recommended that you prefix all your mission names with a unique identifier so they’re easy to spot in the stats list!

Retrieved from ‘http://alivemod.com/wiki/index.php?title=Database&oldid=2462’