Cumulus.ini (preserving history): Difference between revisions

m
Line 31: Line 31:
=== Cumulus MX ===
=== Cumulus MX ===
Don't rename the CumulusMX.exe file name as it must use that mixture of upper and lower case.  The main configuration file is always called ''Cumulus.ini'' (it must start with a capital 'C') and is located in the directory in which you installed CumulusMX.exe.  All the characters used within the configuration file must be within ASCII range.
Don't rename the CumulusMX.exe file name as it must use that mixture of upper and lower case.  The main configuration file is always called ''Cumulus.ini'' (it must start with a capital 'C') and is located in the directory in which you installed CumulusMX.exe.  All the characters used within the configuration file must be within ASCII range.
=== Cumulus 1 ===
As downloaded, the Cumulus 1 executable is called '''cumulus.exe''' and all in lowercase. If you renamed that executable file to say ''Cumulus1.exe'' it will still work, but the main configuration file then takes that name (i.e. ''Cumulus1.ini'') in the same folder lacking one section, although another configuration file will be created called ''Cumulus.ini'' in that folder, this second one will have the one missing section.  The default name "cumulus.exe" results in only one '''cumulus.ini''' (all lower case) in that folder, containing all sections.


  Additional configuration files, also called Cumulus.ini, can be created by Cumulus 1 to store the position of the main screen and the NOAA parameter editing screen. As downloaded, the Cumulus 1 executable is called '''cumulus.exe''' and all in lowecase. If you renamed that executable file to say ''Cumulus1.exe'' it will still work, but the main configuration file then takes that name (i.e. ''Cumulus1.ini'') in the same folder lacking one section, although another configuration file will be created called ''Cumulus.ini'' in that folder, this second one will have the one missing section.  The default name "cumulus.exe" results in only one '''cumulus.ini''' (all lower case) in that folder, containing all sections.
Additional configuration files, also called Cumulus.ini, can be created by Cumulus 1 to store the position of the main screen and the NOAA parameter editing screen.  
 
'''For Cumulus MX''', both file-names must start with a capital letter, and a If you renamed your executable file, you may still find a "cumulus.ini" file created by Cumulus 1 containing a [[#Section:_MainForm|single section]] to record when Cumulus closes where you positioned your Cumulus main screen so next you start Cumulus 1 its main screen can start in same position. For example I have mine on a second screen, and it stays there!  A second ''Cumulus.ini'' may be stored in the reports sub-directory, this only contains a [[#Section:_MainForm|single section]] and relates to the screen used for NOAA reports.
'''For Cumulus MX''', both file-names must start with a capital letter, and a If you renamed your executable file, you may still find a "cumulus.ini" file created by Cumulus 1 containing a [[#Section:_MainForm|single section]] to record when Cumulus closes where you positioned your Cumulus main screen so next you start Cumulus 1 its main screen can start in same position. For example I have mine on a second screen, and it stays there!  A second ''Cumulus.ini'' may be stored in the reports sub-directory, this only contains a [[#Section:_MainForm|single section]] and relates to the screen used for NOAA reports.
It is a text file containing initialization parameters used by the Cumulus 1.x.x, or Cumulus MX, application; and is read '''only''' when Cumulus starts up.  Cumulus (1 or 2 or MX) creates a new version of this file when it ''shuts down'', so you will see the file shows as 'modified date' the last time that Cumulus was shut down, the file that it creates includes the contents of the application's configuration screens and any parameters that were in the previous file that cannot be configured within Cumulus. Note this may change the order, or add lines, compared to any file that you manually edited.
For Cumulus MX only, a back up copy of Cumulus.ini is stored at end of each day (together with some of the log files). If you do need to edit the file, close Cumulus first to ensure you are working on latest file. When Cumulus restarts it will read the file again and see any edits you have made.
The parameters listed can change the look of Cumulus, hold basic information about your location, amend the way Cumulus interfaces with your weather station, and hold the settings used to interface with your website, and with various external websites. The list below was created for Cumulus 1.x.y, and all of it applies to the final formal release; '''for MX''' (like any beta) please refer to announcements or the separate page referenced below for any variations. In particular, MX has extended the range of settings for some items and added new items (see [[Cumulus.ini_(Beta)|here for details]].
If you are using an older Cumulus 1 version, then ''checking the release information may be advisable'' to identify the sections applicable to your build, and to identify if the parameters allowed within those sections may be a subset of those listed below as available in latest release.
[[Category:Configuration Files]]


= Upgrading to New Build =
= Upgrading to New Build =
5,838

edits