User Tools

Site Tools


wiki:converting_orx_config_to_wiki

Orx Converter from Config files to Wiki Format

Who is this for?

This project is created specifically for maintainers of this Wiki as a convenience tool.

What does it do?

The SettingsTemplate.ini https://github.com/orx/orx/blob/master/code/bin/SettingsTemplate.ini is our source of truth when data config properties are added or changed. We change the format a little on the wiki by hand. This is very labourious.

The program (C++ code) simply takes the SettingsTemplate.ini file and creates a new file suitable for cutting and pasting into the wiki to reduce the effort required to keep the wiki in sync with the data config files.

How to use it?

You can either take the source file (main.cpp) and compile this yourself, or take a copy of the .exe. When you have an executable, simply run it. The program will use your $ORX environment variable to locate the SettingsTemplate.ini file in your orx repo and create the wiki formatted file for you automatically. It is created next to the original file.

Where is it?

What about CreationTemplate.ini?

That will come next.

wiki/converting_orx_config_to_wiki.txt · Last modified: 2023/08/04 01:12 (23 months ago) by sausage