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

about armory3d documentation? #2839

Open
unicornlox opened this issue Mar 30, 2023 · 6 comments
Open

about armory3d documentation? #2839

unicornlox opened this issue Mar 30, 2023 · 6 comments
Labels
docs This issue is about documentation

Comments

@unicornlox
Copy link

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?

@unicornlox unicornlox added the feature request This issue requests a feature label Mar 30, 2023
@rpaladin
Copy link
Contributor

rpaladin commented Mar 31, 2023

As stated here: armory3d/armory_web#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
Copy link
Author

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
Copy link
Contributor

rpaladin commented Mar 31, 2023

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.

@MoritzBrueckner MoritzBrueckner added docs This issue is about documentation and removed feature request This issue requests a feature labels Mar 31, 2023
@chuiliuyiyi
Copy link

chuiliuyiyi commented Apr 26, 2023

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
Copy link
Contributor

rpaladin commented Apr 26, 2023

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
Copy link

image
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue is about documentation
Projects
None yet
Development

No branches or pull requests

4 participants