Super Mario Bros. X Forums

Hello! It's no secret the documentation process is currently ongoing, and since it will likely take a bit more time, I figured I'd make the process a bit more transparent. This thread is basically gonna be a living changelist for new pages added to the documentation.

Our new documentation
https://docs.codehaus.moe

For legacy documentation:
https://wohlsoft.ru/pgewiki/Category:LunaLua_API
For additional resources:
viewtopic.php?f=105&t=25425

UPDATES
In the replies to this post I will (for the foreseeable future) post weekly updates to the pages present on the documentation, so keep an eye out if you're interested in the topic.

CONTRIBUTING
Currently I'm the only one working on this, so if you have pity on my poor soul, you can help out by creating Merge Requests on our Gitlab repository:
https://gitlab.com/Bluenaxela/smbx2-documentation
All the new documentation pages are written in Markdown. If you are confused about layout or specifics, shoot me a PM.
My current goal is to finish transferring the contents form the handbook and the old documentation onto the new page.

FOUND AN ERROR? GOT A SUGGESTION?
For erroes and suggestions please create a new issue on the aforementioned git repository. Make sure to check if anyone else posted the same thing beforehand, to avoid duplicate issues.

Currently known issues (as of the making of this post):
- table view can be an eyesore with more advanced function definitions (different overloads, named args, etc...)
- links are sometimes broken and generally a pain to use in the backend
- many pages are missing

I feel so good knowing that I was already aware of this

Very useful, I recommend you guys check it out!

SMBX2 Documentation Update Roundup (August 30 2020)
New:
Scripting API Reference:
- Lunalua Events
- Misc
- Layer
- Graphics
- Globals
- Text
Concepts:
- Coordinate Spaces
- Render priority
- vararg
Constants:
- Characters
- Directions
- Harm Types
- Field Types
- Key Codes
- Player Keys
- Powerups
- Render Type
- Screen effect
- SMBX Version
- Weather Effects
- World HUD State
Types:
- Event token
Features:
- Cheats

Modified:
Types:
- Table (added functions)

If you notice any problems or have suggestions for pages we should prioritize, please follow the instructions in the first post.

See you next week!

SMBX2 Documentation Update Roundup (September 06 2020)
New:
Scripting API Reference:
- NPC AI (1-100 so far)
- Defines
- Level (Levels)
- Level (Overworld)
Constants (all of these will become available with Patch 3 Hotfix):
- Mounts
- Score
- Forced State
- Level Victory

Modified:
Scripting API Reference:
- Misc (Added function Misc.exitEngine for Patch 3 Hotfix)

If you notice any problems or have suggestions for pages we should prioritize, please follow the instructions in the first post.

See you next week!

its saying that its suspended when i try to open it

Didn't get around to too much this week, unfortunately.

SMBX2 Documentation Update Roundup (September 13 2020)
New:
- Color (missing methods)

Modified:
- String (added functions)
- Graphics (added HUD functions)

If you notice any problems or have suggestions for pages we should prioritize, please follow the instructions in the first post.

See you next week!
[/quote]

Be nice to see more World-map and level loading based info. Same for load-screens.

MECHDRAGON777 wrote: ↑

Fri Sep 18, 2020 2:53 am

Be nice to see more World-map and level loading based info. Same for load-screens.

All world map, load screen and level loading info is now documented. Most of it already was when you wrote that post. (Level.load, Misc.loadEpisode)

SMBX2 Documentation Update Roundup (September 20 2020)
New:
Features:
- Achievements (setup)
- Command line arguments
- F-Keys

Reference:
- Achievements (Scripting reference)
- Console
- Console
- Musicbox
- Path
- Progress
- RNG
- Scenery
- Tile
- Warp
- World
Concepts:
- Load Screen Environment
- SaveData and GameData
Types:
- Shader


Modified:
Just some typos.

If you notice any problems or have suggestions for pages we should prioritize, please follow the instructions in the first post.

See you next week!

