MovingBlocks / Terasology

Terasology - open source voxel world
http://terasology.org
Apache License 2.0
3.68k stars 1.34k forks source link

Ambiguities/confusion on TutorialAssetSystem Add-a-dice page #3257

Open chum opened 6 years ago

chum commented 6 years ago

What you were trying to do

Follow the tutorial.

What actually happened

I got stuck in the add-a-dice section.

How to reproduce

Ok, seriously...

Things are further confusing because my Terasology directory has both... modules/TutorialAssetSystem/{assets, src}/ and tutorial/assetsystem/systems/ directories. I'll guess it goes in one of these and see if things work but, if they don't, I won't know if it's because I goofed the file or put it in the wrong place.

SUGGESTED FIX: add the correct location of the RotateBlockOnActivateComponent [.java?] file to the web page.

Log details and game version

N/A

Computer details

N/A (but it's an iMac running High Sierra with all SWU updates, if you're tracking demographics.)

devibri commented 6 years ago

This confused me at first too. What I ended up doing was looking at the documentation for the module, seeing where the file was placed in there, and then realizing that the top line of the suggested code actually tells you the path that it belongs in. So for instance in the code on RotateBlockOnActivateComponent, the top line reads: package org.terasology.tutorial.assetsystem.components;

So you can create a new set of directories at YOUR_PATH\Terasology\engine\src\main\java\org\terasology to match the ones provided in the package part of the demo code. So for instance the RotateBlockOnActivateComponent.java file will go at YOUR_PATH\Terasology\engine\src\main\java\org\terasology\tutorial\assetsystem\components.

Agree that this can / should be made clearer in the tutorial / documentation though.

EDIT: After seeing more module-s and how they're laid out, I think it's actually appropriate to put these files in a src folder within the module itself, without messing around with the main engine files