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.

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

Externalize asset system + improve docs #1234

Closed
Cervator opened this issue Sep 28, 2014 · 5 comments
Closed

Externalize asset system + improve docs #1234

Cervator opened this issue Sep 28, 2014 · 5 comments
Assignees
Labels
Category: Build/CI Requests, Issues and Changes targeting gradle, groovy, Jenkins, etc. Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Topic: Architecture Requests, Issues and Changes related to software architecture, programming patterns, etc.

Comments

@Cervator
Copy link
Member

Edit 2015-11-14: This is mostly complete (gestalt-asset has been extracted and stabilized), leaving the issue open for a bit till we get a chance to review / improve docs.

@immortius has mentioned wanted to pull out our engine's asset system to a gestalt-asset or so library. That's probably also a good time to overhaul the documentation, first for the system in its own repo wiki and our docs here for Terasology

I was looking to update https://github.com/MovingBlocks/Terasology/wiki/Asset-System as part of merging a new asset type but it is woefully out of date and mostly just a clone of AssetType.java's list. Ideally we'd put a more informative page together as part of the modding guide for Terasology's used types that is more resilient to going out of date. That could be done by scanning AssetType.java (or any tweaked setup with gestalt-asset torn out) and comparing it to the wiki page as part of the build in Jenkins.

Related: #1217, #813 (probably?), #763 (maybe), #335 (perhaps obsolete/fixed at this point)

@Cervator Cervator added Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Topic: Architecture Requests, Issues and Changes related to software architecture, programming patterns, etc. Category: Build/CI Requests, Issues and Changes targeting gradle, groovy, Jenkins, etc. labels Sep 28, 2014
@Cervator Cervator added this to the Beta milestone Sep 28, 2014
@shartte
Copy link
Contributor

shartte commented Sep 28, 2014

What is the benefit of externalizing the asset system?

@Cervator
Copy link
Member Author

Reusability (everybody loves libraries!), clarity, encapsulation, shrinking engine further, fewer chances for code/git conflicts. It isn't very critical, but nice :-)

@msteiger
Copy link
Member

msteiger commented Oct 3, 2014

It would also be great to have this for the MapViewer project. Currently, it fires up TS in headless mode just to access simple assets such as the name list for NameGenerator.

@immortius
Copy link
Member

One particular driver is opening up NUI for use outside Terasology.

@Cervator
Copy link
Member Author

Closing as complete. Was actually done some time back but this was left open for documentation. Between https://github.com/MovingBlocks/gestalt/wiki/Gestalt%20Asset%20Core and https://github.com/Terasology/TutorialAssetSystem that should be covered!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Build/CI Requests, Issues and Changes targeting gradle, groovy, Jenkins, etc. Category: Doc Requests, Issues and Changes targeting javadoc and module documentation Topic: Architecture Requests, Issues and Changes related to software architecture, programming patterns, etc.
Projects
None yet
Development

No branches or pull requests

5 participants