Skip to content

Commit

Permalink
Merge branch 'develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
charliewhitfield committed Jan 7, 2025
2 parents 6c4c8f0 + 1cea343 commit d48fe4f
Show file tree
Hide file tree
Showing 11 changed files with 21 additions and 20 deletions.
9 changes: 5 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Changelog

File format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
This file documents changes to [ivoyager_tables](https://github.com/ivoyager/ivoyager_tables).

File format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## v0.0.1 - 2024-12-20
## v0.0.1 - 2025-01-07

Developed using Godot 4.3.

This plugin resulted from splitting plugin 'ivoyager_table_importer' into two plugins, 'ivoyager_tables' and 'ivoyager_units'.
This plugin resulted from splitting the now-depreciated [Table Importer](https://github.com/ivoyager/ivoyager_table_importer) (v0.0.9) into two plugins: [Tables](https://github.com/ivoyager/ivoyager_tables) (v0.0.1) and [Units](https://github.com/ivoyager/ivoyager_units) (v0.0.1).

v0.0.1 is almost a 'drop-in' replacement for ''ivoyager_table_importer' v0.0.9. The main breaking change is in the method signature for postprocess_tables(). The order is changed and you now MUST supply a unit coversion method (you probably want the one in the 'Units' plugin).
v0.0.1 is almost a "drop-in" replacement for ivoyager_table_importer v0.0.9. The main breaking change is in the method signature for postprocess_tables(). The order is changed and you now MUST supply a unit coversion method (you probably want the one in the ivoyager_units plugin).
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2017-2024 Charlie Whitfield; I, Voyager is a registered trademark of Charlie Whitfield in the US
Copyright 2017-2025 Charlie Whitfield; I, Voyager is a registered trademark of Charlie Whitfield in the US

Apache License
Version 2.0, January 2004
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# I, Voyager - Tables

TL;DR: This Godot Editor plugin imports tables like [this](https://github.com/ivoyager/ivoyager/blob/master/data/solar_system/planets.tsv) and provides access to processed, statically typed data. It can impute defaults, convert floats by specified units, prefix text, convert text enumerations to integers, and more!
TL;DR: This Godot Editor plugin imports tables like [this](https://github.com/ivoyager/ivoyager_core/blob/master/data/solar_system/planets.tsv) and provides access to processed, statically typed data. It can impute defaults, convert floats by specified units, prefix text, convert text enumerations to integers, and more!

This plugin works best in combination with our [Units](https://github.com/ivoyager/ivoyager_units) plugin. You can use it without that plugin, but you will need to supply your own unit coversion method to use any units functionality.

Expand Down Expand Up @@ -69,13 +69,13 @@ For debugging or work-in-progress, you can prevent any imported table from being

#### Comments

Any line starting with "#" is ignored. Additionally, entire columns are ignored if the column "field" name begins with "#".
Any line starting with "#" is ignored. Additionally, entire columns are ignored if the column field name begins with "#".

#### General Cell Processing

All cells are stripped of double-quotes if they enclose the cell on both sides. These are silently added by some editors.
All cells are stripped of double-quotes if they enclose the cell on both sides (these are silently added by some editors).

Spaces are edge-stripped from cells and cell elements. ("Cell element" refers to comma- or semicolon-delimited data within cells of certain types, such as VECTORx, COLOR, and ARRAY[xxxx]).
Spaces are edge-stripped from cells and cell elements ("cell element" refers to comma- or semicolon-delimited data within cells of certain types, such as VECTORx, COLOR, and ARRAY[xxxx]).

#### Data Types

Expand Down Expand Up @@ -118,7 +118,7 @@ Most .csv/.tsv file editors will "interpret" and change (i.e., corrupt) table da

## DB_ENTITIES Format

[Example Table](https://github.com/ivoyager/ivoyager/blob/master/data/solar_system/planets.tsv)
[Example Table](https://github.com/ivoyager/ivoyager_core/blob/master/data/solar_system/planets.tsv)

Optional specifier: `@DB_ENTITIES[=<table_name>]` (table_name defaults to the base file name)
Optional directive: `@DONT_PARSE`
Expand All @@ -135,7 +135,7 @@ After field names and before data, tables can have the following header rows in
* `Type` (required): See data types above.
* `Default` (optional): Default values must be empty or follow Type rules above. If non-empty, this value is imputed for any empty cells in the column.
* `Unit` (optional; FLOAT fields only): The data processor recognizes a broad set of unit symbols (mostly but not all SI) and, by default, converts table floats to SI base units in the postprocessed "internal" data. Default unit conversions are defined by "unit_multipliers" and "unit_lambdas" dictionaries [here](https://github.com/ivoyager/ivoyager_table_importer/blob/master/singletons/units.gd). Unit symbols and/or internal representation can be changed by specifying replacement conversion dictionaries in the `postprocess_tables()` call.
* `Prefix` (optional; STRING, STRING_NAME and INT fields only): Prefixes any non-empty cells and `Default` (if specified) with provided prefix text. To prefix the column 0 implicit "name" field, use `Prefix/<entity prefix>`. E.g., we use `Prefix/PLANET_` in [planets.tsv](https://github.com/ivoyager/ivoyager/blob/master/data/solar_system/planets.tsv) to prefix all entity names with "PLANET_".
* `Prefix` (optional; STRING, STRING_NAME and INT fields only): Prefixes any non-empty cells and `Default` (if specified) with provided prefix text. To prefix the column 0 implicit "name" field, use `Prefix/<entity prefix>`. E.g., we use `Prefix/PLANET_` in [planets.tsv](https://github.com/ivoyager/ivoyager_core/blob/master/data/solar_system/planets.tsv) to prefix all entity names with "PLANET_".

#### Entity Names

Expand Down Expand Up @@ -181,7 +181,7 @@ As for DB_ENTITIES, you can obtain row_number from the "enumerations" dictionary

## WIKI_LOOKUP Format

[Example Table](https://github.com/ivoyager/ivoyager/blob/master/data/solar_system/wiki_extras.tsv)
[Example Table](https://github.com/ivoyager/ivoyager_core/blob/master/data/solar_system/wiki_extras.tsv)

Required specifier: `@WIKI_LOOKUP[=<table_name>]` (table_name defaults to the base file name)
Optional directive: `@DONT_PARSE`
Expand Down
2 changes: 1 addition & 1 deletion editor_import_plugin.gd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This file is part of I, Voyager
# https://ivoyager.dev
# *****************************************************************************
# Copyright 2017-2024 Charlie Whitfield
# Copyright 2017-2025 Charlie Whitfield
# I, Voyager is a registered trademark of Charlie Whitfield in the US
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
2 changes: 1 addition & 1 deletion editor_plugin.gd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This file is part of I, Voyager
# https://ivoyager.dev
# *****************************************************************************
# Copyright 2017-2024 Charlie Whitfield
# Copyright 2017-2025 Charlie Whitfield
# I, Voyager is a registered trademark of Charlie Whitfield in the US
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
2 changes: 1 addition & 1 deletion plugin.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
name="I, Voyager - Tables"
description="Imports formatted .tsv tables and provides access to processed, statically typed data. Data processing imputes defaults, prefixes strings, converts floats by specified units, and converts text enumerations to integers (enumerations can be project or table-defined), ... amongst other things"
author="Charlie Whitfield"
version="v0.0.1.dev"
version="v0.0.1"
script="editor_plugin.gd"
2 changes: 1 addition & 1 deletion table_data.gd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This file is part of I, Voyager
# https://ivoyager.dev
# *****************************************************************************
# Copyright 2017-2024 Charlie Whitfield
# Copyright 2017-2025 Charlie Whitfield
# I, Voyager is a registered trademark of Charlie Whitfield in the US
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
2 changes: 1 addition & 1 deletion table_modding.gd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This file is part of I, Voyager
# https://ivoyager.dev
# *****************************************************************************
# Copyright 2017-2024 Charlie Whitfield
# Copyright 2017-2025 Charlie Whitfield
# I, Voyager is a registered trademark of Charlie Whitfield in the US
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
2 changes: 1 addition & 1 deletion table_postprocessor.gd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This file is part of I, Voyager
# https://ivoyager.dev
# *****************************************************************************
# Copyright 2017-2024 Charlie Whitfield
# Copyright 2017-2025 Charlie Whitfield
# I, Voyager is a registered trademark of Charlie Whitfield in the US
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
2 changes: 1 addition & 1 deletion table_resource.gd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This file is part of I, Voyager
# https://ivoyager.dev
# *****************************************************************************
# Copyright 2017-2024 Charlie Whitfield
# Copyright 2017-2025 Charlie Whitfield
# I, Voyager is a registered trademark of Charlie Whitfield in the US
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down
2 changes: 1 addition & 1 deletion tables_plugin_utils.gd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# This file is part of I, Voyager
# https://ivoyager.dev
# *****************************************************************************
# Copyright 2017-2024 Charlie Whitfield
# Copyright 2017-2025 Charlie Whitfield
# I, Voyager is a registered trademark of Charlie Whitfield in the US
#
# Licensed under the Apache License, Version 2.0 (the "License");
Expand Down

0 comments on commit d48fe4f

Please sign in to comment.