armory3d / armory

3D Engine with Blender Integration
https://armory3d.org
zlib License
3.07k stars 314 forks source link

about armory3d documentation? #2839

Open unicornlox opened 1 year ago

unicornlox commented 1 year ago

Can the documentation of the Armory3D API include explanations and examples of the API terms? Also, can you provide a tutorial on the game development process using Haxe code?

rpaladin commented 1 year ago

As stated here: https://github.com/armory3d/armory_web/issues/34 it's planned to back-port the Armory wiki to https://github.com/armory3d/armory_docs. When the migration is complete, more up-to-date content and documentation should definitely be more viable.

unicornlox commented 1 year ago

Thank you so much for your response. I hope the documentation includes useful information on how to manage Armory3D with Haxe. Also, it would be great if there is content that presents the interface with images. I am planning to switch from Godot to Armory3D, but I couldn't use Armory3D because the documentation is not very advanced for Armory3D.

rpaladin commented 1 year ago

I agree, the visual part of the documentation is way over due for an update.

There are numerous downloadable demos: https://armory3d.github.io/armory_examples_browser/ I plan to link them in the newer Armory documentation when apprioate i.e. UI examples for the UI documentation. Also API links too. It's a bit difficult to maintain the documentation itself (not the API), as Blender UI changes every once in a while, not to mention new Armory contributor PRs also tend to change the UI once in a while too.

NOTE: If you're interested in helping update the documentation, the development team is always happy to accommodate new contributors. 🙂 Whether it's for documentation, engine or website development, etc., is up to the contributor.

chuiliuyiyi commented 1 year ago

armory_docs-main,No detailed code examples available。 armory_examples-master,Unable to find bound .hx。 armory_templates-master,White screen after operation。 on ArmorySDK2304。 Request Resolution。

rpaladin commented 1 year ago

Hi @chuiliuyiyi.

  1. The armory_docs is the old documentation repository. It shouldn't contain any downloadable examples (to my knowledge).

  2. The armory_examples should have any used Haxe files under \Sources\arm similar to any normal Armory project. You can view and download a online demo's source by clicking the <> brackets icon. For example, I highlighted the icon in the screenshot below:

image

  1. Regarding the armory_templates:
    • Can you please be more specific?
    • Are you getting a white screen with the online demos or locally on your computer when using one of the downloaded blends?
    • Did you clear your project's cache to see if that helps resolve the white screen?
    • Any errors in the console?
chuiliuyiyi commented 1 year ago

image image