SMBX2 Documentation

Share guides you have written for SMBX, and related tools here.
Enjl
Cute Yoshi Egg
Cute Yoshi Egg
Posts: 8735
Joined: Mon Jan 20, 2014 12:58 pm
Flair: Orphion Egamalenitar Osmos IV, Esq.

SMBX2 Documentation

Postby Enjl » Wed Aug 26, 2020 4:52 pm

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
Ideas are useless if you can't make them real.
Image

User avatar
Taycamgame
Gold Yoshi Egg
Gold Yoshi Egg
Posts: 1392
Joined: Mon Jun 19, 2017 11:35 am
Flair: Stargard
Current Project: Mario's Kingdom Adventure
Chat Username: Taycamgame
Contact:

Re: SMBX2 Documentation

Postby Taycamgame » Thu Aug 27, 2020 4:18 pm

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

Very useful, I recommend you guys check it out!
Official Level Reviewer (My Gold Yoshi Egg rank replaced the level reviewer icon, but i am still a level reviewer).
Image
Image
Image
Image
Check out the World Map Service that i host:
viewtopic.php?p=316733#p316733
Check out the projects i support:
Spoiler: show
ImageImage
Image
Image
Quotes: show
xDestroy wrote:
Wellington Games wrote:Taycamgame, I know how to take screenshots in the SMBX.
https://nsmbx.proboards.com/
------
Tower Mario Bros.

Enjl
Cute Yoshi Egg
Cute Yoshi Egg
Posts: 8735
Joined: Mon Jan 20, 2014 12:58 pm
Flair: Orphion Egamalenitar Osmos IV, Esq.

Re: SMBX2 Documentation

Postby Enjl » Sun Aug 30, 2020 5:43 am

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!
Ideas are useless if you can't make them real.
Image

Enjl
Cute Yoshi Egg
Cute Yoshi Egg
Posts: 8735
Joined: Mon Jan 20, 2014 12:58 pm
Flair: Orphion Egamalenitar Osmos IV, Esq.

Re: SMBX2 Documentation

Postby Enjl » Sun Sep 06, 2020 2:32 pm

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!
Ideas are useless if you can't make them real.
Image

koob_koob
Cheep-Cheep
Cheep-Cheep
Posts: 14
Joined: Thu Aug 06, 2020 4:28 am

Re: SMBX2 Documentation

Postby koob_koob » Fri Sep 11, 2020 7:08 pm

its saying that its suspended when i try to open it

Enjl
Cute Yoshi Egg
Cute Yoshi Egg
Posts: 8735
Joined: Mon Jan 20, 2014 12:58 pm
Flair: Orphion Egamalenitar Osmos IV, Esq.

Re: SMBX2 Documentation

Postby Enjl » Sun Sep 13, 2020 10:59 am

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]
Ideas are useless if you can't make them real.
Image

User avatar
MECHDRAGON777
Pink Yoshi Egg
Pink Yoshi Egg
Posts: 6304
Joined: Fri Dec 20, 2013 6:40 pm
Flair: Nuclear Queen of Reversion.
Current Project: http://www.supermariobrosx.org/forums/v ... 9&start=10
Chat Username: 鬼人 正邪
Contact:

Re: SMBX2 Documentation

Postby MECHDRAGON777 » Fri Sep 18, 2020 2:53 am

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

ImageImageImage
Image

Image

Enjl
Cute Yoshi Egg
Cute Yoshi Egg
Posts: 8735
Joined: Mon Jan 20, 2014 12:58 pm
Flair: Orphion Egamalenitar Osmos IV, Esq.

Re: SMBX2 Documentation

Postby Enjl » Sun Sep 20, 2020 7:20 am

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!
Ideas are useless if you can't make them real.
Image


Return to “Guides”

Who is online

Users browsing this forum: No registered users and 1 guest