Skip to content

Documentation followups to File IO (#3511) #3654

@syntaxi

Description

@syntaxi

With the merge of #3511, modules now how access to a, limited, file IO api. This is a PR a long time in the making an a feature that a bunch of modules would probably love to use, (methinks a revamped Structure Templates).

However, it doesn't matter how great a feature is if nobody knows it exists or how to use it. This is a followup issue to #3366 to document the new system and how to use it. In an idea world, this would be an entire tutorial repository with examples galore. However that may be a tad too optimistic

At the least, a page on either the engine wiki (https://github.com/MovingBlocks/Terasology/wiki) or onto our meta docs site (https://github.com/MetaTerasology/metaterasology.github.io) detailing what you can do with the file API. Preferably also some snippets of example code.

If you are interested in working on this but lack wiki rights then hop onto our discord and we can work something out.

Metadata

Metadata

Assignees

Labels

Category: DocRequests, Issues and Changes targeting javadoc and module documentationGood First IssueGood for learners that are new to TerasologyTopic: ArchitectureRequests, Issues and Changes related to software architecture, programming patterns, etc.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions