viniciuszendron / msfsscenerytools

This package provides some tools to validate and fix some errors when developing photogrammetry scenery to the new Microsoft Flight Simulator.

msfsSceneryTools

This package provides some functions to Microsoft Flight Simulator Scenery developers, especially those who extract photogrammetry data from other sources and need to do some cleaning and removing corrupted files.

Installation

After installing R (https://www.r-project.org), just run the code below to install the latest package stable version available:

if (!require("remotes")) install.packages("remotes")
remotes::install_github("viniciuszendron/msfsSceneryTools@main")

If a message asking to update packages appear, just press Enter key or select the option "None".

Changelog

Version 0.3.0

Remove Lods

New function removeLods remove specific LODS from a project. It removes LOD entries from .xml located in modelLib, its correspondent .bin/.gltf and textures in modelLib/textures.

Functions

New Functions

• removeLods: Remove lods from project.
• removeLodNodesFromXML: Remove lod nodes from XML.
• removeBinGltfByLods: Remove .bin and .gltf by lods.
• removeModelLibTexturesByLods: Remove textures by lods.

Version 0.2.0

Update Scenery Files

The new function updateSceneryFiles was created to remove remaining scenery files from modelLib and modelLib/texture that are no longer registered in scene/objects.xml (e.g. deleted photogrammetry tiles from in-game scenery editor). It can also remove .PNG.DDS and .PNG.DDS.json files located inside of a TEXTURE folder of an already built project.

Functions

New Functions

• updateSceneryFiles: Delete scenery files across the project (modelLib and modelLib/texture) that are no longer registered in scene/objects.xml. It can also remove .PNG.DDS and .PNG.DDS.json files located inside of a TEXTURE folder of an already built project by providing the TEXTURE path in deleteBuiltTextures argument.
• getXmlGuid: Get GUID from a modelLib .xml file.

Version 0.1.2

• Functions fixLods and fixBinGltf (both executed from fixCorruptedFiles) now removes all correspondent texture files (.png) from folder texture. Previously, only the corrupted .bin, .gltf and .xml were deleted, but the textures themselves were not. This behavior could make the final package bigger to the end user (as Flight Simulator editor does not remove them automatically).
• New function: objectsXmlGuids (Get all guids identifiers registered in objects.xml file).

msfsscenerytools's Issues

Create unit tests

Create unit tests by using testthat.

Implement general validations

Implement general validations on the function arguments. Use checkmate or the regular base R functions.

Create package webpage

Create webpage and include vignettes and instructions on how to use the package.

Set up GitHub Actions CI

Set up GitHub Actions CI:

https://github.com/r-lib/actions/tree/master/examples#readme

Create README and CHANGELOG

Write README and create CHANGELOG.

• Description and Installation instructions;
• Changelog;
• Basic Usage instructions.

Create directory validation

It would be good to include a folder validation to prevent running fix and check functions in the wrong directory.

Document functions

Functions need to be documented in roxygen style. Including examples and a vignette would be great.

Function to remove lod nodes

Create a new function to remove lods from project (not only nodes on .xmls, but also related .bin/.gltf and texture files). Give the user arguments to control (activate/deactivate) each one of these 3 routines.

Function to remove unused files in modelLib directory

Given the objects.xml of the project, search for files that are not being used anymore (.bin, .gltf, .xml and the correspondent .png in texture folder) and remove them from the project.

Add LICENSE

Choose and add LICENSE file and License field to DESCRIPTION.