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

Add the nCine addon #190

Merged
merged 1 commit into from
Nov 25, 2024
Merged

Add the nCine addon #190

merged 1 commit into from
Nov 25, 2024

Conversation

encelo
Copy link
Contributor

@encelo encelo commented Nov 22, 2024

I would like to contribute the CATS definitions for the nCine, an open source cross-platform 2D game framework that can be used with both C++ and Lua.

The work took 2-3 weeks of my spare time and gave me the opportunity to review both the C++ Doxygen documentation and the Lua API itself. I would be really glad and proud if it gets accepted as an official addon for the Lua Language Server. 😊

Please don't hesitate to provide feedback and let me know if there is anything that should be changed. 🙏🏻
GitHub Issue: #191.

@encelo encelo mentioned this pull request Nov 22, 2024
@carsakiller carsakiller added the New Addon Related to adding a new addon label Nov 22, 2024
@carsakiller
Copy link
Collaborator

Please run StyLua on your submodule to apply the proper code style.

Also, you have a few other files in your addon like .editorconfig, .github/workflows/lua-documentation.yml, etc. that I would prefer not be included in the published addon. Could you publish your addon to a different branch in your repo, say addon, and then add that branch as the submodule?

@encelo
Copy link
Contributor Author

encelo commented Nov 22, 2024

The library directory has already passed under the stylua 2.0.1 scrutiny, the only change that it suggests is listing the ncine.shader.load_from_memory_with_hashes() function parameters one under the other, but this way the language server complains that: "Annotations specify that a return value si required here." That's why I have reverted that change.

I have updated the PR and the submodule now points to the addon branch that does not have .editorconfig nor the .github/workflows/lua-documentation.yml files. 👍🏻

@carsakiller
Copy link
Collaborator

carsakiller commented Nov 22, 2024

Ok, that is fine.

The submodule actually committed still points to ff1a7d2 though. The following should fix it:

  1. cd into your addon in your fork of LLS-Addons
  2. git checkout addon
  3. git pull origin addon
  4. cd back to root of LLS-Addons
  5. git add addons/ncine/module
  6. git commit -m "fix: point ncine to addon branch"
  7. Push the change

@encelo encelo force-pushed the add-ncine branch 2 times, most recently from a4bcb4e to 1c5b9fd Compare November 25, 2024 12:36
@encelo
Copy link
Contributor Author

encelo commented Nov 25, 2024

Thanks for the instructions, it should be fixed now. 👌🏻

@carsakiller
Copy link
Collaborator

Thank you, nice work!

@carsakiller carsakiller merged commit 05b3eaf into LuaLS:main Nov 25, 2024
1 of 2 checks passed
carsakiller added a commit that referenced this pull request Nov 25, 2024
carsakiller added a commit that referenced this pull request Nov 25, 2024
@carsakiller carsakiller mentioned this pull request Nov 25, 2024
@encelo encelo deleted the add-ncine branch November 26, 2024 01:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
New Addon Related to adding a new addon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants