asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix formatting mistakes in config file warning code block

Browse source 
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
This commit is contained in:
betalars 2024-10-14 23:22:14 +02:00 committed by GitHub
parent aaf5443832
commit bcbd6e01b1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/classes/ConfigFile.xml
View file

@ -164,15 +164,16 @@
<description>
Loads the config file specified as a parameter. The file's contents are parsed and loaded in the [ConfigFile] object which the method was called on.
Returns [constant OK] on success, or one of the other [enum Error] values if the operation failed.
[b]Warning:[/b] Loading Data from a Config File may allow for remote code execution. This is non-trivial to midigate, but storing a [readme] file in the same directory can warn users against downloading untrusted configurations:
[b]Warning:[/b] Loading Data from a Config File may allow for remote code execution. This is non-trivial to midigate, but storing a [code]readme[/code] file in the same directory can warn users against downloading untrusted configurations:
[codeblocks]
[gdscript]
var config_path = "user://"
var config_file_name = "my_game.config"
# check if configuration has been initialized:
# Check if configuration has been initialized:
if not FileAccess.file_exists("%s%s" % [config_path, config_file_name]):
var readme := FileAccess.open("%s%s" % [config_path, "README.txt"], FileAccess.WRITE)
var readme = FileAccess.open("%s%s" % [config_path, "README.txt"], FileAccess.WRITE)
readme.store_string("Caution: It is not advised to use Config-files you find online, as malicious files may compromise your device.")
readme.close()
[/gdscript]
[/codeblocks]
</description>