Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation followups to File IO (#3511) #3654

Open
syntaxi opened this issue Apr 4, 2019 · 4 comments · May be fixed by #5263
Open

Documentation followups to File IO (#3511) #3654

syntaxi opened this issue Apr 4, 2019 · 4 comments · May be fixed by #5263
Assignees
@llvieira
Labels
Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Good First Issue Good for learners that are new to Terasology Topic: Architecture Requests, Issues and Changes related to software architecture, programming patterns, etc.

Comments

@syntaxi
Copy link

syntaxi commented Apr 4, 2019

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.
@syntaxi syntaxi added Api Category: Doc Requests, Issues and Changes targeting javadoc and module documentation labels Apr 4, 2019
@llvieira llvieira self-assigned this Apr 7, 2019
@llvieira
Copy link
Member

llvieira commented Apr 7, 2019

Hey @jellysnake, I've just written a simple Wiki on how to use it, you can check it here: https://github.com/MovingBlocks/Terasology/wiki/IO-API-for-Modules

I hope that I or someone else can improve it soon. 😃

@syntaxi
Copy link
Author

syntaxi commented Apr 13, 2019

Nice, looks like a good description of the features.
Only thing I'd note is, i recall discussion about directories not being supported? Ie, you can't make directories and you access in directories. This would be good to add a a warning about.

Also, seems like the snippets for Read and Write consumers are around the wrong way?

@Cervator Cervator added the Good First Issue Good for learners that are new to Terasology label Nov 3, 2019
@skaldarnar skaldarnar added Topic: Architecture Requests, Issues and Changes related to software architecture, programming patterns, etc. and removed Api labels May 15, 2021
@PauloCactus
Copy link

Hey @jellysnake, I've just written a simple Wiki on how to use it, you can check it here: https://github.com/MovingBlocks/Terasology/wiki/IO-API-for-Modules

I hope that I or someone else can improve it soon. 😃

Apparently you can now find the doc here : https://github.com/MovingBlocks/Terasology/blob/develop/docs/IO-API-for-Modules.md

PauloCactus added a commit to PauloCactus/Terasology that referenced this issue Jul 17, 2024
@PauloCactus
Improvements IO-API-for-Modules doc (fixes MovingBlocks#3654)
f1b7981
@PauloCactus PauloCactus linked a pull request Jul 17, 2024 that will close this issue
Open
@PauloCactus
Copy link

Nice, looks like a good description of the features. Only thing I'd note is, i recall discussion about directories not being supported? Ie, you can't make directories and you access in directories. This would be good to add a a warning about.

Also, seems like the snippets for Read and Write consumers are around the wrong way?

@syntaxi done!

@vorburger (mentor) FYI

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@llvieira llvieira

Labels
Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Good First Issue Good for learners that are new to Terasology Topic: Architecture Requests, Issues and Changes related to software architecture, programming patterns, etc.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improvements IO-API-for-Modules doc (fixes #3654) PauloCactus/Terasology
5 participants
@Cervator @skaldarnar @syntaxi @llvieira @PauloCactus