Update MetaDataRef & readme, rename readme and license
This commit is contained in:
35
README.md
Normal file
35
README.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# SMC Luanti IDE Helper
|
||||
|
||||
[](https://github.com/lord-server/lord?tab=readme-ov-file#contributors--%D1%83%D1%87%D0%B0%D1%81%D1%82%D0%BD%D0%B8%D0%BA%D0%B8)
|
||||
[](./license.md)
|
||||
|
||||
A helper package for [Luanti](https://www.luanti.org/) (Minetest) mod/game development that provides autocompletion and documentation for IDE integration.
|
||||
|
||||
Please note **that this is a fork** of [luanti-ide-helper](https://github.com/Voxrame/luanti-ide-helper). The original repository was developed and is maintained by [Lord Team](https://github.com/lord-server/lord?tab=readme-ov-file#contributors--%D1%83%D1%87%D0%B0%D1%81%D1%82%D0%BD%D0%B8%D0%BA%D0%B8).
|
||||
|
||||
This ide-helper is specifically designed to support the [SMC game](https://git.apancore.ru/Apancore.Studio/simple-makes-complex), may interpret the Luanti API Reference in a biased manner, and may not be suitable for other projects. The developers provide no guarantees regarding the suitability of using the current version of ide-helper in third-party projects, including no guarantee of backward compatibility.
|
||||
|
||||
**We recommend using and supporting the [original ide-helper](https://github.com/Voxrame/luanti-ide-helper) repository.**
|
||||
|
||||
## Supported IDEs & Plugins
|
||||
|
||||
- IntelliJ IDEA (or compatible) with [EmmyLua2 Plugin](https://plugins.jetbrains.com/plugin/25076-emmylua2)
|
||||
- VS Code with [EmmyLua Extension](https://marketplace.visualstudio.com/items?itemName=tangzx.emmylua) (recommended for VS Code)
|
||||
- VS Code with [Lua Language Server](https://marketplace.visualstudio.com/items?itemName=sumneko.lua)
|
||||
- Any editor with LSP support.
|
||||
Install Lua LS: `cargo install emmylua_ls` (or see [instalation guide](https://github.com/EmmyLuaLs/emmylua-analyzer-rust?tab=readme-ov-file#-installation))
|
||||
|
||||
## Annotation up-to-dateness
|
||||
Some annotations may be outdated for newer versions of Luanti, as the Luanti API Reference gradually changes.
|
||||
|
||||
At the beginning of some files, there may be information about relevance in the form of a Luanti version:
|
||||
```lua
|
||||
---Version: 5.16 -- This means that the annotations were updated or verified with the documentation for Luanti 5.16.
|
||||
---@meta
|
||||
```
|
||||
|
||||
If you find a discrepancy between the ide-helper annotations and the Luanti API Reference, you can create an [issue](https://git.apancore.ru/Apancore.Studio/smc-luanti-ide-helper/issues) to notify the maintainers.
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the MIT License - see [`license.md`](./license.md) file for details.
|
||||
Reference in New Issue
Block a user