fl-configs

command module
v0.43.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 28, 2024 License: GPL-3.0 Imports: 9 Imported by: 0

README

fl-configs

Description

Reusable library parser of Freelancer Discovery game data.

freelancer (resembling ini) config reader/writer with having mapped variables to access in ORM - object relational mapping fashion. This alone allows quickly accessing any config data with least amont of code effort for additional features.

Features

  • it offers custom ORM like static typed access to data.
  • With ability to read and write data back without requiring to write code for writing
    • U can be just changing ORM mapped values

This library is used at least in projects:

  • fldarklint (config formatter)
  • fldarkstat (online flstat)

Code examples.

Architecture

flowchart TD
    mapped[mapped\nProvides static typed access to parsedFreelancer configs]
    mapped --> freelancer[freelancer\nFreelancer Data Parsers\npackage reflects\nFreelancer File Structure]
    mapped --> filefind[filefind\nfinds freelancer files]
    freelancer --> inireader[inireader\nUniversal freelancer ini format reader\nLoads to changable structure\nThat can be rendered back]
    freelancer --> semantic[semantic\nORM mapper of inireader values for quick typed acess to values\nfor reading and writing, without need to map all file structure]
    semantic --> inireader

Documentation

Overview

See package `configs` for description and code examples

Directories

Path Synopsis
Package for ORM access to freelancer game configs data.
Package for ORM access to freelancer game configs data.
configs_mapped
Tool to parse freelancer configs
Tool to parse freelancer configs
configs_mapped/freelancer_mapped/data_mapped
This package is equal to DATA folder present in Freelancer Discovery.
This package is equal to DATA folder present in Freelancer Discovery.
parse universe.ini
configs_mapped/freelancer_mapped/exe_mapped/go-binary-pack
Package binary_pack performs conversions between some Go values represented as byte slices.
Package binary_pack performs conversions between some Go values represented as byte slices.
configs_mapped/parserutils/filefind
Package with reusable code for discovery of files and other reusable stuff like universal ini reader
Package with reusable code for discovery of files and other reusable stuff like universal ini reader
configs_mapped/parserutils/inireader
Okay we need to create syntax.
Okay we need to create syntax.
configs_mapped/parserutils/semantic
ORM mapper for Freelancer ini reader.
ORM mapper for Freelancer ini reader.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL