Improve public API docs #706
Open
+131
−20
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
EchoEllet
force-pushed
the
docs/improve-public-api-docs
branch
from
86ba14e to
8e0e979
Compare
EchoEllet
commented
Nov 8, 2025
| ```kotlin | ||
| dependencies { | ||
| // You can change "compileOnly" to "implementation" for testing in-game. | ||
| compileOnly("dev.isxander:controlify:${project.controlify_version}") { |
Contributor
Author
There was a problem hiding this comment.
It looks like compileOnlyMod should be used instead when using Fabric Loom.
EchoEllet
commented
Nov 8, 2025
| // vanilla key mappings due explicit native support. | ||
| // You could also use ".keyEmulation(MyModKeyMappings.ACTION) to emulates | ||
| // the vanilla KeyMapping behavior, which may not always work well. | ||
| .addKeyCorrelation(MyModKeyMappings.ACTION) |
Contributor
Author
There was a problem hiding this comment.
Maybe we should point out to consumers that they need to either use keyEmulation or addKeyCorrelation. There is no point in using both, since keyEmulation already calls addKeyCorrelation internally.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates the documentation and Javadocs to make it more user-friendly and simplify integration with Controlify by:
dev.isxander.controlify.api.entrypoint.ControlifyEntrypointto make it easier for NeoForge users to create in their IDE or terminal.onControlifyInitandonControlifyPreInitto resolve common confusion.Related Issues