Enhanced Lua environment for PlayStation 2™

Table of Contents

1. About Enceladus
   • Function types
   • Built With
2. Coding
   • Prerequisites
   • Features
3. Contributing
4. License
5. Contact
6. Thanks

About Enceladus

Enceladus is a project that seeks to facilitate and at the same time brings a complete kit for users to create homebrew software for PlayStation 2 using the Lua language. It has dozens of built-in functions, both for creating games and apps. The main advantage over using Enceladus project instead of the pure PS2SDK is above all the practicality, you will use one of the simplest possible languages to create what you have in mind, besides not having to compile, just script and test, fast and simple.

Function types:

• System: Everything that involves files, folders and system stuff.
• Graphics: You can control the entire 2D part of your project, that is, draw images, shapes, lines, change their properties, etc.
• Render: 3D! Basic support for rendering a 3D environment in your project.
• Screen: The entire screen of your project (2D and 3D), being able to change the resolution, enable or disable parameters.
• Font: Functions that control the texts that appear on the screen, loading texts, drawing and unloading from memory.
• Pads: Above being able to draw and everything else, A human interface is important. Supports rumble and pressure sensitivity.
• Timer: Control the time precisely in your code, it contains several timing functions.
• Sound: Basic sound functions.

New types are always being added and this list can grow a lot over time, so stay tuned.

Built With

• PS2DEV
• Lua

Coding

In this section you will have some information about how to code using Enceladus, from prerequisites to useful functions and information about the language.

Prerequisites

Using Enceladus you only need one way to code and one way to test your code, that is, if you want, you can even create your code on PS2, but I’ll leave some recommendations below.

• PC: Visual Studio Code(with Lua extension) and PCSX2(1.7.0 or above) or PS2Client for test.
• Android: QuickEdit and a PS2 with uLE for test.

Oh, and I also have to mention that an essential prerequisite for using Enceladus is knowing how to code in Lua.

Features

Enceladus uses the latest version of Lua language (currently 5.4.3), which means that it brings all language’s available resources so far. Below is the list of usable functions of Enceladus project currently, this list is constantly being updated.

Graphics functions:

• Graphics.drawPixel(x, y, color)
• Graphics.drawRect(x, y, width, height, color)
• Graphics.drawLine(x, y, x2, y2, color)
• Graphics.drawCircle(x, y, radius, color, filled) *filled isn’t mandatory
• Graphics.drawTriangle(x, y, x2, y2, x3, y3, color, color2, color3) *color2 and color3 are not mandatory
• Graphics.drawQuad(x, y, x2, y2, x3, y3, x4, y4 color, color2, color3, color4) *color2, color3 and color4 are not mandatory
• image = Graphics.loadImage(path) *Supports BMP, JPG and PNG
• Graphics.drawImage(image, x, y, alpha, width, height)
• Graphics.setImageFilters(image, filter) *Choose between NEAREST and LINEAR filters
• width = Graphics.getImageWidth(image)
• height = Graphics.getImageHeight(image)
• Graphics.freeImage(image)

Screen functions:

• Screen.clear()
• Screen.flip()
• Screen.waitVblankStart()
• Screen.showSplash()
• Screen.setMode()

Font functions:

• Font.ftInit()
• font = Font.ftLoad(“font.ttf”)
• font = Font.load(“font.fnt/png/bmp”)
• Font.fmLoad()
• Font.fmPrint(x, y, scale, text, color) *color isn’t mandatory
• Font.fmUnload

Pads functions:

• pad = Pads.get()
• Pads.getLeftStick()
• Pads.getRightStick()
• Pads.getPressure(pad, button)
• Pads.rumble(big, small)
• Pads.check(button)

System functions:

• fd = System.openFile(path, type)
• buffer = System.readFile(file, size)
• System.writeFile(fd, data, size)
• System.closeFile(fd)
• System.seekFile(fd, pos, type)
• size = System.sizeFile(fd)
• System.doesFileExist(path)
• System.CurrentDirectory(path) *if path given, it sets the current dir, else it gets the current dir
• System.listDirectory(path) *path isn’t mandatory
• System.createDirectory(path)
• System.removeDirectory(path)
• System.removeFile(path)
• System.copyFile(source, dest)
• System.move(source, dest)
• System.rename(source, dest)
• System.md5sum(string)
• System.sleep(sec)
• System.getFreeMemory()
• System.getFreeVRAM()
• fps = System.getFPS(prev, cur)
• System.exitToBrowser()
• type, freespace, format = System.getMCInfo(slot)

Timer functions:

• timer = Timer.new()
• Timer.getTime(timer)
• Timer.setTime(src, value)
• Timer.destroy(timer)
• Timer.pause(timer)
• Timer.resume(timer)
• Timer.reset(timer)
• Timer.isPlaying(timer)

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AwesomeFeature)
3. Commit your Changes (git commit -m 'Add some AwesomeFeature')
4. Push to the Branch (git push origin feature/AwesomeFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Daniel Santos - @danadsees - danielsantos346@gmail.com

Project Link: https://github.com/DanielSant0s/Enceladus

Thanks

Here are some direct and indirect thanks to the people who made the project viable!

• HowlingWolf&Chelsea - Tests, tips and many other things
• fjtrujy - Help on porting current Lua language versions and general code help
• Rinnegatamante - Having created lpp, which served as a great initial guide
• Whole PS2DEV team