Documentation before release - Githubissues

hugeblank / allium

Lua script loader and API for easy Minecraft modding

MIT License

39 stars 8 forks source link

Documentation before release #15

Open hugeblank opened 2 years ago

hugeblank commented 2 years ago

Documentation:

[ ] Allium library allium
[ ] Commands library commands
[ ] Command builder command
[ ] Game library game
[ ] Java library java
[ ] Class builder library
[ ] NBT library nbt
[ ] Package library package
[ ] Require function require
[ ] Script library script
[ ] Text library text
[x] Possible yarn mappings -> lua documentation?
[x] Events

Tutorials:

[ ] Allium Script Setup and Hello World
[ ] Let's script: My first Lua Item
[ ] Let's script: My first extended class
[ ] Let's script: My first Lua command
[ ] Let's script: Hangman game
[ ] Creating an Allium API for your mod

hugeblank commented 2 years ago

Some to-do with the current docs:

[ ] Instance methods of @LuaWrapped classes need to be implied as global, and given the name provided by the class. Also they need to properly handle having empty headers
[ ] For future versions of allium, maybe it would be a good idea to include private methods, and just mention that they have to be mixin'd, providing a way to copy target details.
[ ] methods annotated with @LuaIndex should be unwrapped
[ ] Lists, Maps, and arrays should be indicated as tables
[ ] Followup to above, generics support!
[ ] Include enhanced-reflection, and floader in doc-gen