jMonkeyEngine / jMonkeyEngine/jmonkeyengine
the sample apps aren't user-friendly
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 4.3k
- Forks
- 1.2k
- Avg merge
- 4d 7h
- Merged PRs (30d)
- 14
Description
For many newcomers, the sample apps in the jme3-examples sub-project (the "JME3 Tests" project in the SDK) serve as an introduction to JME's capabilities.
As @nav9 recently reminded us (at issue #1124), the sample apps could be a lot more user-friendly. In many cases, the best way to figure out what the apps do is to read the source code.
It would be helpful if more of the sample apps displayed:
- a brief description of the purpose of the app
- hints/reminders as to which keys/buttons do what
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the jme3-examples sub-project and review the JME3 Tests sample apps in the SDK. Identify which apps lack a brief purpose description or hints for their keys and buttons, then make those user-facing cues consistent. Done means the sample apps explain their purpose and controls without requiring newcomers to read the source code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- game-dev
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100