Logo

Lua for SM5: A Guide

Register Log In Back To Forums

Post #1 · Posted at 2015-11-27 05:45:27am 8.4 years ago

Offline dbk2
dbk2 Avatar Member
332 Posts
Not Set
Reg. 2012-04-30

http://i.imgur.com/Y1A19jv.png

Hi everyone,

It's been a while since I've posted here. Part of that can be explained in that I've been busy organizing an StepMania 5-based tournament (link to the Facebook event) for January 2016.

One of the things to come out of that is a pack of fairly ...interesting files. Smile Another is the Lua for SM5 Guide that I wrote for stepchart authors who wanted to incorporate Lua into their stepcharts.

At this time, I'd like to share the guide with you, the Z-i-V community. Maybe some good can come of it and some of you can become a little more comfortable with the Lua programming language and how it can be used with StepMania.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

There are a few things to note, of course:

1. As the guide itself notes, "This is not exhaustive documentation on every feature StepMania 5 offers. This is a collection of writings by one person on topics he found especially helpful or interesting."

2. The guide isn't completely done; it's still a work-in-progress. At this time, some sections aren't filled out yet (RageFileUtil and Enum are blank).

3. Strictly speaking, this is not a theming guide, it is a Lua for StepMania guide with scripted simfiles in mind. That being said, nearly all the skills it covers are directly applicable to SM5 theming. You won't find everything you need to know to make a theme here, but if you read it, you'll understanding many theming skills much better.

As I've said before, "scripted simfiles are essentially very small themes."

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

I hesitated to share this here for a while because it isn't a theming guide and, to be honest, that's what I expect most people will want. In the end, I decided to share what I have in the hope that someone can still learn something from it.

Lua For SM5: A Guide

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

I should acknowledge a few people that directly and indirectly helped with this guide!

* Kyzentun contributed code examples for the sections on Capturing Arbitrary Input and ActorMultiVertex.
* Mad Matt contributed the code examples for the section on ActorFrameTexture.
* freem/AJ 187 provided the original inspiration for helping others learn StepMania coding because he is awesome like that.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Happy coding,
-dbk2

Post #2 · Posted at 2015-11-27 02:58:05pm 8.4 years ago

Offline Engine_Machiner
Engine_Machiner Avatar Member
222 Posts
Colombia
Reg. 2014-01-16

"~The message~"
Excellent Work! Very Happy
http://66.media.tumblr.com/652d5cdeea85a39ee07a6cffb343f8a7/tumblr_mhsqmzte3S1s5307io1_100.gif https://images.duckduckgo.com/iu/?u=http%3A%2F%2Fmedia.riffsy.com%2Fimages%2F802c4321ccc6e92fb1caeddfaa52562f%2Fraw&f=1 https://images.duckduckgo.com/iu/?u=http%3A%2F%2Fauto.img.v4.skyrock.net%2F3682%2F77303682%2Fpics%2F2981513201_1_7_CclapQKR.gif&f=1

Post #3 · Posted at 2015-11-27 05:05:11pm 8.4 years ago

Offline Th3_Ov3rHell_3XoduZ
Th3_Ov3rHell_3XoduZ Avatar Member
313 Posts
Chile
Reg. 2012-09-13

"ITG, The Best Dance Machine!"
Cool, this will be very helpful not just for me, but for everyone insterested in SM5 Theming and LUA! Well done dbk2 Big Grin
Quote: Released Themes for SM5 Beta 3
Quote: Released Themes for SM5 Beta 4 & 5.0.7
Quote: Simfles Packs Released

Post #4 · Posted at 2016-05-11 10:50:32am 7.9 years ago

Offline dbk2
dbk2 Avatar Member
332 Posts
Not Set
Reg. 2012-04-30

This is just to note that I've updated this guide since the original post, five months ago.

1. I've added two new sections, Debugging and Command Chaining, under the "Best Practices" chapter.
2. Various errata and typos have been fixed.
3. I've added an actual navigation bar at the top.
4. Various issues with the layout of the site itself have been addressed. Each page should be printable and mostly work on mobile.

Check out my Lua for SM5 Guide now! http://dguzek.github.io/Lua-For-SM5/
Register Log In Back To Forums

0 User(s) Viewing This Thread (Past 15 Minutes)

©2006-2024 Zenius -I- vanisher.com -5th style- IIPrivacy Policy
Web Server: 3% · Database: 4% · Server Time: 2024-04-25 03:48:37
This page took 0.005 seconds to execute.
Theme: starlight · Language: englishuk
Reset Theme & Language