SMBX2 Documentation Update Roundup (September 27 2020)
New:
Features:
- Launcher Pages

Reference:
- Camera
- Global Memory
- Section
- Vector
Types:
- Rect

Modified:
- Color class now has functions documented
- Fixed some wrong links

If you notice any problems or have suggestions for pages we should prioritize, please follow the instructions in the first post.

See you next week!

Not much new this week, due to various circumstances. The stuff I started ought to be fairly useful, though ;)

SMBX2 Documentation Update Roundup (October 4 2020)
New:
Features:
- BGO Config
- Block Config
- Light Config
- NPC Config (currently WIP)

If you notice any problems or have suggestions for pages we should prioritize, please follow the instructions in the first post.

See you next week!

I continue my quest to copy old documentation.

SMBX2 Documentation Update Roundup (October 11 2020)
Modified:
- NPC Config (Added sections 'Bros' to 'Fry Guy'))

If you notice any problems or have suggestions for pages we should prioritize, please follow the instructions in the first post.

See you next week!

This may look like it wasn't much, but it probably was the longest time per week I've spent on docs so far.

SMBX2 Documentation Update Roundup (October 18 2020)
New:
- Ticks
Modified:
- NPC Config (Finished))

If you notice any problems or have suggestions for pages we should prioritize, please follow the instructions in the first post.

See you next week!

Hm... been a bit longer than a week since the last update.
Updates here will remain more irregular, but you might notice the docs updating sporadically anyhow. There's also usually discussion on codehaus whenever it happens.

SMBX2 Documentation Update Roundup (May 24, 2021) (every change since the last update in October)
New:
- Concepts: Audio File Formats
- Concepts: Custom Range
- Concepts: Data Table
- Concepts: Editor Configurations
- Concepts: Extra Settings
- Concepts: Iterators
- Concepts: Level/Episode Folders
- Concepts: Libraries
- Concepts: SFX List
- Features: Parallaxing Backgrounds
- Guides: Warnings
- Modules: Blockutils.lua
- Modules: Lib3d.lua
- Modules: Npcutils.lua
- Reference: BGO
- Reference: Block
- Reference: Lunatime
- Reference: NPC
- Reference: Routine
- Reference: SFX
- Reference: Timer
- Reference: Transform
Modified:
- Constants: Enemy Harm Types
- Constants: Mounts
- Features: NPC Config
- Reference: Color
- Reference: Global Memory
- Reference: Graphics
- Reference: Level (levels)
- Reference: Liquid
- Reference: Lunalua Events
- Reference: Misc
- Reference: NPC AI
- Reference: Player
- Reference: Section
- Reference: Vector

Huge thanks to Hoeloe, Sambo, MrDoubleA and rixithechao for helping.

Nobody has documented the Events class since its inclusion in SMBX2 Beta 5.
Now I have done it. https://docs.codehaus.moe/#/reference/events
Also nobody has ever USED the events class in SMBX2 Beta 5. Or reviewed it before its inclusion?
Please behold the noSmok and the controlAltRun fields.

Emral wrote: ↑

Sat Apr 12, 2025 11:40 am

Please behold the noSmok and the controlAltRun fields.

babe wake up new compatibility nightmare just dropped

Being of (at least relatively) sound mind this morning, yeah I'm going with the first one to be safe.

Made a page for upcoming functionality so that we can start documenting things in advance instead of waiting until after updates are released. https://docs.codehaus.moe/#/general/upcoming

Note that this page is currently incomplete! (For example, it doesn't specify any of the new Event class stuff I mentioned in my previous post.) I'll be adding a bit more to it in the coming days.

Okay, I think I've got everything on there now. But if I missed something, it'll be in the changelog for Patch 4's release.

@ Rixitic: Thank you for your information.

I don't know why, but I'm currently having trouble understanding the content on the link for the SMBX 2 documentation.

Therefore, I would like to kindly ask what is currently planned regarding patch 4 of SMBX 2 beta 5.