Table of Contents
I. Intro
II. Pictures
III. Downloads
IV. Developing
IV-a. Reference
V. Included Mods
VI. Core File Changes
VII. Installation Instructions
I. Intro
I've been following the development of Mari0 since it was just an attempt to make a Super Mario Brothers clone. After it was released, I decided that with my vast knowledge of Lua and Love, I would make an easy way to create mods. And thus, Mari0 Modding System was born.
Here's picture of a mod I made, it adds a few logic gates for more complex puzzles.
II. Pictures
HAVE SOME PRETTY PICTURES
III. Downloads
This is currently on Mari0 1.6, Modding System 1.6.2
The Mari0 Modding System 1.6.2 can be downloaded here: MarioMS_1.6.2.zip
If something's not working, try getting the latest version.
Older Versions
1.6.1
1.4.1
1.3
IV. Developing Mods
Creating mods is relatively easy.
Every mod folder needs to contain a modmain.lua. In this file I recommend you load images and other things. The main purpose is that this is where you call RegisterObject. Doing this creates a new type of entity like the player, bullet bills, goombas, etc. This does everything you would usually need to do when creating a mod, like creating a new table in objects, adding the name to entitylist, and everything else.
As for editing the entities.png in graphics/SMB, that's no longer necessary. Instead, you just create a new entities.png inside of your mod's graphics folder. (This is where you put other graphics, as well.)
The image in the entities.png is not your entity's graphics, it's where it gets the images for the entity picker. Each 17x17 tile should be in the order of when you call RegisterObject for each new type of object.
IV-a. Reference
The functions that you can use (in addition to all the basic ones)
try(function [, errorfunction]) - Runs a function safely, if supplied it will fun errorfunction and pass it the error message
requiredir(directory [, excluded]) - requires all files in a directory in alphabetical order
LoadMods() - Loads all mods, an internal function which you don't need to call.
NewObject(entname, ent) - adds an entity to objects
GetModIndex(entname) - what index the entity's info is stored at
RegisterObject(djghgaklsdhfhdash) - Registers a new type of object, the most important function which I can't fully document right now
and much much more, coming later
V. Included Mods
Logic Gates
Personality Cores
Poison Mushrooms
"Zealous" Plates (2x as powerful as faithplates, FEEL THE FEVER) (also they launch more things for the moment)
A non-working new type of koopa
OTHER STUFF I DON'T FEEL LIKE TYPING UP
VI. Core File Changes
Multiple input links (be careful with this)
Loading Mods (duh)
Drawing mod entities (i.e. you don't have to make your own loop)
Mario Collision callbacks
Some improved/more dynamic physics
-ENTITY.pushable, can it be pushed by Mario? (like boxes and personality cores)
-ENTITY.pushesbutton, if this is true, entities trigger super colliding super buttons
OTHER STUFF I DON'T FEEL LIKE TYPING UP
VII. Installation Instructions
There are two separate pieces to this, the executable (Mari0MS_x.y.z.love) and the mods (folders full of lua files and images).
To play with mods, run the executable by either double clicking on it, or dragging it onto love.exe/a shortcut to love.exe. You need to install Love 0.8.0, which can be download from love2d.org (you don't to get it from love2d.org/builds because 0.8.0 has been released officially)
If you try to play a different version of Mari0 (e.g. the standard one from stabyourself.net), no mods will be loaded from your mods folder. The mods folder is only used by my modded version, so unless you are using a different modloader that uses the same "mods" folder, nothing will happen just from having it there.
To install a mod, you simply drop its folder into your appdata/love/mari0/mods folder, right next to mappacks. There's 99% chance it's not there already, so you'll probably have to make it.
A PICTURE TO MAKE IT EASIER:
